Interface PartnerCentralChannelAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
AWS Partner Central Channel service for managing partner relationships, handshakes, and program management accounts.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionacceptChannelHandshake(Consumer<AcceptChannelHandshakeRequest.Builder> acceptChannelHandshakeRequest) Accepts a pending channel handshake request from another AWS account.acceptChannelHandshake(AcceptChannelHandshakeRequest acceptChannelHandshakeRequest) Accepts a pending channel handshake request from another AWS account.builder()Create a builder that can be used to configure and create aPartnerCentralChannelAsyncClient.cancelChannelHandshake(Consumer<CancelChannelHandshakeRequest.Builder> cancelChannelHandshakeRequest) Cancels a pending channel handshake request.cancelChannelHandshake(CancelChannelHandshakeRequest cancelChannelHandshakeRequest) Cancels a pending channel handshake request.create()Create aPartnerCentralChannelAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createChannelHandshake(Consumer<CreateChannelHandshakeRequest.Builder> createChannelHandshakeRequest) Creates a new channel handshake request to establish a partnership with another AWS account.createChannelHandshake(CreateChannelHandshakeRequest createChannelHandshakeRequest) Creates a new channel handshake request to establish a partnership with another AWS account.createProgramManagementAccount(Consumer<CreateProgramManagementAccountRequest.Builder> createProgramManagementAccountRequest) Creates a new program management account for managing partner relationships.createProgramManagementAccount(CreateProgramManagementAccountRequest createProgramManagementAccountRequest) Creates a new program management account for managing partner relationships.createRelationship(Consumer<CreateRelationshipRequest.Builder> createRelationshipRequest) Creates a new partner relationship between accounts.createRelationship(CreateRelationshipRequest createRelationshipRequest) Creates a new partner relationship between accounts.deleteProgramManagementAccount(Consumer<DeleteProgramManagementAccountRequest.Builder> deleteProgramManagementAccountRequest) Deletes a program management account.deleteProgramManagementAccount(DeleteProgramManagementAccountRequest deleteProgramManagementAccountRequest) Deletes a program management account.deleteRelationship(Consumer<DeleteRelationshipRequest.Builder> deleteRelationshipRequest) Deletes a partner relationship.deleteRelationship(DeleteRelationshipRequest deleteRelationshipRequest) Deletes a partner relationship.default CompletableFuture<GetRelationshipResponse> getRelationship(Consumer<GetRelationshipRequest.Builder> getRelationshipRequest) Retrieves details of a specific partner relationship.default CompletableFuture<GetRelationshipResponse> getRelationship(GetRelationshipRequest getRelationshipRequest) Retrieves details of a specific partner relationship.listChannelHandshakes(Consumer<ListChannelHandshakesRequest.Builder> listChannelHandshakesRequest) Lists channel handshakes based on specified criteria.listChannelHandshakes(ListChannelHandshakesRequest listChannelHandshakesRequest) Lists channel handshakes based on specified criteria.default ListChannelHandshakesPublisherlistChannelHandshakesPaginator(Consumer<ListChannelHandshakesRequest.Builder> listChannelHandshakesRequest) This is a variant oflistChannelHandshakes(software.amazon.awssdk.services.partnercentralchannel.model.ListChannelHandshakesRequest)operation.default ListChannelHandshakesPublisherlistChannelHandshakesPaginator(ListChannelHandshakesRequest listChannelHandshakesRequest) This is a variant oflistChannelHandshakes(software.amazon.awssdk.services.partnercentralchannel.model.ListChannelHandshakesRequest)operation.listProgramManagementAccounts(Consumer<ListProgramManagementAccountsRequest.Builder> listProgramManagementAccountsRequest) Lists program management accounts based on specified criteria.listProgramManagementAccounts(ListProgramManagementAccountsRequest listProgramManagementAccountsRequest) Lists program management accounts based on specified criteria.listProgramManagementAccountsPaginator(Consumer<ListProgramManagementAccountsRequest.Builder> listProgramManagementAccountsRequest) This is a variant oflistProgramManagementAccounts(software.amazon.awssdk.services.partnercentralchannel.model.ListProgramManagementAccountsRequest)operation.listProgramManagementAccountsPaginator(ListProgramManagementAccountsRequest listProgramManagementAccountsRequest) This is a variant oflistProgramManagementAccounts(software.amazon.awssdk.services.partnercentralchannel.model.ListProgramManagementAccountsRequest)operation.listRelationships(Consumer<ListRelationshipsRequest.Builder> listRelationshipsRequest) Lists partner relationships based on specified criteria.listRelationships(ListRelationshipsRequest listRelationshipsRequest) Lists partner relationships based on specified criteria.default ListRelationshipsPublisherlistRelationshipsPaginator(Consumer<ListRelationshipsRequest.Builder> listRelationshipsRequest) This is a variant oflistRelationships(software.amazon.awssdk.services.partnercentralchannel.model.ListRelationshipsRequest)operation.default ListRelationshipsPublisherlistRelationshipsPaginator(ListRelationshipsRequest listRelationshipsRequest) This is a variant oflistRelationships(software.amazon.awssdk.services.partnercentralchannel.model.ListRelationshipsRequest)operation.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists tags associated with a specific resource.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists tags associated with a specific resource.rejectChannelHandshake(Consumer<RejectChannelHandshakeRequest.Builder> rejectChannelHandshakeRequest) Rejects a pending channel handshake request.rejectChannelHandshake(RejectChannelHandshakeRequest rejectChannelHandshakeRequest) Rejects a pending channel handshake request.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or updates tags for a specified resource.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Adds or updates tags for a specified resource.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from a specified resource.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes tags from a specified resource.updateProgramManagementAccount(Consumer<UpdateProgramManagementAccountRequest.Builder> updateProgramManagementAccountRequest) Updates the properties of a program management account.updateProgramManagementAccount(UpdateProgramManagementAccountRequest updateProgramManagementAccountRequest) Updates the properties of a program management account.updateRelationship(Consumer<UpdateRelationshipRequest.Builder> updateRelationshipRequest) Updates the properties of a partner relationship.updateRelationship(UpdateRelationshipRequest updateRelationshipRequest) Updates the properties of a partner relationship.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
acceptChannelHandshake
default CompletableFuture<AcceptChannelHandshakeResponse> acceptChannelHandshake(AcceptChannelHandshakeRequest acceptChannelHandshakeRequest) Accepts a pending channel handshake request from another AWS account.
- Parameters:
acceptChannelHandshakeRequest-- Returns:
- A Java Future containing the result of the AcceptChannelHandshake operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
acceptChannelHandshake
default CompletableFuture<AcceptChannelHandshakeResponse> acceptChannelHandshake(Consumer<AcceptChannelHandshakeRequest.Builder> acceptChannelHandshakeRequest) Accepts a pending channel handshake request from another AWS account.
This is a convenience which creates an instance of the
AcceptChannelHandshakeRequest.Builderavoiding the need to create one manually viaAcceptChannelHandshakeRequest.builder()- Parameters:
acceptChannelHandshakeRequest- AConsumerthat will call methods onAcceptChannelHandshakeRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the AcceptChannelHandshake operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelChannelHandshake
default CompletableFuture<CancelChannelHandshakeResponse> cancelChannelHandshake(CancelChannelHandshakeRequest cancelChannelHandshakeRequest) Cancels a pending channel handshake request.
- Parameters:
cancelChannelHandshakeRequest-- Returns:
- A Java Future containing the result of the CancelChannelHandshake operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelChannelHandshake
default CompletableFuture<CancelChannelHandshakeResponse> cancelChannelHandshake(Consumer<CancelChannelHandshakeRequest.Builder> cancelChannelHandshakeRequest) Cancels a pending channel handshake request.
This is a convenience which creates an instance of the
CancelChannelHandshakeRequest.Builderavoiding the need to create one manually viaCancelChannelHandshakeRequest.builder()- Parameters:
cancelChannelHandshakeRequest- AConsumerthat will call methods onCancelChannelHandshakeRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CancelChannelHandshake operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createChannelHandshake
default CompletableFuture<CreateChannelHandshakeResponse> createChannelHandshake(CreateChannelHandshakeRequest createChannelHandshakeRequest) Creates a new channel handshake request to establish a partnership with another AWS account.
- Parameters:
createChannelHandshakeRequest-- Returns:
- A Java Future containing the result of the CreateChannelHandshake operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- ConflictException The request could not be completed due to a conflict with the current state of the resource.
- ServiceQuotaExceededException The request would exceed a service quota limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createChannelHandshake
default CompletableFuture<CreateChannelHandshakeResponse> createChannelHandshake(Consumer<CreateChannelHandshakeRequest.Builder> createChannelHandshakeRequest) Creates a new channel handshake request to establish a partnership with another AWS account.
This is a convenience which creates an instance of the
CreateChannelHandshakeRequest.Builderavoiding the need to create one manually viaCreateChannelHandshakeRequest.builder()- Parameters:
createChannelHandshakeRequest- AConsumerthat will call methods onCreateChannelHandshakeRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateChannelHandshake operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- ConflictException The request could not be completed due to a conflict with the current state of the resource.
- ServiceQuotaExceededException The request would exceed a service quota limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProgramManagementAccount
default CompletableFuture<CreateProgramManagementAccountResponse> createProgramManagementAccount(CreateProgramManagementAccountRequest createProgramManagementAccountRequest) Creates a new program management account for managing partner relationships.
- Parameters:
createProgramManagementAccountRequest-- Returns:
- A Java Future containing the result of the CreateProgramManagementAccount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- ConflictException The request could not be completed due to a conflict with the current state of the resource.
- ServiceQuotaExceededException The request would exceed a service quota limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProgramManagementAccount
default CompletableFuture<CreateProgramManagementAccountResponse> createProgramManagementAccount(Consumer<CreateProgramManagementAccountRequest.Builder> createProgramManagementAccountRequest) Creates a new program management account for managing partner relationships.
This is a convenience which creates an instance of the
CreateProgramManagementAccountRequest.Builderavoiding the need to create one manually viaCreateProgramManagementAccountRequest.builder()- Parameters:
createProgramManagementAccountRequest- AConsumerthat will call methods onCreateProgramManagementAccountRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateProgramManagementAccount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- ConflictException The request could not be completed due to a conflict with the current state of the resource.
- ServiceQuotaExceededException The request would exceed a service quota limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRelationship
default CompletableFuture<CreateRelationshipResponse> createRelationship(CreateRelationshipRequest createRelationshipRequest) Creates a new partner relationship between accounts.
- Parameters:
createRelationshipRequest-- Returns:
- A Java Future containing the result of the CreateRelationship operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- ConflictException The request could not be completed due to a conflict with the current state of the resource.
- ServiceQuotaExceededException The request would exceed a service quota limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRelationship
default CompletableFuture<CreateRelationshipResponse> createRelationship(Consumer<CreateRelationshipRequest.Builder> createRelationshipRequest) Creates a new partner relationship between accounts.
This is a convenience which creates an instance of the
CreateRelationshipRequest.Builderavoiding the need to create one manually viaCreateRelationshipRequest.builder()- Parameters:
createRelationshipRequest- AConsumerthat will call methods onCreateRelationshipRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateRelationship operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- ConflictException The request could not be completed due to a conflict with the current state of the resource.
- ServiceQuotaExceededException The request would exceed a service quota limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProgramManagementAccount
default CompletableFuture<DeleteProgramManagementAccountResponse> deleteProgramManagementAccount(DeleteProgramManagementAccountRequest deleteProgramManagementAccountRequest) Deletes a program management account.
- Parameters:
deleteProgramManagementAccountRequest-- Returns:
- A Java Future containing the result of the DeleteProgramManagementAccount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- ConflictException The request could not be completed due to a conflict with the current state of the resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProgramManagementAccount
default CompletableFuture<DeleteProgramManagementAccountResponse> deleteProgramManagementAccount(Consumer<DeleteProgramManagementAccountRequest.Builder> deleteProgramManagementAccountRequest) Deletes a program management account.
This is a convenience which creates an instance of the
DeleteProgramManagementAccountRequest.Builderavoiding the need to create one manually viaDeleteProgramManagementAccountRequest.builder()- Parameters:
deleteProgramManagementAccountRequest- AConsumerthat will call methods onDeleteProgramManagementAccountRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteProgramManagementAccount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- ConflictException The request could not be completed due to a conflict with the current state of the resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRelationship
default CompletableFuture<DeleteRelationshipResponse> deleteRelationship(DeleteRelationshipRequest deleteRelationshipRequest) Deletes a partner relationship.
- Parameters:
deleteRelationshipRequest-- Returns:
- A Java Future containing the result of the DeleteRelationship operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- ConflictException The request could not be completed due to a conflict with the current state of the resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRelationship
default CompletableFuture<DeleteRelationshipResponse> deleteRelationship(Consumer<DeleteRelationshipRequest.Builder> deleteRelationshipRequest) Deletes a partner relationship.
This is a convenience which creates an instance of the
DeleteRelationshipRequest.Builderavoiding the need to create one manually viaDeleteRelationshipRequest.builder()- Parameters:
deleteRelationshipRequest- AConsumerthat will call methods onDeleteRelationshipRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteRelationship operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- ConflictException The request could not be completed due to a conflict with the current state of the resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRelationship
default CompletableFuture<GetRelationshipResponse> getRelationship(GetRelationshipRequest getRelationshipRequest) Retrieves details of a specific partner relationship.
- Parameters:
getRelationshipRequest-- Returns:
- A Java Future containing the result of the GetRelationship operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRelationship
default CompletableFuture<GetRelationshipResponse> getRelationship(Consumer<GetRelationshipRequest.Builder> getRelationshipRequest) Retrieves details of a specific partner relationship.
This is a convenience which creates an instance of the
GetRelationshipRequest.Builderavoiding the need to create one manually viaGetRelationshipRequest.builder()- Parameters:
getRelationshipRequest- AConsumerthat will call methods onGetRelationshipRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetRelationship operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelHandshakes
default CompletableFuture<ListChannelHandshakesResponse> listChannelHandshakes(ListChannelHandshakesRequest listChannelHandshakesRequest) Lists channel handshakes based on specified criteria.
- Parameters:
listChannelHandshakesRequest-- Returns:
- A Java Future containing the result of the ListChannelHandshakes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelHandshakes
default CompletableFuture<ListChannelHandshakesResponse> listChannelHandshakes(Consumer<ListChannelHandshakesRequest.Builder> listChannelHandshakesRequest) Lists channel handshakes based on specified criteria.
This is a convenience which creates an instance of the
ListChannelHandshakesRequest.Builderavoiding the need to create one manually viaListChannelHandshakesRequest.builder()- Parameters:
listChannelHandshakesRequest- AConsumerthat will call methods onListChannelHandshakesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListChannelHandshakes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelHandshakesPaginator
default ListChannelHandshakesPublisher listChannelHandshakesPaginator(ListChannelHandshakesRequest listChannelHandshakesRequest) This is a variant of
listChannelHandshakes(software.amazon.awssdk.services.partnercentralchannel.model.ListChannelHandshakesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.partnercentralchannel.paginators.ListChannelHandshakesPublisher publisher = client.listChannelHandshakesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.partnercentralchannel.paginators.ListChannelHandshakesPublisher publisher = client.listChannelHandshakesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.partnercentralchannel.model.ListChannelHandshakesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.partnercentralchannel.model.ListChannelHandshakesResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelHandshakes(software.amazon.awssdk.services.partnercentralchannel.model.ListChannelHandshakesRequest)operation.- Parameters:
listChannelHandshakesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChannelHandshakesPaginator
default ListChannelHandshakesPublisher listChannelHandshakesPaginator(Consumer<ListChannelHandshakesRequest.Builder> listChannelHandshakesRequest) This is a variant of
listChannelHandshakes(software.amazon.awssdk.services.partnercentralchannel.model.ListChannelHandshakesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.partnercentralchannel.paginators.ListChannelHandshakesPublisher publisher = client.listChannelHandshakesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.partnercentralchannel.paginators.ListChannelHandshakesPublisher publisher = client.listChannelHandshakesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.partnercentralchannel.model.ListChannelHandshakesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.partnercentralchannel.model.ListChannelHandshakesResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChannelHandshakes(software.amazon.awssdk.services.partnercentralchannel.model.ListChannelHandshakesRequest)operation.
This is a convenience which creates an instance of the
ListChannelHandshakesRequest.Builderavoiding the need to create one manually viaListChannelHandshakesRequest.builder()- Parameters:
listChannelHandshakesRequest- AConsumerthat will call methods onListChannelHandshakesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProgramManagementAccounts
default CompletableFuture<ListProgramManagementAccountsResponse> listProgramManagementAccounts(ListProgramManagementAccountsRequest listProgramManagementAccountsRequest) Lists program management accounts based on specified criteria.
- Parameters:
listProgramManagementAccountsRequest-- Returns:
- A Java Future containing the result of the ListProgramManagementAccounts operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProgramManagementAccounts
default CompletableFuture<ListProgramManagementAccountsResponse> listProgramManagementAccounts(Consumer<ListProgramManagementAccountsRequest.Builder> listProgramManagementAccountsRequest) Lists program management accounts based on specified criteria.
This is a convenience which creates an instance of the
ListProgramManagementAccountsRequest.Builderavoiding the need to create one manually viaListProgramManagementAccountsRequest.builder()- Parameters:
listProgramManagementAccountsRequest- AConsumerthat will call methods onListProgramManagementAccountsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListProgramManagementAccounts operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProgramManagementAccountsPaginator
default ListProgramManagementAccountsPublisher listProgramManagementAccountsPaginator(ListProgramManagementAccountsRequest listProgramManagementAccountsRequest) This is a variant of
listProgramManagementAccounts(software.amazon.awssdk.services.partnercentralchannel.model.ListProgramManagementAccountsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.partnercentralchannel.paginators.ListProgramManagementAccountsPublisher publisher = client.listProgramManagementAccountsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.partnercentralchannel.paginators.ListProgramManagementAccountsPublisher publisher = client.listProgramManagementAccountsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.partnercentralchannel.model.ListProgramManagementAccountsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.partnercentralchannel.model.ListProgramManagementAccountsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProgramManagementAccounts(software.amazon.awssdk.services.partnercentralchannel.model.ListProgramManagementAccountsRequest)operation.- Parameters:
listProgramManagementAccountsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProgramManagementAccountsPaginator
default ListProgramManagementAccountsPublisher listProgramManagementAccountsPaginator(Consumer<ListProgramManagementAccountsRequest.Builder> listProgramManagementAccountsRequest) This is a variant of
listProgramManagementAccounts(software.amazon.awssdk.services.partnercentralchannel.model.ListProgramManagementAccountsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.partnercentralchannel.paginators.ListProgramManagementAccountsPublisher publisher = client.listProgramManagementAccountsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.partnercentralchannel.paginators.ListProgramManagementAccountsPublisher publisher = client.listProgramManagementAccountsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.partnercentralchannel.model.ListProgramManagementAccountsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.partnercentralchannel.model.ListProgramManagementAccountsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProgramManagementAccounts(software.amazon.awssdk.services.partnercentralchannel.model.ListProgramManagementAccountsRequest)operation.
This is a convenience which creates an instance of the
ListProgramManagementAccountsRequest.Builderavoiding the need to create one manually viaListProgramManagementAccountsRequest.builder()- Parameters:
listProgramManagementAccountsRequest- AConsumerthat will call methods onListProgramManagementAccountsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRelationships
default CompletableFuture<ListRelationshipsResponse> listRelationships(ListRelationshipsRequest listRelationshipsRequest) Lists partner relationships based on specified criteria.
- Parameters:
listRelationshipsRequest-- Returns:
- A Java Future containing the result of the ListRelationships operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRelationships
default CompletableFuture<ListRelationshipsResponse> listRelationships(Consumer<ListRelationshipsRequest.Builder> listRelationshipsRequest) Lists partner relationships based on specified criteria.
This is a convenience which creates an instance of the
ListRelationshipsRequest.Builderavoiding the need to create one manually viaListRelationshipsRequest.builder()- Parameters:
listRelationshipsRequest- AConsumerthat will call methods onListRelationshipsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListRelationships operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRelationshipsPaginator
default ListRelationshipsPublisher listRelationshipsPaginator(ListRelationshipsRequest listRelationshipsRequest) This is a variant of
listRelationships(software.amazon.awssdk.services.partnercentralchannel.model.ListRelationshipsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.partnercentralchannel.paginators.ListRelationshipsPublisher publisher = client.listRelationshipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.partnercentralchannel.paginators.ListRelationshipsPublisher publisher = client.listRelationshipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.partnercentralchannel.model.ListRelationshipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.partnercentralchannel.model.ListRelationshipsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRelationships(software.amazon.awssdk.services.partnercentralchannel.model.ListRelationshipsRequest)operation.- Parameters:
listRelationshipsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRelationshipsPaginator
default ListRelationshipsPublisher listRelationshipsPaginator(Consumer<ListRelationshipsRequest.Builder> listRelationshipsRequest) This is a variant of
listRelationships(software.amazon.awssdk.services.partnercentralchannel.model.ListRelationshipsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.partnercentralchannel.paginators.ListRelationshipsPublisher publisher = client.listRelationshipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.partnercentralchannel.paginators.ListRelationshipsPublisher publisher = client.listRelationshipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.partnercentralchannel.model.ListRelationshipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.partnercentralchannel.model.ListRelationshipsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRelationships(software.amazon.awssdk.services.partnercentralchannel.model.ListRelationshipsRequest)operation.
This is a convenience which creates an instance of the
ListRelationshipsRequest.Builderavoiding the need to create one manually viaListRelationshipsRequest.builder()- Parameters:
listRelationshipsRequest- AConsumerthat will call methods onListRelationshipsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists tags associated with a specific resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists tags associated with a specific resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
rejectChannelHandshake
default CompletableFuture<RejectChannelHandshakeResponse> rejectChannelHandshake(RejectChannelHandshakeRequest rejectChannelHandshakeRequest) Rejects a pending channel handshake request.
- Parameters:
rejectChannelHandshakeRequest-- Returns:
- A Java Future containing the result of the RejectChannelHandshake operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
rejectChannelHandshake
default CompletableFuture<RejectChannelHandshakeResponse> rejectChannelHandshake(Consumer<RejectChannelHandshakeRequest.Builder> rejectChannelHandshakeRequest) Rejects a pending channel handshake request.
This is a convenience which creates an instance of the
RejectChannelHandshakeRequest.Builderavoiding the need to create one manually viaRejectChannelHandshakeRequest.builder()- Parameters:
rejectChannelHandshakeRequest- AConsumerthat will call methods onRejectChannelHandshakeRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the RejectChannelHandshake operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Adds or updates tags for a specified resource.
- Parameters:
tagResourceRequest-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- ConflictException The request could not be completed due to a conflict with the current state of the resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or updates tags for a specified resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- ConflictException The request could not be completed due to a conflict with the current state of the resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes tags from a specified resource.
- Parameters:
untagResourceRequest-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- ConflictException The request could not be completed due to a conflict with the current state of the resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from a specified resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- ConflictException The request could not be completed due to a conflict with the current state of the resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProgramManagementAccount
default CompletableFuture<UpdateProgramManagementAccountResponse> updateProgramManagementAccount(UpdateProgramManagementAccountRequest updateProgramManagementAccountRequest) Updates the properties of a program management account.
- Parameters:
updateProgramManagementAccountRequest-- Returns:
- A Java Future containing the result of the UpdateProgramManagementAccount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- ConflictException The request could not be completed due to a conflict with the current state of the resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProgramManagementAccount
default CompletableFuture<UpdateProgramManagementAccountResponse> updateProgramManagementAccount(Consumer<UpdateProgramManagementAccountRequest.Builder> updateProgramManagementAccountRequest) Updates the properties of a program management account.
This is a convenience which creates an instance of the
UpdateProgramManagementAccountRequest.Builderavoiding the need to create one manually viaUpdateProgramManagementAccountRequest.builder()- Parameters:
updateProgramManagementAccountRequest- AConsumerthat will call methods onUpdateProgramManagementAccountRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateProgramManagementAccount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- ConflictException The request could not be completed due to a conflict with the current state of the resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRelationship
default CompletableFuture<UpdateRelationshipResponse> updateRelationship(UpdateRelationshipRequest updateRelationshipRequest) Updates the properties of a partner relationship.
- Parameters:
updateRelationshipRequest-- Returns:
- A Java Future containing the result of the UpdateRelationship operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- ConflictException The request could not be completed due to a conflict with the current state of the resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRelationship
default CompletableFuture<UpdateRelationshipResponse> updateRelationship(Consumer<UpdateRelationshipRequest.Builder> updateRelationshipRequest) Updates the properties of a partner relationship.
This is a convenience which creates an instance of the
UpdateRelationshipRequest.Builderavoiding the need to create one manually viaUpdateRelationshipRequest.builder()- Parameters:
updateRelationshipRequest- AConsumerthat will call methods onUpdateRelationshipRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateRelationship operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource was not found.
- InternalServerException An internal server error occurred while processing the request.
- ValidationException The request failed validation due to invalid input parameters.
- ThrottlingException The request was throttled due to too many requests being sent in a short period.
- AccessDeniedException The request was denied due to insufficient permissions.
- ConflictException The request could not be completed due to a conflict with the current state of the resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralChannelException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aPartnerCentralChannelAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aPartnerCentralChannelAsyncClient.
-