Interface B2BiClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

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

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

Fields

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

Method Summary

Modifier and Type	Method	Description
static B2BiClientBuilder	builder()	Create a builder that can be used to configure and create a B2BiClient.
static B2BiClient	create()	Create a B2BiClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateCapabilityResponse	createCapability(Consumer<CreateCapabilityRequest.Builder> createCapabilityRequest)	Instantiates a capability based on the specified parameters.
default CreateCapabilityResponse	createCapability(CreateCapabilityRequest createCapabilityRequest)	Instantiates a capability based on the specified parameters.
default CreatePartnershipResponse	createPartnership(Consumer<CreatePartnershipRequest.Builder> createPartnershipRequest)	Creates a partnership between a customer and a trading partner, based on the supplied parameters.
default CreatePartnershipResponse	createPartnership(CreatePartnershipRequest createPartnershipRequest)	Creates a partnership between a customer and a trading partner, based on the supplied parameters.
default CreateProfileResponse	createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest)	Creates a customer profile.
default CreateProfileResponse	createProfile(CreateProfileRequest createProfileRequest)	Creates a customer profile.
default 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.
default 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.
default CreateTransformerResponse	createTransformer(Consumer<CreateTransformerRequest.Builder> createTransformerRequest)	Creates a transformer.
default CreateTransformerResponse	createTransformer(CreateTransformerRequest createTransformerRequest)	Creates a transformer.
default DeleteCapabilityResponse	deleteCapability(Consumer<DeleteCapabilityRequest.Builder> deleteCapabilityRequest)	Deletes the specified capability.
default DeleteCapabilityResponse	deleteCapability(DeleteCapabilityRequest deleteCapabilityRequest)	Deletes the specified capability.
default DeletePartnershipResponse	deletePartnership(Consumer<DeletePartnershipRequest.Builder> deletePartnershipRequest)	Deletes the specified partnership.
default DeletePartnershipResponse	deletePartnership(DeletePartnershipRequest deletePartnershipRequest)	Deletes the specified partnership.
default DeleteProfileResponse	deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest)	Deletes the specified profile.
default DeleteProfileResponse	deleteProfile(DeleteProfileRequest deleteProfileRequest)	Deletes the specified profile.
default DeleteTransformerResponse	deleteTransformer(Consumer<DeleteTransformerRequest.Builder> deleteTransformerRequest)	Deletes the specified transformer.
default DeleteTransformerResponse	deleteTransformer(DeleteTransformerRequest deleteTransformerRequest)	Deletes the specified transformer.
default GetCapabilityResponse	getCapability(Consumer<GetCapabilityRequest.Builder> getCapabilityRequest)	Retrieves the details for the specified capability.
default GetCapabilityResponse	getCapability(GetCapabilityRequest getCapabilityRequest)	Retrieves the details for the specified capability.
default GetPartnershipResponse	getPartnership(Consumer<GetPartnershipRequest.Builder> getPartnershipRequest)	Retrieves the details for a partnership, based on the partner and profile IDs specified.
default GetPartnershipResponse	getPartnership(GetPartnershipRequest getPartnershipRequest)	Retrieves the details for a partnership, based on the partner and profile IDs specified.
default GetProfileResponse	getProfile(Consumer<GetProfileRequest.Builder> getProfileRequest)	Retrieves the details for the profile specified by the profile ID.
default GetProfileResponse	getProfile(GetProfileRequest getProfileRequest)	Retrieves the details for the profile specified by the profile ID.
default GetTransformerResponse	getTransformer(Consumer<GetTransformerRequest.Builder> getTransformerRequest)	Retrieves the details for the transformer specified by the transformer ID.
default GetTransformerResponse	getTransformer(GetTransformerRequest getTransformerRequest)	Retrieves the details for the transformer specified by the transformer ID.
default GetTransformerJobResponse	getTransformerJob(Consumer<GetTransformerJobRequest.Builder> getTransformerJobRequest)	Returns the details of the transformer run, based on the Transformer job ID.
default GetTransformerJobResponse	getTransformerJob(GetTransformerJobRequest getTransformerJobRequest)	Returns the details of the transformer run, based on the Transformer job ID.
default ListCapabilitiesResponse	listCapabilities(Consumer<ListCapabilitiesRequest.Builder> listCapabilitiesRequest)	Lists the capabilities associated with your Amazon Web Services account for your current or specified region.
default ListCapabilitiesResponse	listCapabilities(ListCapabilitiesRequest listCapabilitiesRequest)	Lists the capabilities associated with your Amazon Web Services account for your current or specified region.
default ListCapabilitiesIterable	listCapabilitiesPaginator(Consumer<ListCapabilitiesRequest.Builder> listCapabilitiesRequest)	This is a variant of listCapabilities(software.amazon.awssdk.services.b2bi.model.ListCapabilitiesRequest) operation.
default ListCapabilitiesIterable	listCapabilitiesPaginator(ListCapabilitiesRequest listCapabilitiesRequest)	This is a variant of listCapabilities(software.amazon.awssdk.services.b2bi.model.ListCapabilitiesRequest) operation.
default ListPartnershipsResponse	listPartnerships(Consumer<ListPartnershipsRequest.Builder> listPartnershipsRequest)	Lists the partnerships associated with your Amazon Web Services account for your current or specified region.
default ListPartnershipsResponse	listPartnerships(ListPartnershipsRequest listPartnershipsRequest)	Lists the partnerships associated with your Amazon Web Services account for your current or specified region.
default ListPartnershipsIterable	listPartnershipsPaginator(Consumer<ListPartnershipsRequest.Builder> listPartnershipsRequest)	This is a variant of listPartnerships(software.amazon.awssdk.services.b2bi.model.ListPartnershipsRequest) operation.
default ListPartnershipsIterable	listPartnershipsPaginator(ListPartnershipsRequest listPartnershipsRequest)	This is a variant of listPartnerships(software.amazon.awssdk.services.b2bi.model.ListPartnershipsRequest) operation.
default ListProfilesResponse	listProfiles(Consumer<ListProfilesRequest.Builder> listProfilesRequest)	Lists the profiles associated with your Amazon Web Services account for your current or specified region.
default ListProfilesResponse	listProfiles(ListProfilesRequest listProfilesRequest)	Lists the profiles associated with your Amazon Web Services account for your current or specified region.
default ListProfilesIterable	listProfilesPaginator(Consumer<ListProfilesRequest.Builder> listProfilesRequest)	This is a variant of listProfiles(software.amazon.awssdk.services.b2bi.model.ListProfilesRequest) operation.
default ListProfilesIterable	listProfilesPaginator(ListProfilesRequest listProfilesRequest)	This is a variant of listProfiles(software.amazon.awssdk.services.b2bi.model.ListProfilesRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
default ListTransformersResponse	listTransformers(Consumer<ListTransformersRequest.Builder> listTransformersRequest)	Lists the available transformers.
default ListTransformersResponse	listTransformers(ListTransformersRequest listTransformersRequest)	Lists the available transformers.
default ListTransformersIterable	listTransformersPaginator(Consumer<ListTransformersRequest.Builder> listTransformersRequest)	This is a variant of listTransformers(software.amazon.awssdk.services.b2bi.model.ListTransformersRequest) operation.
default ListTransformersIterable	listTransformersPaginator(ListTransformersRequest listTransformersRequest)	This is a variant of listTransformers(software.amazon.awssdk.services.b2bi.model.ListTransformersRequest) operation.
default B2BiServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default 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.
default 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.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
default TestConversionResponse	testConversion(Consumer<TestConversionRequest.Builder> testConversionRequest)	This operation mimics the latter half of a typical Outbound EDI request.
default TestConversionResponse	testConversion(TestConversionRequest testConversionRequest)	This operation mimics the latter half of a typical Outbound EDI request.
default TestMappingResponse	testMapping(Consumer<TestMappingRequest.Builder> testMappingRequest)	Maps the input file according to the provided template file.
default TestMappingResponse	testMapping(TestMappingRequest testMappingRequest)	Maps the input file according to the provided template file.
default TestParsingResponse	testParsing(Consumer<TestParsingRequest.Builder> testParsingRequest)	Parses the input EDI (electronic data interchange) file.
default TestParsingResponse	testParsing(TestParsingRequest testParsingRequest)	Parses the input EDI (electronic data interchange) file.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Detaches a key-value pair from the specified resource, as identified by its Amazon Resource Name (ARN).
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Detaches a key-value pair from the specified resource, as identified by its Amazon Resource Name (ARN).
default UpdateCapabilityResponse	updateCapability(Consumer<UpdateCapabilityRequest.Builder> updateCapabilityRequest)	Updates some of the parameters for a capability, based on the specified parameters.
default UpdateCapabilityResponse	updateCapability(UpdateCapabilityRequest updateCapabilityRequest)	Updates some of the parameters for a capability, based on the specified parameters.
default UpdatePartnershipResponse	updatePartnership(Consumer<UpdatePartnershipRequest.Builder> updatePartnershipRequest)	Updates some of the parameters for a partnership between a customer and trading partner.
default UpdatePartnershipResponse	updatePartnership(UpdatePartnershipRequest updatePartnershipRequest)	Updates some of the parameters for a partnership between a customer and trading partner.
default UpdateProfileResponse	updateProfile(Consumer<UpdateProfileRequest.Builder> updateProfileRequest)	Updates the specified parameters for a profile.
default UpdateProfileResponse	updateProfile(UpdateProfileRequest updateProfileRequest)	Updates the specified parameters for a profile.
default UpdateTransformerResponse	updateTransformer(Consumer<UpdateTransformerRequest.Builder> updateTransformerRequest)	Updates the specified parameters for a transformer.
default UpdateTransformerResponse	updateTransformer(UpdateTransformerRequest updateTransformerRequest)	Updates the specified parameters for a transformer.

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

close

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

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

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

See Also:

• Constant Field Values

Method Details

createCapability

default CreateCapabilityResponse createCapability(CreateCapabilityRequest createCapabilityRequest)
                                           throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
ServiceQuotaExceededException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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:

Result of the CreateCapability operation returned by the service.

See Also:

• AWS API Documentation

createCapability

default CreateCapabilityResponse createCapability(Consumer<CreateCapabilityRequest.Builder> createCapabilityRequest)
                                           throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
ServiceQuotaExceededException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via CreateCapabilityRequest.builder()

Parameters:

createCapabilityRequest - A Consumer that will call methods on CreateCapabilityRequest.Builder to create a request.

Returns:

Result of the CreateCapability operation returned by the service.

See Also:

• AWS API Documentation

createPartnership

default CreatePartnershipResponse createPartnership(CreatePartnershipRequest createPartnershipRequest)
                                             throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
ServiceQuotaExceededException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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:

Result of the CreatePartnership operation returned by the service.

See Also:

• AWS API Documentation

createPartnership

default CreatePartnershipResponse createPartnership(Consumer<CreatePartnershipRequest.Builder> createPartnershipRequest)
                                             throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
ServiceQuotaExceededException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via CreatePartnershipRequest.builder()

Parameters:

createPartnershipRequest - A Consumer that will call methods on CreatePartnershipRequest.Builder to create a request.

Returns:

Result of the CreatePartnership operation returned by the service.

See Also:

• AWS API Documentation

createProfile

default CreateProfileResponse createProfile(CreateProfileRequest createProfileRequest)
                                     throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
ServiceQuotaExceededException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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:

Result of the CreateProfile operation returned by the service.

See Also:

• AWS API Documentation

createProfile

default CreateProfileResponse createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest)
                                     throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
ServiceQuotaExceededException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via CreateProfileRequest.builder()

Parameters:

createProfileRequest - A Consumer that will call methods on CreateProfileRequest.Builder to create a request.

Returns:

Result of the CreateProfile operation returned by the service.

See Also:

• AWS API Documentation

createStarterMappingTemplate

default CreateStarterMappingTemplateResponse createStarterMappingTemplate(CreateStarterMappingTemplateRequest createStarterMappingTemplateRequest)
                                                                   throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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:

Result of the CreateStarterMappingTemplate operation returned by the service.

See Also:

• AWS API Documentation

createStarterMappingTemplate

default CreateStarterMappingTemplateResponse createStarterMappingTemplate(Consumer<CreateStarterMappingTemplateRequest.Builder> createStarterMappingTemplateRequest)
                                                                   throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via CreateStarterMappingTemplateRequest.builder()

Parameters:

createStarterMappingTemplateRequest - A Consumer that will call methods on CreateStarterMappingTemplateRequest.Builder to create a request.

Returns:

Result of the CreateStarterMappingTemplate operation returned by the service.

See Also:

• AWS API Documentation

createTransformer

default CreateTransformerResponse createTransformer(CreateTransformerRequest createTransformerRequest)
                                             throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
ServiceQuotaExceededException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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, and sampleDocument.

• Use the mapping data type in place of mappingTemplate and fileFormat

• Use the sampleDocuments data type in place of sampleDocument

• Use either the inputConversion or outputConversion in place of ediType

Parameters:

createTransformerRequest -

Returns:

Result of the CreateTransformer operation returned by the service.

See Also:

• AWS API Documentation

createTransformer

default CreateTransformerResponse createTransformer(Consumer<CreateTransformerRequest.Builder> createTransformerRequest)
                                             throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
ServiceQuotaExceededException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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, and sampleDocument.

• Use the mapping data type in place of mappingTemplate and fileFormat

• Use the sampleDocuments data type in place of sampleDocument

• Use either the inputConversion or outputConversion in place of ediType

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

Parameters:

createTransformerRequest - A Consumer that will call methods on CreateTransformerRequest.Builder to create a request.

Returns:

Result of the CreateTransformer operation returned by the service.

See Also:

• AWS API Documentation

deleteCapability

default DeleteCapabilityResponse deleteCapability(DeleteCapabilityRequest deleteCapabilityRequest)
                                           throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

Deletes the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

Parameters:

deleteCapabilityRequest -

Returns:

Result of the DeleteCapability operation returned by the service.

See Also:

• AWS API Documentation

deleteCapability

default DeleteCapabilityResponse deleteCapability(Consumer<DeleteCapabilityRequest.Builder> deleteCapabilityRequest)
                                           throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via DeleteCapabilityRequest.builder()

Parameters:

deleteCapabilityRequest - A Consumer that will call methods on DeleteCapabilityRequest.Builder to create a request.

Returns:

Result of the DeleteCapability operation returned by the service.

See Also:

• AWS API Documentation

deletePartnership

default DeletePartnershipResponse deletePartnership(DeletePartnershipRequest deletePartnershipRequest)
                                             throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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:

Result of the DeletePartnership operation returned by the service.

See Also:

• AWS API Documentation

deletePartnership

default DeletePartnershipResponse deletePartnership(Consumer<DeletePartnershipRequest.Builder> deletePartnershipRequest)
                                             throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via DeletePartnershipRequest.builder()

Parameters:

deletePartnershipRequest - A Consumer that will call methods on DeletePartnershipRequest.Builder to create a request.

Returns:

Result of the DeletePartnership operation returned by the service.

See Also:

• AWS API Documentation

deleteProfile

default DeleteProfileResponse deleteProfile(DeleteProfileRequest deleteProfileRequest)
                                     throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

Deletes the specified profile. A profile is the mechanism used to create the concept of a private network.

Parameters:

deleteProfileRequest -

Returns:

Result of the DeleteProfile operation returned by the service.

See Also:

• AWS API Documentation

deleteProfile

default DeleteProfileResponse deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest)
                                     throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via DeleteProfileRequest.builder()

Parameters:

deleteProfileRequest - A Consumer that will call methods on DeleteProfileRequest.Builder to create a request.

Returns:

Result of the DeleteProfile operation returned by the service.

See Also:

• AWS API Documentation

deleteTransformer

default DeleteTransformerResponse deleteTransformer(DeleteTransformerRequest deleteTransformerRequest)
                                             throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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:

Result of the DeleteTransformer operation returned by the service.

See Also:

• AWS API Documentation

deleteTransformer

default DeleteTransformerResponse deleteTransformer(Consumer<DeleteTransformerRequest.Builder> deleteTransformerRequest)
                                             throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via DeleteTransformerRequest.builder()

Parameters:

deleteTransformerRequest - A Consumer that will call methods on DeleteTransformerRequest.Builder to create a request.

Returns:

Result of the DeleteTransformer operation returned by the service.

See Also:

• AWS API Documentation

getCapability

default GetCapabilityResponse getCapability(GetCapabilityRequest getCapabilityRequest)
                                     throws AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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:

Result of the GetCapability operation returned by the service.

See Also:

• AWS API Documentation

getCapability

default GetCapabilityResponse getCapability(Consumer<GetCapabilityRequest.Builder> getCapabilityRequest)
                                     throws AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via GetCapabilityRequest.builder()

Parameters:

getCapabilityRequest - A Consumer that will call methods on GetCapabilityRequest.Builder to create a request.

Returns:

Result of the GetCapability operation returned by the service.

See Also:

• AWS API Documentation

getPartnership

default GetPartnershipResponse getPartnership(GetPartnershipRequest getPartnershipRequest)
                                       throws AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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:

Result of the GetPartnership operation returned by the service.

See Also:

• AWS API Documentation

getPartnership

default GetPartnershipResponse getPartnership(Consumer<GetPartnershipRequest.Builder> getPartnershipRequest)
                                       throws AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via GetPartnershipRequest.builder()

Parameters:

getPartnershipRequest - A Consumer that will call methods on GetPartnershipRequest.Builder to create a request.

Returns:

Result of the GetPartnership operation returned by the service.

See Also:

• AWS API Documentation

getProfile

default GetProfileResponse getProfile(GetProfileRequest getProfileRequest)
                               throws AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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:

Result of the GetProfile operation returned by the service.

See Also:

• AWS API Documentation

getProfile

default GetProfileResponse getProfile(Consumer<GetProfileRequest.Builder> getProfileRequest)
                               throws AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via GetProfileRequest.builder()

Parameters:

getProfileRequest - A Consumer that will call methods on GetProfileRequest.Builder to create a request.

Returns:

Result of the GetProfile operation returned by the service.

See Also:

• AWS API Documentation

getTransformer

default GetTransformerResponse getTransformer(GetTransformerRequest getTransformerRequest)
                                       throws AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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:

Result of the GetTransformer operation returned by the service.

See Also:

• AWS API Documentation

getTransformer

default GetTransformerResponse getTransformer(Consumer<GetTransformerRequest.Builder> getTransformerRequest)
                                       throws AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via GetTransformerRequest.builder()

Parameters:

getTransformerRequest - A Consumer that will call methods on GetTransformerRequest.Builder to create a request.

Returns:

Result of the GetTransformer operation returned by the service.

See Also:

• AWS API Documentation

getTransformerJob

default GetTransformerJobResponse getTransformerJob(GetTransformerJobRequest getTransformerJobRequest)
                                             throws AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

Returns the details of the transformer run, based on the Transformer job ID.

Parameters:

getTransformerJobRequest -

Returns:

Result of the GetTransformerJob operation returned by the service.

See Also:

• AWS API Documentation

getTransformerJob

default GetTransformerJobResponse getTransformerJob(Consumer<GetTransformerJobRequest.Builder> getTransformerJobRequest)
                                             throws AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

Returns the details of the transformer run, based on the Transformer job ID.

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

Parameters:

getTransformerJobRequest - A Consumer that will call methods on GetTransformerJobRequest.Builder to create a request.

Returns:

Result of the GetTransformerJob operation returned by the service.

See Also:

• AWS API Documentation

listCapabilities

default ListCapabilitiesResponse listCapabilities(ListCapabilitiesRequest listCapabilitiesRequest)
                                           throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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:

Result of the ListCapabilities operation returned by the service.

See Also:

• AWS API Documentation

listCapabilities

default ListCapabilitiesResponse listCapabilities(Consumer<ListCapabilitiesRequest.Builder> listCapabilitiesRequest)
                                           throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via ListCapabilitiesRequest.builder()

Parameters:

listCapabilitiesRequest - A Consumer that will call methods on ListCapabilitiesRequest.Builder to create a request.

Returns:

Result of the ListCapabilities operation returned by the service.

See Also:

• AWS API Documentation

listCapabilitiesPaginator

default ListCapabilitiesIterable listCapabilitiesPaginator(ListCapabilitiesRequest listCapabilitiesRequest)
                                                    throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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

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

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

1) Using a Stream

 
 software.amazon.awssdk.services.b2bi.paginators.ListCapabilitiesIterable responses = client.listCapabilitiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.b2bi.paginators.ListCapabilitiesIterable responses = client
             .listCapabilitiesPaginator(request);
     for (software.amazon.awssdk.services.b2bi.model.ListCapabilitiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.b2bi.paginators.ListCapabilitiesIterable responses = client.listCapabilitiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

Note: If you prefer to have control on service calls, use the listCapabilities(software.amazon.awssdk.services.b2bi.model.ListCapabilitiesRequest) operation.

Parameters:

listCapabilitiesRequest -

Returns:

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

See Also:

• AWS API Documentation

listCapabilitiesPaginator

default ListCapabilitiesIterable listCapabilitiesPaginator(Consumer<ListCapabilitiesRequest.Builder> listCapabilitiesRequest)
                                                    throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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

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

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

1) Using a Stream

 
 software.amazon.awssdk.services.b2bi.paginators.ListCapabilitiesIterable responses = client.listCapabilitiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.b2bi.paginators.ListCapabilitiesIterable responses = client
             .listCapabilitiesPaginator(request);
     for (software.amazon.awssdk.services.b2bi.model.ListCapabilitiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.b2bi.paginators.ListCapabilitiesIterable responses = client.listCapabilitiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

Note: If you prefer to have control on service calls, use the 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 via ListCapabilitiesRequest.builder()

Parameters:

listCapabilitiesRequest - A Consumer that will call methods on ListCapabilitiesRequest.Builder to create a request.

Returns:

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

See Also:

• AWS API Documentation

listPartnerships

default ListPartnershipsResponse listPartnerships(ListPartnershipsRequest listPartnershipsRequest)
                                           throws AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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:

Result of the ListPartnerships operation returned by the service.

See Also:

• AWS API Documentation

listPartnerships

default ListPartnershipsResponse listPartnerships(Consumer<ListPartnershipsRequest.Builder> listPartnershipsRequest)
                                           throws AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via ListPartnershipsRequest.builder()

Parameters:

listPartnershipsRequest - A Consumer that will call methods on ListPartnershipsRequest.Builder to create a request.

Returns:

Result of the ListPartnerships operation returned by the service.

See Also:

• AWS API Documentation

listPartnershipsPaginator

default ListPartnershipsIterable listPartnershipsPaginator(ListPartnershipsRequest listPartnershipsRequest)
                                                    throws AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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

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

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

1) Using a Stream

 
 software.amazon.awssdk.services.b2bi.paginators.ListPartnershipsIterable responses = client.listPartnershipsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.b2bi.paginators.ListPartnershipsIterable responses = client
             .listPartnershipsPaginator(request);
     for (software.amazon.awssdk.services.b2bi.model.ListPartnershipsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.b2bi.paginators.ListPartnershipsIterable responses = client.listPartnershipsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

Note: If you prefer to have control on service calls, use the listPartnerships(software.amazon.awssdk.services.b2bi.model.ListPartnershipsRequest) operation.

Parameters:

listPartnershipsRequest -

Returns:

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

See Also:

• AWS API Documentation

listPartnershipsPaginator

default ListPartnershipsIterable listPartnershipsPaginator(Consumer<ListPartnershipsRequest.Builder> listPartnershipsRequest)
                                                    throws AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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

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

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

1) Using a Stream

 
 software.amazon.awssdk.services.b2bi.paginators.ListPartnershipsIterable responses = client.listPartnershipsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.b2bi.paginators.ListPartnershipsIterable responses = client
             .listPartnershipsPaginator(request);
     for (software.amazon.awssdk.services.b2bi.model.ListPartnershipsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.b2bi.paginators.ListPartnershipsIterable responses = client.listPartnershipsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

Note: If you prefer to have control on service calls, use the 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 via ListPartnershipsRequest.builder()

Parameters:

listPartnershipsRequest - A Consumer that will call methods on ListPartnershipsRequest.Builder to create a request.

Returns:

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

See Also:

• AWS API Documentation

listProfiles

default ListProfilesResponse listProfiles(ListProfilesRequest listProfilesRequest)
                                   throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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:

Result of the ListProfiles operation returned by the service.

See Also:

• AWS API Documentation

listProfiles

default ListProfilesResponse listProfiles(Consumer<ListProfilesRequest.Builder> listProfilesRequest)
                                   throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via ListProfilesRequest.builder()

Parameters:

listProfilesRequest - A Consumer that will call methods on ListProfilesRequest.Builder to create a request.

Returns:

Result of the ListProfiles operation returned by the service.

See Also:

• AWS API Documentation

listProfilesPaginator

default ListProfilesIterable listProfilesPaginator(ListProfilesRequest listProfilesRequest)
                                            throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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

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

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

1) Using a Stream

 
 software.amazon.awssdk.services.b2bi.paginators.ListProfilesIterable responses = client.listProfilesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.b2bi.paginators.ListProfilesIterable responses = client.listProfilesPaginator(request);
     for (software.amazon.awssdk.services.b2bi.model.ListProfilesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.b2bi.paginators.ListProfilesIterable responses = client.listProfilesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

Note: If you prefer to have control on service calls, use the listProfiles(software.amazon.awssdk.services.b2bi.model.ListProfilesRequest) operation.

Parameters:

listProfilesRequest -

Returns:

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

See Also:

• AWS API Documentation

listProfilesPaginator

default ListProfilesIterable listProfilesPaginator(Consumer<ListProfilesRequest.Builder> listProfilesRequest)
                                            throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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

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

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

1) Using a Stream

 
 software.amazon.awssdk.services.b2bi.paginators.ListProfilesIterable responses = client.listProfilesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.b2bi.paginators.ListProfilesIterable responses = client.listProfilesPaginator(request);
     for (software.amazon.awssdk.services.b2bi.model.ListProfilesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.b2bi.paginators.ListProfilesIterable responses = client.listProfilesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

Note: If you prefer to have control on service calls, use the 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 via ListProfilesRequest.builder()

Parameters:

listProfilesRequest - A Consumer that will call methods on ListProfilesRequest.Builder to create a request.

Returns:

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

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ValidationException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

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

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 via ListTagsForResourceRequest.builder()

Parameters:

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

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTransformers

default ListTransformersResponse listTransformers(ListTransformersRequest listTransformersRequest)
                                           throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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:

Result of the ListTransformers operation returned by the service.

See Also:

• AWS API Documentation

listTransformers

default ListTransformersResponse listTransformers(Consumer<ListTransformersRequest.Builder> listTransformersRequest)
                                           throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via ListTransformersRequest.builder()

Parameters:

listTransformersRequest - A Consumer that will call methods on ListTransformersRequest.Builder to create a request.

Returns:

Result of the ListTransformers operation returned by the service.

See Also:

• AWS API Documentation

listTransformersPaginator

default ListTransformersIterable listTransformersPaginator(ListTransformersRequest listTransformersRequest)
                                                    throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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

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

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

1) Using a Stream

 
 software.amazon.awssdk.services.b2bi.paginators.ListTransformersIterable responses = client.listTransformersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.b2bi.paginators.ListTransformersIterable responses = client
             .listTransformersPaginator(request);
     for (software.amazon.awssdk.services.b2bi.model.ListTransformersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.b2bi.paginators.ListTransformersIterable responses = client.listTransformersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

Note: If you prefer to have control on service calls, use the listTransformers(software.amazon.awssdk.services.b2bi.model.ListTransformersRequest) operation.

Parameters:

listTransformersRequest -

Returns:

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

See Also:

• AWS API Documentation

listTransformersPaginator

default ListTransformersIterable listTransformersPaginator(Consumer<ListTransformersRequest.Builder> listTransformersRequest)
                                                    throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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

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

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

1) Using a Stream

 
 software.amazon.awssdk.services.b2bi.paginators.ListTransformersIterable responses = client.listTransformersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.b2bi.paginators.ListTransformersIterable responses = client
             .listTransformersPaginator(request);
     for (software.amazon.awssdk.services.b2bi.model.ListTransformersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.b2bi.paginators.ListTransformersIterable responses = client.listTransformersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

Note: If you prefer to have control on service calls, use the 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 via ListTransformersRequest.builder()

Parameters:

listTransformersRequest - A Consumer that will call methods on ListTransformersRequest.Builder to create a request.

Returns:

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

See Also:

• AWS API Documentation

startTransformerJob

default StartTransformerJobResponse startTransformerJob(StartTransformerJobRequest startTransformerJobRequest)
                                                 throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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.

Parameters:

startTransformerJobRequest -

Returns:

Result of the StartTransformerJob operation returned by the service.

See Also:

• AWS API Documentation

startTransformerJob

default StartTransformerJobResponse startTransformerJob(Consumer<StartTransformerJobRequest.Builder> startTransformerJobRequest)
                                                 throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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.

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

Parameters:

startTransformerJobRequest - A Consumer that will call methods on StartTransformerJobRequest.Builder to create a request.

Returns:

Result of the StartTransformerJob operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

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

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 via TagResourceRequest.builder()

Parameters:

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

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

testConversion

default TestConversionResponse testConversion(TestConversionRequest testConversionRequest)
                                       throws AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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:

Result of the TestConversion operation returned by the service.

See Also:

• AWS API Documentation

testConversion

default TestConversionResponse testConversion(Consumer<TestConversionRequest.Builder> testConversionRequest)
                                       throws AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via TestConversionRequest.builder()

Parameters:

testConversionRequest - A Consumer that will call methods on TestConversionRequest.Builder to create a request.

Returns:

Result of the TestConversion operation returned by the service.

See Also:

• AWS API Documentation

testMapping

default TestMappingResponse testMapping(TestMappingRequest testMappingRequest)
                                 throws AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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:

Result of the TestMapping operation returned by the service.

See Also:

• AWS API Documentation

testMapping

default TestMappingResponse testMapping(Consumer<TestMappingRequest.Builder> testMappingRequest)
                                 throws AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via TestMappingRequest.builder()

Parameters:

testMappingRequest - A Consumer that will call methods on TestMappingRequest.Builder to create a request.

Returns:

Result of the TestMapping operation returned by the service.

See Also:

• AWS API Documentation

testParsing

default TestParsingResponse testParsing(TestParsingRequest testParsingRequest)
                                 throws AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

Parses the input EDI (electronic data interchange) file. The input file has a file size limit of 250 KB.

Parameters:

testParsingRequest -

Returns:

Result of the TestParsing operation returned by the service.

See Also:

• AWS API Documentation

testParsing

default TestParsingResponse testParsing(Consumer<TestParsingRequest.Builder> testParsingRequest)
                                 throws AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via TestParsingRequest.builder()

Parameters:

testParsingRequest - A Consumer that will call methods on TestParsingRequest.Builder to create a request.

Returns:

Result of the TestParsing operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ValidationException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ValidationException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via UntagResourceRequest.builder()

Parameters:

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

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateCapability

default UpdateCapabilityResponse updateCapability(UpdateCapabilityRequest updateCapabilityRequest)
                                           throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
ServiceQuotaExceededException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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:

Result of the UpdateCapability operation returned by the service.

See Also:

• AWS API Documentation

updateCapability

default UpdateCapabilityResponse updateCapability(Consumer<UpdateCapabilityRequest.Builder> updateCapabilityRequest)
                                           throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
ServiceQuotaExceededException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via UpdateCapabilityRequest.builder()

Parameters:

updateCapabilityRequest - A Consumer that will call methods on UpdateCapabilityRequest.Builder to create a request.

Returns:

Result of the UpdateCapability operation returned by the service.

See Also:

• AWS API Documentation

updatePartnership

default UpdatePartnershipResponse updatePartnership(UpdatePartnershipRequest updatePartnershipRequest)
                                             throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
ServiceQuotaExceededException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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:

Result of the UpdatePartnership operation returned by the service.

See Also:

• AWS API Documentation

updatePartnership

default UpdatePartnershipResponse updatePartnership(Consumer<UpdatePartnershipRequest.Builder> updatePartnershipRequest)
                                             throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
ServiceQuotaExceededException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via UpdatePartnershipRequest.builder()

Parameters:

updatePartnershipRequest - A Consumer that will call methods on UpdatePartnershipRequest.Builder to create a request.

Returns:

Result of the UpdatePartnership operation returned by the service.

See Also:

• AWS API Documentation

updateProfile

default UpdateProfileResponse updateProfile(UpdateProfileRequest updateProfileRequest)
                                     throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
ServiceQuotaExceededException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

Updates the specified parameters for a profile. A profile is the mechanism used to create the concept of a private network.

Parameters:

updateProfileRequest -

Returns:

Result of the UpdateProfile operation returned by the service.

See Also:

• AWS API Documentation

updateProfile

default UpdateProfileResponse updateProfile(Consumer<UpdateProfileRequest.Builder> updateProfileRequest)
                                     throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
ServiceQuotaExceededException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via UpdateProfileRequest.builder()

Parameters:

updateProfileRequest - A Consumer that will call methods on UpdateProfileRequest.Builder to create a request.

Returns:

Result of the UpdateProfile operation returned by the service.

See Also:

• AWS API Documentation

updateTransformer

default UpdateTransformerResponse updateTransformer(UpdateTransformerRequest updateTransformerRequest)
                                             throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
ServiceQuotaExceededException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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:

Result of the UpdateTransformer operation returned by the service.

See Also:

• AWS API Documentation

updateTransformer

default UpdateTransformerResponse updateTransformer(Consumer<UpdateTransformerRequest.Builder> updateTransformerRequest)
                                             throws ConflictException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ResourceNotFoundException,
ServiceQuotaExceededException,
InternalServerException,
AwsServiceException,
SdkClientException,
B2BiException

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 via UpdateTransformerRequest.builder()

Parameters:

updateTransformerRequest - A Consumer that will call methods on UpdateTransformerRequest.Builder to create a request.

Returns:

Result of the UpdateTransformer operation returned by the service.

See Also:

• AWS API Documentation

create

static B2BiClient create()

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

builder

static B2BiClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default B2BiServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

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

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration