Interface B2BiClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
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
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic B2BiClientBuilder
builder()
Create a builder that can be used to configure and create aB2BiClient
.static B2BiClient
create()
Create aB2BiClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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.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.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 GenerateMappingResponse
generateMapping
(Consumer<GenerateMappingRequest.Builder> generateMappingRequest) Takes sample input and output documents and uses Amazon Bedrock to generate a mapping automatically.default GenerateMappingResponse
generateMapping
(GenerateMappingRequest generateMappingRequest) Takes sample input and output documents and uses Amazon Bedrock to generate a mapping automatically.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 oflistCapabilities(software.amazon.awssdk.services.b2bi.model.ListCapabilitiesRequest)
operation.default ListCapabilitiesIterable
listCapabilitiesPaginator
(ListCapabilitiesRequest listCapabilitiesRequest) This is a variant oflistCapabilities(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 oflistPartnerships(software.amazon.awssdk.services.b2bi.model.ListPartnershipsRequest)
operation.default ListPartnershipsIterable
listPartnershipsPaginator
(ListPartnershipsRequest listPartnershipsRequest) This is a variant oflistPartnerships(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 oflistProfiles(software.amazon.awssdk.services.b2bi.model.ListProfilesRequest)
operation.default ListProfilesIterable
listProfilesPaginator
(ListProfilesRequest listProfilesRequest) This is a variant oflistProfiles(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 oflistTransformers(software.amazon.awssdk.services.b2bi.model.ListTransformersRequest)
operation.default ListTransformersIterable
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., ClientOverrideConfigurationstatic 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.default B2BiWaiter
waiter()
Create an instance ofB2BiWaiter
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 CreateCapabilityResponse createCapability(CreateCapabilityRequest createCapabilityRequest) throws AccessDeniedException, ConflictException, 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:
-
createCapability
default CreateCapabilityResponse createCapability(Consumer<CreateCapabilityRequest.Builder> createCapabilityRequest) throws AccessDeniedException, ConflictException, 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 viaCreateCapabilityRequest.builder()
- Parameters:
createCapabilityRequest
- AConsumer
that will call methods onCreateCapabilityRequest.Builder
to create a request.- Returns:
- Result of the CreateCapability operation returned by the service.
- See Also:
-
createPartnership
default CreatePartnershipResponse createPartnership(CreatePartnershipRequest createPartnershipRequest) throws AccessDeniedException, ConflictException, ValidationException, ResourceNotFoundException, ThrottlingException, 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:
-
createPartnership
default CreatePartnershipResponse createPartnership(Consumer<CreatePartnershipRequest.Builder> createPartnershipRequest) throws AccessDeniedException, ConflictException, ValidationException, ResourceNotFoundException, ThrottlingException, 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 viaCreatePartnershipRequest.builder()
- Parameters:
createPartnershipRequest
- AConsumer
that will call methods onCreatePartnershipRequest.Builder
to create a request.- Returns:
- Result of the CreatePartnership operation returned by the service.
- See Also:
-
createProfile
default CreateProfileResponse createProfile(CreateProfileRequest createProfileRequest) throws AccessDeniedException, ConflictException, ValidationException, ResourceNotFoundException, ThrottlingException, 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:
-
createProfile
default CreateProfileResponse createProfile(Consumer<CreateProfileRequest.Builder> createProfileRequest) throws AccessDeniedException, ConflictException, ValidationException, ResourceNotFoundException, ThrottlingException, 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 viaCreateProfileRequest.builder()
- Parameters:
createProfileRequest
- AConsumer
that will call methods onCreateProfileRequest.Builder
to create a request.- Returns:
- Result of the CreateProfile operation returned by the service.
- See Also:
-
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:
-
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 viaCreateStarterMappingTemplateRequest.builder()
- Parameters:
createStarterMappingTemplateRequest
- AConsumer
that will call methods onCreateStarterMappingTemplateRequest.Builder
to create a request.- Returns:
- Result of the CreateStarterMappingTemplate operation returned by the service.
- See Also:
-
createTransformer
default CreateTransformerResponse createTransformer(CreateTransformerRequest createTransformerRequest) throws AccessDeniedException, ConflictException, ValidationException, ResourceNotFoundException, ThrottlingException, 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
, 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:
- Result of the CreateTransformer operation returned by the service.
- See Also:
-
-
createTransformer
default CreateTransformerResponse createTransformer(Consumer<CreateTransformerRequest.Builder> createTransformerRequest) throws AccessDeniedException, ConflictException, ValidationException, ResourceNotFoundException, ThrottlingException, 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
, 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:
- Result of the CreateTransformer operation returned by the service.
- See Also:
-
-
deleteCapability
default DeleteCapabilityResponse deleteCapability(DeleteCapabilityRequest deleteCapabilityRequest) throws AccessDeniedException, ConflictException, 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:
-
deleteCapability
default DeleteCapabilityResponse deleteCapability(Consumer<DeleteCapabilityRequest.Builder> deleteCapabilityRequest) throws AccessDeniedException, ConflictException, 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 viaDeleteCapabilityRequest.builder()
- Parameters:
deleteCapabilityRequest
- AConsumer
that will call methods onDeleteCapabilityRequest.Builder
to create a request.- Returns:
- Result of the DeleteCapability operation returned by the service.
- See Also:
-
deletePartnership
default DeletePartnershipResponse deletePartnership(DeletePartnershipRequest deletePartnershipRequest) throws AccessDeniedException, ConflictException, ValidationException, ResourceNotFoundException, ThrottlingException, 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:
-
deletePartnership
default DeletePartnershipResponse deletePartnership(Consumer<DeletePartnershipRequest.Builder> deletePartnershipRequest) throws AccessDeniedException, ConflictException, ValidationException, ResourceNotFoundException, ThrottlingException, 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 viaDeletePartnershipRequest.builder()
- Parameters:
deletePartnershipRequest
- AConsumer
that will call methods onDeletePartnershipRequest.Builder
to create a request.- Returns:
- Result of the DeletePartnership operation returned by the service.
- See Also:
-
deleteProfile
default DeleteProfileResponse deleteProfile(DeleteProfileRequest deleteProfileRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, 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:
-
deleteProfile
default DeleteProfileResponse deleteProfile(Consumer<DeleteProfileRequest.Builder> deleteProfileRequest) throws ConflictException, AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, 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 viaDeleteProfileRequest.builder()
- Parameters:
deleteProfileRequest
- AConsumer
that will call methods onDeleteProfileRequest.Builder
to create a request.- Returns:
- Result of the DeleteProfile operation returned by the service.
- See Also:
-
deleteTransformer
default DeleteTransformerResponse deleteTransformer(DeleteTransformerRequest deleteTransformerRequest) throws AccessDeniedException, ConflictException, ValidationException, ResourceNotFoundException, ThrottlingException, 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:
-
deleteTransformer
default DeleteTransformerResponse deleteTransformer(Consumer<DeleteTransformerRequest.Builder> deleteTransformerRequest) throws AccessDeniedException, ConflictException, ValidationException, ResourceNotFoundException, ThrottlingException, 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 viaDeleteTransformerRequest.builder()
- Parameters:
deleteTransformerRequest
- AConsumer
that will call methods onDeleteTransformerRequest.Builder
to create a request.- Returns:
- Result of the DeleteTransformer operation returned by the service.
- See Also:
-
generateMapping
default GenerateMappingResponse generateMapping(GenerateMappingRequest generateMappingRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, B2BiException 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:
- Result of the GenerateMapping operation returned by the service.
- See Also:
-
-
generateMapping
default GenerateMappingResponse generateMapping(Consumer<GenerateMappingRequest.Builder> generateMappingRequest) throws AccessDeniedException, ValidationException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, B2BiException 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:
- Result of the GenerateMapping operation returned by the service.
- See Also:
-
-
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:
-
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 viaGetCapabilityRequest.builder()
- Parameters:
getCapabilityRequest
- AConsumer
that will call methods onGetCapabilityRequest.Builder
to create a request.- Returns:
- Result of the GetCapability operation returned by the service.
- See Also:
-
getPartnership
default GetPartnershipResponse getPartnership(GetPartnershipRequest getPartnershipRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, 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:
-
getPartnership
default GetPartnershipResponse getPartnership(Consumer<GetPartnershipRequest.Builder> getPartnershipRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, 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 viaGetPartnershipRequest.builder()
- Parameters:
getPartnershipRequest
- AConsumer
that will call methods onGetPartnershipRequest.Builder
to create a request.- Returns:
- Result of the GetPartnership operation returned by the service.
- See Also:
-
getProfile
default GetProfileResponse getProfile(GetProfileRequest getProfileRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, 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:
-
getProfile
default GetProfileResponse getProfile(Consumer<GetProfileRequest.Builder> getProfileRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, 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 viaGetProfileRequest.builder()
- Parameters:
getProfileRequest
- AConsumer
that will call methods onGetProfileRequest.Builder
to create a request.- Returns:
- Result of the GetProfile operation returned by the service.
- See Also:
-
getTransformer
default GetTransformerResponse getTransformer(GetTransformerRequest getTransformerRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, 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:
-
getTransformer
default GetTransformerResponse getTransformer(Consumer<GetTransformerRequest.Builder> getTransformerRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, 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 viaGetTransformerRequest.builder()
- Parameters:
getTransformerRequest
- AConsumer
that will call methods onGetTransformerRequest.Builder
to create a request.- Returns:
- Result of the GetTransformer operation returned by the service.
- See Also:
-
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.
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:
- Result of the GetTransformerJob operation returned by the service.
- See Also:
-
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.
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:
- Result of the GetTransformerJob operation returned by the service.
- See Also:
-
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:
-
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 viaListCapabilitiesRequest.builder()
- Parameters:
listCapabilitiesRequest
- AConsumer
that will call methods onListCapabilitiesRequest.Builder
to create a request.- Returns:
- Result of the ListCapabilities operation returned by the service.
- See Also:
-
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 Streamsoftware.amazon.awssdk.services.b2bi.paginators.ListCapabilitiesIterable responses = client.listCapabilitiesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
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 Streamsoftware.amazon.awssdk.services.b2bi.paginators.ListCapabilitiesIterable responses = client.listCapabilitiesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListCapabilitiesRequest.builder()
- Parameters:
listCapabilitiesRequest
- AConsumer
that will call methods onListCapabilitiesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPartnerships
default ListPartnershipsResponse listPartnerships(ListPartnershipsRequest listPartnershipsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, 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:
-
listPartnerships
default ListPartnershipsResponse listPartnerships(Consumer<ListPartnershipsRequest.Builder> listPartnershipsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, 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 viaListPartnershipsRequest.builder()
- Parameters:
listPartnershipsRequest
- AConsumer
that will call methods onListPartnershipsRequest.Builder
to create a request.- Returns:
- Result of the ListPartnerships operation returned by the service.
- See Also:
-
listPartnershipsPaginator
default ListPartnershipsIterable listPartnershipsPaginator(ListPartnershipsRequest listPartnershipsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, 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 Streamsoftware.amazon.awssdk.services.b2bi.paginators.ListPartnershipsIterable responses = client.listPartnershipsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
listPartnershipsPaginator
default ListPartnershipsIterable listPartnershipsPaginator(Consumer<ListPartnershipsRequest.Builder> listPartnershipsRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, 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 Streamsoftware.amazon.awssdk.services.b2bi.paginators.ListPartnershipsIterable responses = client.listPartnershipsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListPartnershipsRequest.builder()
- Parameters:
listPartnershipsRequest
- AConsumer
that will call methods onListPartnershipsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListProfilesRequest.builder()
- Parameters:
listProfilesRequest
- AConsumer
that will call methods onListProfilesRequest.Builder
to create a request.- Returns:
- Result of the ListProfiles operation returned by the service.
- See Also:
-
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 Streamsoftware.amazon.awssdk.services.b2bi.paginators.ListProfilesIterable responses = client.listProfilesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
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 Streamsoftware.amazon.awssdk.services.b2bi.paginators.ListProfilesIterable responses = client.listProfilesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListProfilesRequest.builder()
- Parameters:
listProfilesRequest
- AConsumer
that will call methods onListProfilesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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:
-
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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
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:
-
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 viaListTransformersRequest.builder()
- Parameters:
listTransformersRequest
- AConsumer
that will call methods onListTransformersRequest.Builder
to create a request.- Returns:
- Result of the ListTransformers operation returned by the service.
- See Also:
-
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 Streamsoftware.amazon.awssdk.services.b2bi.paginators.ListTransformersIterable responses = client.listTransformersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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:
-
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 Streamsoftware.amazon.awssdk.services.b2bi.paginators.ListTransformersIterable responses = client.listTransformersPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListTransformersRequest.builder()
- Parameters:
listTransformersRequest
- AConsumer
that will call methods onListTransformersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
startTransformerJob
default StartTransformerJobResponse startTransformerJob(StartTransformerJobRequest startTransformerJobRequest) throws AccessDeniedException, ConflictException, 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.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:
- Result of the StartTransformerJob operation returned by the service.
- See Also:
-
startTransformerJob
default StartTransformerJobResponse startTransformerJob(Consumer<StartTransformerJobRequest.Builder> startTransformerJobRequest) throws AccessDeniedException, ConflictException, 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.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:
- Result of the StartTransformerJob operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, 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:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ValidationException, ResourceNotFoundException, ThrottlingException, 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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
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:
-
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 viaTestConversionRequest.builder()
- Parameters:
testConversionRequest
- AConsumer
that will call methods onTestConversionRequest.Builder
to create a request.- Returns:
- Result of the TestConversion operation returned by the service.
- See Also:
-
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:
-
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 viaTestMappingRequest.builder()
- Parameters:
testMappingRequest
- AConsumer
that will call methods onTestMappingRequest.Builder
to create a request.- Returns:
- Result of the TestMapping operation returned by the service.
- See Also:
-
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:
-
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 viaTestParsingRequest.builder()
- Parameters:
testParsingRequest
- AConsumer
that will call methods onTestParsingRequest.Builder
to create a request.- Returns:
- Result of the TestParsing operation returned by the service.
- See Also:
-
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:
-
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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateCapability
default UpdateCapabilityResponse updateCapability(UpdateCapabilityRequest updateCapabilityRequest) throws AccessDeniedException, ConflictException, 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:
-
updateCapability
default UpdateCapabilityResponse updateCapability(Consumer<UpdateCapabilityRequest.Builder> updateCapabilityRequest) throws AccessDeniedException, ConflictException, 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 viaUpdateCapabilityRequest.builder()
- Parameters:
updateCapabilityRequest
- AConsumer
that will call methods onUpdateCapabilityRequest.Builder
to create a request.- Returns:
- Result of the UpdateCapability operation returned by the service.
- See Also:
-
updatePartnership
default UpdatePartnershipResponse updatePartnership(UpdatePartnershipRequest updatePartnershipRequest) throws AccessDeniedException, ConflictException, ValidationException, ResourceNotFoundException, ThrottlingException, 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:
-
updatePartnership
default UpdatePartnershipResponse updatePartnership(Consumer<UpdatePartnershipRequest.Builder> updatePartnershipRequest) throws AccessDeniedException, ConflictException, ValidationException, ResourceNotFoundException, ThrottlingException, 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 viaUpdatePartnershipRequest.builder()
- Parameters:
updatePartnershipRequest
- AConsumer
that will call methods onUpdatePartnershipRequest.Builder
to create a request.- Returns:
- Result of the UpdatePartnership operation returned by the service.
- See Also:
-
updateProfile
default UpdateProfileResponse updateProfile(UpdateProfileRequest updateProfileRequest) throws AccessDeniedException, ConflictException, ValidationException, ResourceNotFoundException, ThrottlingException, 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:
-
updateProfile
default UpdateProfileResponse updateProfile(Consumer<UpdateProfileRequest.Builder> updateProfileRequest) throws AccessDeniedException, ConflictException, ValidationException, ResourceNotFoundException, ThrottlingException, 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 viaUpdateProfileRequest.builder()
- Parameters:
updateProfileRequest
- AConsumer
that will call methods onUpdateProfileRequest.Builder
to create a request.- Returns:
- Result of the UpdateProfile operation returned by the service.
- See Also:
-
updateTransformer
default UpdateTransformerResponse updateTransformer(UpdateTransformerRequest updateTransformerRequest) throws AccessDeniedException, ConflictException, ValidationException, ResourceNotFoundException, ThrottlingException, 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:
-
updateTransformer
default UpdateTransformerResponse updateTransformer(Consumer<UpdateTransformerRequest.Builder> updateTransformerRequest) throws AccessDeniedException, ConflictException, ValidationException, ResourceNotFoundException, ThrottlingException, 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 viaUpdateTransformerRequest.builder()
- Parameters:
updateTransformerRequest
- AConsumer
that will call methods onUpdateTransformerRequest.Builder
to create a request.- Returns:
- Result of the UpdateTransformer operation returned by the service.
- See Also:
-
waiter
Create an instance ofB2BiWaiter
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
B2BiWaiter
-
create
Create aB2BiClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aB2BiClient
. -
serviceMetadata
-
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
-