Interface B2BiAsyncClient
- 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.
This is the Amazon Web Services B2B Data Interchange API Reference. It provides descriptions, API request parameters, and the XML response for each of the B2BI API actions.
B2BI enables automated exchange of EDI (electronic data interchange) based business-critical transactions at cloud scale, with elasticity and pay-as-you-go pricing. Businesses use EDI documents to exchange transactional data with trading partners, such as suppliers and end customers, using standardized formats such as X12.
Rather than actually running a command, you can use the --generate-cli-skeleton
parameter with any API
call to generate and display a parameter template. You can then use the generated template to customize and use as
input on a later command. For details, see Generate
and use a parameter skeleton file.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic B2BiAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aB2BiAsyncClient
.static B2BiAsyncClient
create()
Create aB2BiAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createCapability
(Consumer<CreateCapabilityRequest.Builder> createCapabilityRequest) Instantiates a capability based on the specified parameters.createCapability
(CreateCapabilityRequest createCapabilityRequest) Instantiates a capability based on the specified parameters.createPartnership
(Consumer<CreatePartnershipRequest.Builder> createPartnershipRequest) Creates a partnership between a customer and a trading partner, based on the supplied parameters.createPartnership
(CreatePartnershipRequest createPartnershipRequest) Creates a partnership between a customer and a trading partner, based on the supplied parameters.default CompletableFuture
<CreateProfileResponse> createProfile
(Consumer<CreateProfileRequest.Builder> createProfileRequest) Creates a customer profile.default CompletableFuture
<CreateProfileResponse> createProfile
(CreateProfileRequest createProfileRequest) Creates a customer profile.createStarterMappingTemplate
(Consumer<CreateStarterMappingTemplateRequest.Builder> createStarterMappingTemplateRequest) Amazon Web Services B2B Data Interchange uses a mapping template in JSONata or XSLT format to transform a customer input file into a JSON or XML file that can be converted to EDI.createStarterMappingTemplate
(CreateStarterMappingTemplateRequest createStarterMappingTemplateRequest) Amazon Web Services B2B Data Interchange uses a mapping template in JSONata or XSLT format to transform a customer input file into a JSON or XML file that can be converted to EDI.createTransformer
(Consumer<CreateTransformerRequest.Builder> createTransformerRequest) Creates a transformer.createTransformer
(CreateTransformerRequest createTransformerRequest) Creates a transformer.deleteCapability
(Consumer<DeleteCapabilityRequest.Builder> deleteCapabilityRequest) Deletes the specified capability.deleteCapability
(DeleteCapabilityRequest deleteCapabilityRequest) Deletes the specified capability.deletePartnership
(Consumer<DeletePartnershipRequest.Builder> deletePartnershipRequest) Deletes the specified partnership.deletePartnership
(DeletePartnershipRequest deletePartnershipRequest) Deletes the specified partnership.default CompletableFuture
<DeleteProfileResponse> deleteProfile
(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest) Deletes the specified profile.default CompletableFuture
<DeleteProfileResponse> deleteProfile
(DeleteProfileRequest deleteProfileRequest) Deletes the specified profile.deleteTransformer
(Consumer<DeleteTransformerRequest.Builder> deleteTransformerRequest) Deletes the specified transformer.deleteTransformer
(DeleteTransformerRequest deleteTransformerRequest) Deletes the specified transformer.default CompletableFuture
<GenerateMappingResponse> generateMapping
(Consumer<GenerateMappingRequest.Builder> generateMappingRequest) Takes sample input and output documents and uses Amazon Bedrock to generate a mapping automatically.default CompletableFuture
<GenerateMappingResponse> generateMapping
(GenerateMappingRequest generateMappingRequest) Takes sample input and output documents and uses Amazon Bedrock to generate a mapping automatically.default CompletableFuture
<GetCapabilityResponse> getCapability
(Consumer<GetCapabilityRequest.Builder> getCapabilityRequest) Retrieves the details for the specified capability.default CompletableFuture
<GetCapabilityResponse> getCapability
(GetCapabilityRequest getCapabilityRequest) Retrieves the details for the specified capability.default CompletableFuture
<GetPartnershipResponse> getPartnership
(Consumer<GetPartnershipRequest.Builder> getPartnershipRequest) Retrieves the details for a partnership, based on the partner and profile IDs specified.default CompletableFuture
<GetPartnershipResponse> getPartnership
(GetPartnershipRequest getPartnershipRequest) Retrieves the details for a partnership, based on the partner and profile IDs specified.default CompletableFuture
<GetProfileResponse> getProfile
(Consumer<GetProfileRequest.Builder> getProfileRequest) Retrieves the details for the profile specified by the profile ID.default CompletableFuture
<GetProfileResponse> getProfile
(GetProfileRequest getProfileRequest) Retrieves the details for the profile specified by the profile ID.default CompletableFuture
<GetTransformerResponse> getTransformer
(Consumer<GetTransformerRequest.Builder> getTransformerRequest) Retrieves the details for the transformer specified by the transformer ID.default CompletableFuture
<GetTransformerResponse> getTransformer
(GetTransformerRequest getTransformerRequest) Retrieves the details for the transformer specified by the transformer ID.getTransformerJob
(Consumer<GetTransformerJobRequest.Builder> getTransformerJobRequest) Returns the details of the transformer run, based on the Transformer job ID.getTransformerJob
(GetTransformerJobRequest getTransformerJobRequest) Returns the details of the transformer run, based on the Transformer job ID.listCapabilities
(Consumer<ListCapabilitiesRequest.Builder> listCapabilitiesRequest) Lists the capabilities associated with your Amazon Web Services account for your current or specified region.listCapabilities
(ListCapabilitiesRequest listCapabilitiesRequest) Lists the capabilities associated with your Amazon Web Services account for your current or specified region.default ListCapabilitiesPublisher
listCapabilitiesPaginator
(Consumer<ListCapabilitiesRequest.Builder> listCapabilitiesRequest) This is a variant oflistCapabilities(software.amazon.awssdk.services.b2bi.model.ListCapabilitiesRequest)
operation.default ListCapabilitiesPublisher
listCapabilitiesPaginator
(ListCapabilitiesRequest listCapabilitiesRequest) This is a variant oflistCapabilities(software.amazon.awssdk.services.b2bi.model.ListCapabilitiesRequest)
operation.listPartnerships
(Consumer<ListPartnershipsRequest.Builder> listPartnershipsRequest) Lists the partnerships associated with your Amazon Web Services account for your current or specified region.listPartnerships
(ListPartnershipsRequest listPartnershipsRequest) Lists the partnerships associated with your Amazon Web Services account for your current or specified region.default ListPartnershipsPublisher
listPartnershipsPaginator
(Consumer<ListPartnershipsRequest.Builder> listPartnershipsRequest) This is a variant oflistPartnerships(software.amazon.awssdk.services.b2bi.model.ListPartnershipsRequest)
operation.default ListPartnershipsPublisher
listPartnershipsPaginator
(ListPartnershipsRequest listPartnershipsRequest) This is a variant oflistPartnerships(software.amazon.awssdk.services.b2bi.model.ListPartnershipsRequest)
operation.default CompletableFuture
<ListProfilesResponse> listProfiles
(Consumer<ListProfilesRequest.Builder> listProfilesRequest) Lists the profiles associated with your Amazon Web Services account for your current or specified region.default CompletableFuture
<ListProfilesResponse> listProfiles
(ListProfilesRequest listProfilesRequest) Lists the profiles associated with your Amazon Web Services account for your current or specified region.default ListProfilesPublisher
listProfilesPaginator
(Consumer<ListProfilesRequest.Builder> listProfilesRequest) This is a variant oflistProfiles(software.amazon.awssdk.services.b2bi.model.ListProfilesRequest)
operation.default ListProfilesPublisher
listProfilesPaginator
(ListProfilesRequest listProfilesRequest) This is a variant oflistProfiles(software.amazon.awssdk.services.b2bi.model.ListProfilesRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.listTransformers
(Consumer<ListTransformersRequest.Builder> listTransformersRequest) Lists the available transformers.listTransformers
(ListTransformersRequest listTransformersRequest) Lists the available transformers.default ListTransformersPublisher
listTransformersPaginator
(Consumer<ListTransformersRequest.Builder> listTransformersRequest) This is a variant oflistTransformers(software.amazon.awssdk.services.b2bi.model.ListTransformersRequest)
operation.default ListTransformersPublisher
listTransformersPaginator
(ListTransformersRequest listTransformersRequest) This is a variant oflistTransformers(software.amazon.awssdk.services.b2bi.model.ListTransformersRequest)
operation.default B2BiServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartTransformerJob
(Consumer<StartTransformerJobRequest.Builder> startTransformerJobRequest) Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2B Data Interchange.startTransformerJob
(StartTransformerJobRequest startTransformerJobRequest) Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2B Data Interchange.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).default CompletableFuture
<TestConversionResponse> testConversion
(Consumer<TestConversionRequest.Builder> testConversionRequest) This operation mimics the latter half of a typical Outbound EDI request.default CompletableFuture
<TestConversionResponse> testConversion
(TestConversionRequest testConversionRequest) This operation mimics the latter half of a typical Outbound EDI request.default CompletableFuture
<TestMappingResponse> testMapping
(Consumer<TestMappingRequest.Builder> testMappingRequest) Maps the input file according to the provided template file.default CompletableFuture
<TestMappingResponse> testMapping
(TestMappingRequest testMappingRequest) Maps the input file according to the provided template file.default CompletableFuture
<TestParsingResponse> testParsing
(Consumer<TestParsingRequest.Builder> testParsingRequest) Parses the input EDI (electronic data interchange) file.default CompletableFuture
<TestParsingResponse> testParsing
(TestParsingRequest testParsingRequest) Parses the input EDI (electronic data interchange) file.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Detaches a key-value pair from the specified resource, as identified by its Amazon Resource Name (ARN).default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Detaches a key-value pair from the specified resource, as identified by its Amazon Resource Name (ARN).updateCapability
(Consumer<UpdateCapabilityRequest.Builder> updateCapabilityRequest) Updates some of the parameters for a capability, based on the specified parameters.updateCapability
(UpdateCapabilityRequest updateCapabilityRequest) Updates some of the parameters for a capability, based on the specified parameters.updatePartnership
(Consumer<UpdatePartnershipRequest.Builder> updatePartnershipRequest) Updates some of the parameters for a partnership between a customer and trading partner.updatePartnership
(UpdatePartnershipRequest updatePartnershipRequest) Updates some of the parameters for a partnership between a customer and trading partner.default CompletableFuture
<UpdateProfileResponse> updateProfile
(Consumer<UpdateProfileRequest.Builder> updateProfileRequest) Updates the specified parameters for a profile.default CompletableFuture
<UpdateProfileResponse> updateProfile
(UpdateProfileRequest updateProfileRequest) Updates the specified parameters for a profile.updateTransformer
(Consumer<UpdateTransformerRequest.Builder> updateTransformerRequest) Updates the specified parameters for a transformer.updateTransformer
(UpdateTransformerRequest updateTransformerRequest) Updates the specified parameters for a transformer.default B2BiAsyncWaiter
waiter()
Create an instance ofB2BiAsyncWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createCapability
default CompletableFuture<CreateCapabilityResponse> createCapability(CreateCapabilityRequest createCapabilityRequest) Instantiates a capability based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
- Parameters:
createCapabilityRequest
-- Returns:
- A Java Future containing the result of the CreateCapability 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ServiceQuotaExceededException Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCapability
default CompletableFuture<CreateCapabilityResponse> createCapability(Consumer<CreateCapabilityRequest.Builder> createCapabilityRequest) Instantiates a capability based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
This is a convenience which creates an instance of the
CreateCapabilityRequest.Builder
avoiding the need to create one manually viaCreateCapabilityRequest.builder()
- Parameters:
createCapabilityRequest
- AConsumer
that will call methods onCreateCapabilityRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateCapability 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ServiceQuotaExceededException Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPartnership
default CompletableFuture<CreatePartnershipResponse> createPartnership(CreatePartnershipRequest createPartnershipRequest) Creates a partnership between a customer and a trading partner, based on the supplied parameters. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
- Parameters:
createPartnershipRequest
-- Returns:
- A Java Future containing the result of the CreatePartnership 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ServiceQuotaExceededException Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPartnership
default CompletableFuture<CreatePartnershipResponse> createPartnership(Consumer<CreatePartnershipRequest.Builder> createPartnershipRequest) Creates a partnership between a customer and a trading partner, based on the supplied parameters. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
This is a convenience which creates an instance of the
CreatePartnershipRequest.Builder
avoiding the need to create one manually viaCreatePartnershipRequest.builder()
- Parameters:
createPartnershipRequest
- AConsumer
that will call methods onCreatePartnershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePartnership 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ServiceQuotaExceededException Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProfile
default CompletableFuture<CreateProfileResponse> createProfile(CreateProfileRequest createProfileRequest) Creates a customer profile. You can have up to five customer profiles, each representing a distinct private network. A profile is the mechanism used to create the concept of a private network.
- Parameters:
createProfileRequest
-- Returns:
- A Java Future containing the result of the CreateProfile 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ServiceQuotaExceededException Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProfile
default CompletableFuture<CreateProfileResponse> createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest) Creates a customer profile. You can have up to five customer profiles, each representing a distinct private network. A profile is the mechanism used to create the concept of a private network.
This is a convenience which creates an instance of the
CreateProfileRequest.Builder
avoiding the need to create one manually viaCreateProfileRequest.builder()
- Parameters:
createProfileRequest
- AConsumer
that will call methods onCreateProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateProfile 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ServiceQuotaExceededException Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createStarterMappingTemplate
default CompletableFuture<CreateStarterMappingTemplateResponse> createStarterMappingTemplate(CreateStarterMappingTemplateRequest createStarterMappingTemplateRequest) Amazon Web Services B2B Data Interchange uses a mapping template in JSONata or XSLT format to transform a customer input file into a JSON or XML file that can be converted to EDI.
If you provide a sample EDI file with the same structure as the EDI files that you wish to generate, then the service can generate a mapping template. The starter template contains placeholder values which you can replace with JSONata or XSLT expressions to take data from your input file and insert it into the JSON or XML file that is used to generate the EDI.
If you do not provide a sample EDI file, then the service can generate a mapping template based on the EDI settings in the
templateDetails
parameter.Currently, we only support generating a template that can generate the input to produce an Outbound X12 EDI file.
- Parameters:
createStarterMappingTemplateRequest
-- Returns:
- A Java Future containing the result of the CreateStarterMappingTemplate 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createStarterMappingTemplate
default CompletableFuture<CreateStarterMappingTemplateResponse> createStarterMappingTemplate(Consumer<CreateStarterMappingTemplateRequest.Builder> createStarterMappingTemplateRequest) Amazon Web Services B2B Data Interchange uses a mapping template in JSONata or XSLT format to transform a customer input file into a JSON or XML file that can be converted to EDI.
If you provide a sample EDI file with the same structure as the EDI files that you wish to generate, then the service can generate a mapping template. The starter template contains placeholder values which you can replace with JSONata or XSLT expressions to take data from your input file and insert it into the JSON or XML file that is used to generate the EDI.
If you do not provide a sample EDI file, then the service can generate a mapping template based on the EDI settings in the
templateDetails
parameter.Currently, we only support generating a template that can generate the input to produce an Outbound X12 EDI file.
This is a convenience which creates an instance of the
CreateStarterMappingTemplateRequest.Builder
avoiding the need to create one manually viaCreateStarterMappingTemplateRequest.builder()
- Parameters:
createStarterMappingTemplateRequest
- AConsumer
that will call methods onCreateStarterMappingTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateStarterMappingTemplate 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTransformer
default CompletableFuture<CreateTransformerResponse> createTransformer(CreateTransformerRequest createTransformerRequest) Creates a transformer. Amazon Web Services B2B Data Interchange currently supports two scenarios:
-
Inbound EDI: the Amazon Web Services customer receives an EDI file from their trading partner. Amazon Web Services B2B Data Interchange converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer, in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires.
-
Outbound EDI: the Amazon Web Services customer has a JSON or XML file containing data that they wish to use in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.
The following fields are provided for backwards compatibility only:
fileFormat
,mappingTemplate
,ediType
, andsampleDocument
.-
Use the
mapping
data type in place ofmappingTemplate
andfileFormat
-
Use the
sampleDocuments
data type in place ofsampleDocument
-
Use either the
inputConversion
oroutputConversion
in place ofediType
- Parameters:
createTransformerRequest
-- Returns:
- A Java Future containing the result of the CreateTransformer 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ServiceQuotaExceededException Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createTransformer
default CompletableFuture<CreateTransformerResponse> createTransformer(Consumer<CreateTransformerRequest.Builder> createTransformerRequest) Creates a transformer. Amazon Web Services B2B Data Interchange currently supports two scenarios:
-
Inbound EDI: the Amazon Web Services customer receives an EDI file from their trading partner. Amazon Web Services B2B Data Interchange converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer, in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires.
-
Outbound EDI: the Amazon Web Services customer has a JSON or XML file containing data that they wish to use in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.
The following fields are provided for backwards compatibility only:
fileFormat
,mappingTemplate
,ediType
, andsampleDocument
.-
Use the
mapping
data type in place ofmappingTemplate
andfileFormat
-
Use the
sampleDocuments
data type in place ofsampleDocument
-
Use either the
inputConversion
oroutputConversion
in place ofediType
This is a convenience which creates an instance of the
CreateTransformerRequest.Builder
avoiding the need to create one manually viaCreateTransformerRequest.builder()
- Parameters:
createTransformerRequest
- AConsumer
that will call methods onCreateTransformerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateTransformer 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ServiceQuotaExceededException Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteCapability
default CompletableFuture<DeleteCapabilityResponse> deleteCapability(DeleteCapabilityRequest deleteCapabilityRequest) Deletes the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
- Parameters:
deleteCapabilityRequest
-- Returns:
- A Java Future containing the result of the DeleteCapability 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCapability
default CompletableFuture<DeleteCapabilityResponse> deleteCapability(Consumer<DeleteCapabilityRequest.Builder> deleteCapabilityRequest) Deletes the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
This is a convenience which creates an instance of the
DeleteCapabilityRequest.Builder
avoiding the need to create one manually viaDeleteCapabilityRequest.builder()
- Parameters:
deleteCapabilityRequest
- AConsumer
that will call methods onDeleteCapabilityRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteCapability 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePartnership
default CompletableFuture<DeletePartnershipResponse> deletePartnership(DeletePartnershipRequest deletePartnershipRequest) Deletes the specified partnership. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
- Parameters:
deletePartnershipRequest
-- Returns:
- A Java Future containing the result of the DeletePartnership 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePartnership
default CompletableFuture<DeletePartnershipResponse> deletePartnership(Consumer<DeletePartnershipRequest.Builder> deletePartnershipRequest) Deletes the specified partnership. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
This is a convenience which creates an instance of the
DeletePartnershipRequest.Builder
avoiding the need to create one manually viaDeletePartnershipRequest.builder()
- Parameters:
deletePartnershipRequest
- AConsumer
that will call methods onDeletePartnershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePartnership 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProfile
default CompletableFuture<DeleteProfileResponse> deleteProfile(DeleteProfileRequest deleteProfileRequest) Deletes the specified profile. A profile is the mechanism used to create the concept of a private network.
- Parameters:
deleteProfileRequest
-- Returns:
- A Java Future containing the result of the DeleteProfile 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.- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProfile
default CompletableFuture<DeleteProfileResponse> deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest) Deletes the specified profile. A profile is the mechanism used to create the concept of a private network.
This is a convenience which creates an instance of the
DeleteProfileRequest.Builder
avoiding the need to create one manually viaDeleteProfileRequest.builder()
- Parameters:
deleteProfileRequest
- AConsumer
that will call methods onDeleteProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteProfile 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.- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTransformer
default CompletableFuture<DeleteTransformerResponse> deleteTransformer(DeleteTransformerRequest deleteTransformerRequest) Deletes the specified transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
- Parameters:
deleteTransformerRequest
-- Returns:
- A Java Future containing the result of the DeleteTransformer 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTransformer
default CompletableFuture<DeleteTransformerResponse> deleteTransformer(Consumer<DeleteTransformerRequest.Builder> deleteTransformerRequest) Deletes the specified transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
This is a convenience which creates an instance of the
DeleteTransformerRequest.Builder
avoiding the need to create one manually viaDeleteTransformerRequest.builder()
- Parameters:
deleteTransformerRequest
- AConsumer
that will call methods onDeleteTransformerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteTransformer 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
generateMapping
default CompletableFuture<GenerateMappingResponse> generateMapping(GenerateMappingRequest generateMappingRequest) Takes sample input and output documents and uses Amazon Bedrock to generate a mapping automatically. Depending on the accuracy and other factors, you can then edit the mapping for your needs.
Before you can use the AI-assisted feature for Amazon Web Services B2B Data Interchange you must enable models in Amazon Bedrock. For details, see AI-assisted template mapping prerequisites in the Amazon Web Services B2B Data Interchange User guide.
To generate a mapping, perform the following steps:
-
Start with an X12 EDI document to use as the input.
-
Call
TestMapping
using your EDI document. -
Use the output from the
TestMapping
operation as either input or output for your GenerateMapping call, along with your sample file.
- Parameters:
generateMappingRequest
-- Returns:
- A Java Future containing the result of the GenerateMapping 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
generateMapping
default CompletableFuture<GenerateMappingResponse> generateMapping(Consumer<GenerateMappingRequest.Builder> generateMappingRequest) Takes sample input and output documents and uses Amazon Bedrock to generate a mapping automatically. Depending on the accuracy and other factors, you can then edit the mapping for your needs.
Before you can use the AI-assisted feature for Amazon Web Services B2B Data Interchange you must enable models in Amazon Bedrock. For details, see AI-assisted template mapping prerequisites in the Amazon Web Services B2B Data Interchange User guide.
To generate a mapping, perform the following steps:
-
Start with an X12 EDI document to use as the input.
-
Call
TestMapping
using your EDI document. -
Use the output from the
TestMapping
operation as either input or output for your GenerateMapping call, along with your sample file.
This is a convenience which creates an instance of the
GenerateMappingRequest.Builder
avoiding the need to create one manually viaGenerateMappingRequest.builder()
- Parameters:
generateMappingRequest
- AConsumer
that will call methods onGenerateMappingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GenerateMapping 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getCapability
default CompletableFuture<GetCapabilityResponse> getCapability(GetCapabilityRequest getCapabilityRequest) Retrieves the details for the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
- Parameters:
getCapabilityRequest
-- Returns:
- A Java Future containing the result of the GetCapability 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCapability
default CompletableFuture<GetCapabilityResponse> getCapability(Consumer<GetCapabilityRequest.Builder> getCapabilityRequest) Retrieves the details for the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
This is a convenience which creates an instance of the
GetCapabilityRequest.Builder
avoiding the need to create one manually viaGetCapabilityRequest.builder()
- Parameters:
getCapabilityRequest
- AConsumer
that will call methods onGetCapabilityRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetCapability 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPartnership
default CompletableFuture<GetPartnershipResponse> getPartnership(GetPartnershipRequest getPartnershipRequest) Retrieves the details for a partnership, based on the partner and profile IDs specified. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
- Parameters:
getPartnershipRequest
-- Returns:
- A Java Future containing the result of the GetPartnership 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPartnership
default CompletableFuture<GetPartnershipResponse> getPartnership(Consumer<GetPartnershipRequest.Builder> getPartnershipRequest) Retrieves the details for a partnership, based on the partner and profile IDs specified. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
This is a convenience which creates an instance of the
GetPartnershipRequest.Builder
avoiding the need to create one manually viaGetPartnershipRequest.builder()
- Parameters:
getPartnershipRequest
- AConsumer
that will call methods onGetPartnershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetPartnership 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProfile
Retrieves the details for the profile specified by the profile ID. A profile is the mechanism used to create the concept of a private network.
- Parameters:
getProfileRequest
-- Returns:
- A Java Future containing the result of the GetProfile 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProfile
default CompletableFuture<GetProfileResponse> getProfile(Consumer<GetProfileRequest.Builder> getProfileRequest) Retrieves the details for the profile specified by the profile ID. A profile is the mechanism used to create the concept of a private network.
This is a convenience which creates an instance of the
GetProfileRequest.Builder
avoiding the need to create one manually viaGetProfileRequest.builder()
- Parameters:
getProfileRequest
- AConsumer
that will call methods onGetProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetProfile 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTransformer
default CompletableFuture<GetTransformerResponse> getTransformer(GetTransformerRequest getTransformerRequest) Retrieves the details for the transformer specified by the transformer ID. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
- Parameters:
getTransformerRequest
-- Returns:
- A Java Future containing the result of the GetTransformer 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTransformer
default CompletableFuture<GetTransformerResponse> getTransformer(Consumer<GetTransformerRequest.Builder> getTransformerRequest) Retrieves the details for the transformer specified by the transformer ID. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
This is a convenience which creates an instance of the
GetTransformerRequest.Builder
avoiding the need to create one manually viaGetTransformerRequest.builder()
- Parameters:
getTransformerRequest
- AConsumer
that will call methods onGetTransformerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetTransformer 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTransformerJob
default CompletableFuture<GetTransformerJobResponse> getTransformerJob(GetTransformerJobRequest getTransformerJobRequest) Returns the details of the transformer run, based on the Transformer job ID.
If 30 days have elapsed since your transformer job was started, the system deletes it. So, if you run
GetTransformerJob
and supply atransformerId
andtransformerJobId
for a job that was started more than 30 days previously, you receive a 404 response.- Parameters:
getTransformerJobRequest
-- Returns:
- A Java Future containing the result of the GetTransformerJob 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTransformerJob
default CompletableFuture<GetTransformerJobResponse> getTransformerJob(Consumer<GetTransformerJobRequest.Builder> getTransformerJobRequest) Returns the details of the transformer run, based on the Transformer job ID.
If 30 days have elapsed since your transformer job was started, the system deletes it. So, if you run
GetTransformerJob
and supply atransformerId
andtransformerJobId
for a job that was started more than 30 days previously, you receive a 404 response.
This is a convenience which creates an instance of the
GetTransformerJobRequest.Builder
avoiding the need to create one manually viaGetTransformerJobRequest.builder()
- Parameters:
getTransformerJobRequest
- AConsumer
that will call methods onGetTransformerJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetTransformerJob 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCapabilities
default CompletableFuture<ListCapabilitiesResponse> listCapabilities(ListCapabilitiesRequest listCapabilitiesRequest) Lists the capabilities associated with your Amazon Web Services account for your current or specified region. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
- Parameters:
listCapabilitiesRequest
-- Returns:
- A Java Future containing the result of the ListCapabilities 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCapabilities
default CompletableFuture<ListCapabilitiesResponse> listCapabilities(Consumer<ListCapabilitiesRequest.Builder> listCapabilitiesRequest) Lists the capabilities associated with your Amazon Web Services account for your current or specified region. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
This is a convenience which creates an instance of the
ListCapabilitiesRequest.Builder
avoiding the need to create one manually viaListCapabilitiesRequest.builder()
- Parameters:
listCapabilitiesRequest
- AConsumer
that will call methods onListCapabilitiesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCapabilities 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCapabilitiesPaginator
default ListCapabilitiesPublisher listCapabilitiesPaginator(ListCapabilitiesRequest listCapabilitiesRequest) This is a variant of
listCapabilities(software.amazon.awssdk.services.b2bi.model.ListCapabilitiesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.b2bi.paginators.ListCapabilitiesPublisher publisher = client.listCapabilitiesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.b2bi.paginators.ListCapabilitiesPublisher publisher = client.listCapabilitiesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.b2bi.model.ListCapabilitiesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.b2bi.model.ListCapabilitiesResponse 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
listCapabilities(software.amazon.awssdk.services.b2bi.model.ListCapabilitiesRequest)
operation.- Parameters:
listCapabilitiesRequest
-- 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCapabilitiesPaginator
default ListCapabilitiesPublisher listCapabilitiesPaginator(Consumer<ListCapabilitiesRequest.Builder> listCapabilitiesRequest) This is a variant of
listCapabilities(software.amazon.awssdk.services.b2bi.model.ListCapabilitiesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.b2bi.paginators.ListCapabilitiesPublisher publisher = client.listCapabilitiesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.b2bi.paginators.ListCapabilitiesPublisher publisher = client.listCapabilitiesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.b2bi.model.ListCapabilitiesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.b2bi.model.ListCapabilitiesResponse 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
listCapabilities(software.amazon.awssdk.services.b2bi.model.ListCapabilitiesRequest)
operation.
This is a convenience which creates an instance of the
ListCapabilitiesRequest.Builder
avoiding the need to create one manually viaListCapabilitiesRequest.builder()
- Parameters:
listCapabilitiesRequest
- AConsumer
that will call methods onListCapabilitiesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPartnerships
default CompletableFuture<ListPartnershipsResponse> listPartnerships(ListPartnershipsRequest listPartnershipsRequest) Lists the partnerships associated with your Amazon Web Services account for your current or specified region. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
- Parameters:
listPartnershipsRequest
-- Returns:
- A Java Future containing the result of the ListPartnerships 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPartnerships
default CompletableFuture<ListPartnershipsResponse> listPartnerships(Consumer<ListPartnershipsRequest.Builder> listPartnershipsRequest) Lists the partnerships associated with your Amazon Web Services account for your current or specified region. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
This is a convenience which creates an instance of the
ListPartnershipsRequest.Builder
avoiding the need to create one manually viaListPartnershipsRequest.builder()
- Parameters:
listPartnershipsRequest
- AConsumer
that will call methods onListPartnershipsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPartnerships 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPartnershipsPaginator
default ListPartnershipsPublisher listPartnershipsPaginator(ListPartnershipsRequest listPartnershipsRequest) This is a variant of
listPartnerships(software.amazon.awssdk.services.b2bi.model.ListPartnershipsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.b2bi.paginators.ListPartnershipsPublisher publisher = client.listPartnershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.b2bi.paginators.ListPartnershipsPublisher publisher = client.listPartnershipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.b2bi.model.ListPartnershipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.b2bi.model.ListPartnershipsResponse 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
listPartnerships(software.amazon.awssdk.services.b2bi.model.ListPartnershipsRequest)
operation.- Parameters:
listPartnershipsRequest
-- 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPartnershipsPaginator
default ListPartnershipsPublisher listPartnershipsPaginator(Consumer<ListPartnershipsRequest.Builder> listPartnershipsRequest) This is a variant of
listPartnerships(software.amazon.awssdk.services.b2bi.model.ListPartnershipsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.b2bi.paginators.ListPartnershipsPublisher publisher = client.listPartnershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.b2bi.paginators.ListPartnershipsPublisher publisher = client.listPartnershipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.b2bi.model.ListPartnershipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.b2bi.model.ListPartnershipsResponse 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
listPartnerships(software.amazon.awssdk.services.b2bi.model.ListPartnershipsRequest)
operation.
This is a convenience which creates an instance of the
ListPartnershipsRequest.Builder
avoiding the need to create one manually viaListPartnershipsRequest.builder()
- Parameters:
listPartnershipsRequest
- AConsumer
that will call methods onListPartnershipsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProfiles
default CompletableFuture<ListProfilesResponse> listProfiles(ListProfilesRequest listProfilesRequest) Lists the profiles associated with your Amazon Web Services account for your current or specified region. A profile is the mechanism used to create the concept of a private network.
- Parameters:
listProfilesRequest
-- Returns:
- A Java Future containing the result of the ListProfiles 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProfiles
default CompletableFuture<ListProfilesResponse> listProfiles(Consumer<ListProfilesRequest.Builder> listProfilesRequest) Lists the profiles associated with your Amazon Web Services account for your current or specified region. A profile is the mechanism used to create the concept of a private network.
This is a convenience which creates an instance of the
ListProfilesRequest.Builder
avoiding the need to create one manually viaListProfilesRequest.builder()
- Parameters:
listProfilesRequest
- AConsumer
that will call methods onListProfilesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListProfiles 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProfilesPaginator
This is a variant of
listProfiles(software.amazon.awssdk.services.b2bi.model.ListProfilesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.b2bi.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.b2bi.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.b2bi.model.ListProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.b2bi.model.ListProfilesResponse 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
listProfiles(software.amazon.awssdk.services.b2bi.model.ListProfilesRequest)
operation.- Parameters:
listProfilesRequest
-- 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProfilesPaginator
default ListProfilesPublisher listProfilesPaginator(Consumer<ListProfilesRequest.Builder> listProfilesRequest) This is a variant of
listProfiles(software.amazon.awssdk.services.b2bi.model.ListProfilesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.b2bi.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.b2bi.paginators.ListProfilesPublisher publisher = client.listProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.b2bi.model.ListProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.b2bi.model.ListProfilesResponse 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
listProfiles(software.amazon.awssdk.services.b2bi.model.ListProfilesRequest)
operation.
This is a convenience which creates an instance of the
ListProfilesRequest.Builder
avoiding the need to create one manually viaListProfilesRequest.builder()
- Parameters:
listProfilesRequest
- AConsumer
that will call methods onListProfilesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException 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 all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a capability, partnership, profile, or transformer.
- 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.- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException 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 all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a capability, partnership, profile, or transformer.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTransformers
default CompletableFuture<ListTransformersResponse> listTransformers(ListTransformersRequest listTransformersRequest) Lists the available transformers. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
- Parameters:
listTransformersRequest
-- Returns:
- A Java Future containing the result of the ListTransformers 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTransformers
default CompletableFuture<ListTransformersResponse> listTransformers(Consumer<ListTransformersRequest.Builder> listTransformersRequest) Lists the available transformers. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
This is a convenience which creates an instance of the
ListTransformersRequest.Builder
avoiding the need to create one manually viaListTransformersRequest.builder()
- Parameters:
listTransformersRequest
- AConsumer
that will call methods onListTransformersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTransformers 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTransformersPaginator
default ListTransformersPublisher listTransformersPaginator(ListTransformersRequest listTransformersRequest) This is a variant of
listTransformers(software.amazon.awssdk.services.b2bi.model.ListTransformersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.b2bi.paginators.ListTransformersPublisher publisher = client.listTransformersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.b2bi.paginators.ListTransformersPublisher publisher = client.listTransformersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.b2bi.model.ListTransformersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.b2bi.model.ListTransformersResponse 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
listTransformers(software.amazon.awssdk.services.b2bi.model.ListTransformersRequest)
operation.- Parameters:
listTransformersRequest
-- 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTransformersPaginator
default ListTransformersPublisher listTransformersPaginator(Consumer<ListTransformersRequest.Builder> listTransformersRequest) This is a variant of
listTransformers(software.amazon.awssdk.services.b2bi.model.ListTransformersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.b2bi.paginators.ListTransformersPublisher publisher = client.listTransformersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.b2bi.paginators.ListTransformersPublisher publisher = client.listTransformersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.b2bi.model.ListTransformersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.b2bi.model.ListTransformersResponse 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
listTransformers(software.amazon.awssdk.services.b2bi.model.ListTransformersRequest)
operation.
This is a convenience which creates an instance of the
ListTransformersRequest.Builder
avoiding the need to create one manually viaListTransformersRequest.builder()
- Parameters:
listTransformersRequest
- AConsumer
that will call methods onListTransformersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startTransformerJob
default CompletableFuture<StartTransformerJobResponse> startTransformerJob(StartTransformerJobRequest startTransformerJobRequest) Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2B Data Interchange.
If you only want to transform EDI (electronic data interchange) documents, you don't need to create profiles, partnerships or capabilities. Just create and configure a transformer, and then run the
StartTransformerJob
API to process your files.The system stores transformer jobs for 30 days. During that period, you can run GetTransformerJob and supply its
transformerId
andtransformerJobId
to return details of the job.- Parameters:
startTransformerJobRequest
-- Returns:
- A Java Future containing the result of the StartTransformerJob 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startTransformerJob
default CompletableFuture<StartTransformerJobResponse> startTransformerJob(Consumer<StartTransformerJobRequest.Builder> startTransformerJobRequest) Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2B Data Interchange.
If you only want to transform EDI (electronic data interchange) documents, you don't need to create profiles, partnerships or capabilities. Just create and configure a transformer, and then run the
StartTransformerJob
API to process your files.The system stores transformer jobs for 30 days. During that period, you can run GetTransformerJob and supply its
transformerId
andtransformerJobId
to return details of the job.
This is a convenience which creates an instance of the
StartTransformerJobRequest.Builder
avoiding the need to create one manually viaStartTransformerJobRequest.builder()
- Parameters:
startTransformerJobRequest
- AConsumer
that will call methods onStartTransformerJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartTransformerJob 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and other entities.
There is no response returned from this call.
- 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.- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException 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) Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and other entities.
There is no response returned from this call.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
testConversion
default CompletableFuture<TestConversionResponse> testConversion(TestConversionRequest testConversionRequest) This operation mimics the latter half of a typical Outbound EDI request. It takes an input JSON/XML in the B2Bi shape as input, converts it to an X12 EDI string, and return that string.
- Parameters:
testConversionRequest
-- Returns:
- A Java Future containing the result of the TestConversion 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
testConversion
default CompletableFuture<TestConversionResponse> testConversion(Consumer<TestConversionRequest.Builder> testConversionRequest) This operation mimics the latter half of a typical Outbound EDI request. It takes an input JSON/XML in the B2Bi shape as input, converts it to an X12 EDI string, and return that string.
This is a convenience which creates an instance of the
TestConversionRequest.Builder
avoiding the need to create one manually viaTestConversionRequest.builder()
- Parameters:
testConversionRequest
- AConsumer
that will call methods onTestConversionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TestConversion 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
testMapping
Maps the input file according to the provided template file. The API call downloads the file contents from the Amazon S3 location, and passes the contents in as a string, to the
inputFileContent
parameter.- Parameters:
testMappingRequest
-- Returns:
- A Java Future containing the result of the TestMapping 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
testMapping
default CompletableFuture<TestMappingResponse> testMapping(Consumer<TestMappingRequest.Builder> testMappingRequest) Maps the input file according to the provided template file. The API call downloads the file contents from the Amazon S3 location, and passes the contents in as a string, to the
inputFileContent
parameter.
This is a convenience which creates an instance of the
TestMappingRequest.Builder
avoiding the need to create one manually viaTestMappingRequest.builder()
- Parameters:
testMappingRequest
- AConsumer
that will call methods onTestMappingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TestMapping 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
testParsing
Parses the input EDI (electronic data interchange) file. The input file has a file size limit of 250 KB.
- Parameters:
testParsingRequest
-- Returns:
- A Java Future containing the result of the TestParsing 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
testParsing
default CompletableFuture<TestParsingResponse> testParsing(Consumer<TestParsingRequest.Builder> testParsingRequest) Parses the input EDI (electronic data interchange) file. The input file has a file size limit of 250 KB.
This is a convenience which creates an instance of the
TestParsingRequest.Builder
avoiding the need to create one manually viaTestParsingRequest.builder()
- Parameters:
testParsingRequest
- AConsumer
that will call methods onTestParsingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TestParsing 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException 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) Detaches a key-value pair from the specified resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and other entities.
- 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.- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException 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) Detaches a key-value pair from the specified resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and other entities.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCapability
default CompletableFuture<UpdateCapabilityResponse> updateCapability(UpdateCapabilityRequest updateCapabilityRequest) Updates some of the parameters for a capability, based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
- Parameters:
updateCapabilityRequest
-- Returns:
- A Java Future containing the result of the UpdateCapability 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ServiceQuotaExceededException Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCapability
default CompletableFuture<UpdateCapabilityResponse> updateCapability(Consumer<UpdateCapabilityRequest.Builder> updateCapabilityRequest) Updates some of the parameters for a capability, based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
This is a convenience which creates an instance of the
UpdateCapabilityRequest.Builder
avoiding the need to create one manually viaUpdateCapabilityRequest.builder()
- Parameters:
updateCapabilityRequest
- AConsumer
that will call methods onUpdateCapabilityRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateCapability 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ServiceQuotaExceededException Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePartnership
default CompletableFuture<UpdatePartnershipResponse> updatePartnership(UpdatePartnershipRequest updatePartnershipRequest) Updates some of the parameters for a partnership between a customer and trading partner. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
- Parameters:
updatePartnershipRequest
-- Returns:
- A Java Future containing the result of the UpdatePartnership 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ServiceQuotaExceededException Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePartnership
default CompletableFuture<UpdatePartnershipResponse> updatePartnership(Consumer<UpdatePartnershipRequest.Builder> updatePartnershipRequest) Updates some of the parameters for a partnership between a customer and trading partner. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
This is a convenience which creates an instance of the
UpdatePartnershipRequest.Builder
avoiding the need to create one manually viaUpdatePartnershipRequest.builder()
- Parameters:
updatePartnershipRequest
- AConsumer
that will call methods onUpdatePartnershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdatePartnership 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ServiceQuotaExceededException Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProfile
default CompletableFuture<UpdateProfileResponse> updateProfile(UpdateProfileRequest updateProfileRequest) Updates the specified parameters for a profile. A profile is the mechanism used to create the concept of a private network.
- Parameters:
updateProfileRequest
-- Returns:
- A Java Future containing the result of the UpdateProfile 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ServiceQuotaExceededException Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProfile
default CompletableFuture<UpdateProfileResponse> updateProfile(Consumer<UpdateProfileRequest.Builder> updateProfileRequest) Updates the specified parameters for a profile. A profile is the mechanism used to create the concept of a private network.
This is a convenience which creates an instance of the
UpdateProfileRequest.Builder
avoiding the need to create one manually viaUpdateProfileRequest.builder()
- Parameters:
updateProfileRequest
- AConsumer
that will call methods onUpdateProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateProfile 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ServiceQuotaExceededException Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTransformer
default CompletableFuture<UpdateTransformerResponse> updateTransformer(UpdateTransformerRequest updateTransformerRequest) Updates the specified parameters for a transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
- Parameters:
updateTransformerRequest
-- Returns:
- A Java Future containing the result of the UpdateTransformer 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ServiceQuotaExceededException Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTransformer
default CompletableFuture<UpdateTransformerResponse> updateTransformer(Consumer<UpdateTransformerRequest.Builder> updateTransformerRequest) Updates the specified parameters for a transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
This is a convenience which creates an instance of the
UpdateTransformerRequest.Builder
avoiding the need to create one manually viaUpdateTransformerRequest.builder()
- Parameters:
updateTransformerRequest
- AConsumer
that will call methods onUpdateTransformerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateTransformer 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.- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- ValidationException Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ThrottlingException The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ServiceQuotaExceededException Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- B2BiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
waiter
Create an instance ofB2BiAsyncWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
B2BiAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aB2BiAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aB2BiAsyncClient
.
-