AWSB2Bi (AWS Java SDK for AWS B2B Data Interchange 1.12.610 API)

All Known Subinterfaces:

AWSB2BiAsync

All Known Implementing Classes:

AbstractAWSB2Bi, AbstractAWSB2BiAsync, AWSB2BiAsyncClient, AWSB2BiClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSB2Bi
```
Interface for accessing AWS B2BI.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSB2Bi instead.

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 and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CreateCapabilityResult`	`createCapability(CreateCapabilityRequest createCapabilityRequest)` Instantiates a capability based on the specified parameters.
`CreatePartnershipResult`	`createPartnership(CreatePartnershipRequest createPartnershipRequest)` Creates a partnership between a customer and a trading partner, based on the supplied parameters.
`CreateProfileResult`	`createProfile(CreateProfileRequest createProfileRequest)` Creates a customer profile.
`CreateTransformerResult`	`createTransformer(CreateTransformerRequest createTransformerRequest)` Creates a transformer.
`DeleteCapabilityResult`	`deleteCapability(DeleteCapabilityRequest deleteCapabilityRequest)` Deletes the specified capability.
`DeletePartnershipResult`	`deletePartnership(DeletePartnershipRequest deletePartnershipRequest)` Deletes the specified partnership.
`DeleteProfileResult`	`deleteProfile(DeleteProfileRequest deleteProfileRequest)` Deletes the specified profile.
`DeleteTransformerResult`	`deleteTransformer(DeleteTransformerRequest deleteTransformerRequest)` Deletes the specified transformer.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetCapabilityResult`	`getCapability(GetCapabilityRequest getCapabilityRequest)` Retrieves the details for the specified capability.
`GetPartnershipResult`	`getPartnership(GetPartnershipRequest getPartnershipRequest)` Retrieves the details for a partnership, based on the partner and profile IDs specified.
`GetProfileResult`	`getProfile(GetProfileRequest getProfileRequest)` Retrieves the details for the profile specified by the profile ID.
`GetTransformerResult`	`getTransformer(GetTransformerRequest getTransformerRequest)` Retrieves the details for the transformer specified by the transformer ID.
`GetTransformerJobResult`	`getTransformerJob(GetTransformerJobRequest getTransformerJobRequest)` Returns the details of the transformer run, based on the Transformer job ID.
`ListCapabilitiesResult`	`listCapabilities(ListCapabilitiesRequest listCapabilitiesRequest)` Lists the capabilities associated with your Amazon Web Services account for your current or specified region.
`ListPartnershipsResult`	`listPartnerships(ListPartnershipsRequest listPartnershipsRequest)` Lists the partnerships associated with your Amazon Web Services account for your current or specified region.
`ListProfilesResult`	`listProfiles(ListProfilesRequest listProfilesRequest)` Lists the profiles associated with your Amazon Web Services account for your current or specified region.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
`ListTransformersResult`	`listTransformers(ListTransformersRequest listTransformersRequest)` Lists the available transformers.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartTransformerJobResult`	`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 B2BI Data Interchange.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
`TestMappingResult`	`testMapping(TestMappingRequest testMappingRequest)` Maps the input file according to the provided template file.
`TestParsingResult`	`testParsing(TestParsingRequest testParsingRequest)` Parses the input EDI (electronic data interchange) file.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Detaches a key-value pair from the specified resource, as identified by its Amazon Resource Name (ARN).
`UpdateCapabilityResult`	`updateCapability(UpdateCapabilityRequest updateCapabilityRequest)` Updates some of the parameters for a capability, based on the specified parameters.
`UpdatePartnershipResult`	`updatePartnership(UpdatePartnershipRequest updatePartnershipRequest)` Updates some of the parameters for a partnership between a customer and trading partner.
`UpdateProfileResult`	`updateProfile(UpdateProfileRequest updateProfileRequest)` Updates the specified parameters for a profile.
`UpdateTransformerResult`	`updateTransformer(UpdateTransformerRequest updateTransformerRequest)` Updates the specified parameters for a transformer.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - createCapability
```
CreateCapabilityResult createCapability(CreateCapabilityRequest createCapabilityRequest)
```
    Instantiates a capability based on the specified parameters. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.
    
    Parameters:
    
    createCapabilityRequest -
    
    Returns:
    
    Result of the CreateCapability operation returned by the service.
    
    Throws:
    
    ConflictException - A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ThrottlingException - The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    ServiceQuotaExceededException - Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
    
    InternalServerException - This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
    
    See Also:
    
    AWS API Documentation
  - createPartnership
```
CreatePartnershipResult createPartnership(CreatePartnershipRequest createPartnershipRequest)
```
    Creates a partnership between a customer and a trading partner, based on the supplied parameters. Partnerships link trading partners with your profile and a specific transformer, so that the EDI (electronic data interchange) documents that they upload to Amazon S3 can be processed according to their specifications.
    
    Parameters:
    
    createPartnershipRequest -
    
    Returns:
    
    Result of the CreatePartnership operation returned by the service.
    
    Throws:
    
    ConflictException - A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ThrottlingException - The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    ServiceQuotaExceededException - Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
    
    InternalServerException - This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
    
    See Also:
    
    AWS API Documentation
  - createProfile
```
CreateProfileResult createProfile(CreateProfileRequest createProfileRequest)
```
    Creates a customer profile. You can have up to five customer profiles, each representing a distinct private network. Profiles contain basic information about you and your business.
    
    Parameters:
    
    createProfileRequest -
    
    Returns:
    
    Result of the CreateProfile operation returned by the service.
    
    Throws:
    
    ConflictException - A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ThrottlingException - The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    ServiceQuotaExceededException - Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
    
    InternalServerException - This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
    
    See Also:
    
    AWS API Documentation
  - createTransformer
```
CreateTransformerResult createTransformer(CreateTransformerRequest createTransformerRequest)
```
    Creates a transformer. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.
    
    Parameters:
    
    createTransformerRequest -
    
    Returns:
    
    Result of the CreateTransformer operation returned by the service.
    
    Throws:
    
    ConflictException - A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ThrottlingException - The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    ServiceQuotaExceededException - Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
    
    InternalServerException - This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
    
    See Also:
    
    AWS API Documentation
  - deleteCapability
```
DeleteCapabilityResult deleteCapability(DeleteCapabilityRequest deleteCapabilityRequest)
```
    Deletes the specified capability. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.
    
    Parameters:
    
    deleteCapabilityRequest -
    
    Returns:
    
    Result of the DeleteCapability operation returned by the service.
    
    Throws:
    
    ConflictException - A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ThrottlingException - The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    InternalServerException - This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
    
    See Also:
    
    AWS API Documentation
  - deletePartnership
```
DeletePartnershipResult deletePartnership(DeletePartnershipRequest deletePartnershipRequest)
```
    Deletes the specified partnership. Partnerships link trading partners with your profile and a specific transformer, so that the EDI (electronic data interchange) documents that they upload to Amazon S3 can be processed according to their specifications.
    
    Parameters:
    
    deletePartnershipRequest -
    
    Returns:
    
    Result of the DeletePartnership operation returned by the service.
    
    Throws:
    
    ConflictException - A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ThrottlingException - The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    InternalServerException - This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
    
    See Also:
    
    AWS API Documentation
  - deleteProfile
```
DeleteProfileResult deleteProfile(DeleteProfileRequest deleteProfileRequest)
```
    Deletes the specified profile. Profiles contain basic information about you and your business.
    
    Parameters:
    
    deleteProfileRequest -
    
    Returns:
    
    Result of the DeleteProfile operation returned by the service.
    
    Throws:
    
    ConflictException - A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ThrottlingException - The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    InternalServerException - This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
    
    See Also:
    
    AWS API Documentation
  - deleteTransformer
```
DeleteTransformerResult deleteTransformer(DeleteTransformerRequest deleteTransformerRequest)
```
    Deletes the specified transformer. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.
    
    Parameters:
    
    deleteTransformerRequest -
    
    Returns:
    
    Result of the DeleteTransformer operation returned by the service.
    
    Throws:
    
    ConflictException - A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ThrottlingException - The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    InternalServerException - This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
    
    See Also:
    
    AWS API Documentation
  - getCapability
```
GetCapabilityResult getCapability(GetCapabilityRequest getCapabilityRequest)
```
    Retrieves the details for the specified capability. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.
    
    Parameters:
    
    getCapabilityRequest -
    
    Returns:
    
    Result of the GetCapability operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ThrottlingException - The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    InternalServerException - This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
    
    See Also:
    
    AWS API Documentation
  - getPartnership
```
GetPartnershipResult getPartnership(GetPartnershipRequest getPartnershipRequest)
```
    Retrieves the details for a partnership, based on the partner and profile IDs specified. Partnerships link trading partners with your profile and a specific transformer, so that the EDI (electronic data interchange) documents that they upload to Amazon S3 can be processed according to their specifications.
    
    Parameters:
    
    getPartnershipRequest -
    
    Returns:
    
    Result of the GetPartnership operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ThrottlingException - The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    InternalServerException - This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
    
    See Also:
    
    AWS API Documentation
  - getProfile
```
GetProfileResult getProfile(GetProfileRequest getProfileRequest)
```
    Retrieves the details for the profile specified by the profile ID. Profiles contain basic information about you and your business.
    
    Parameters:
    
    getProfileRequest -
    
    Returns:
    
    Result of the GetProfile operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ThrottlingException - The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    InternalServerException - This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
    
    See Also:
    
    AWS API Documentation
  - getTransformer
```
GetTransformerResult getTransformer(GetTransformerRequest getTransformerRequest)
```
    Retrieves the details for the transformer specified by the transformer ID. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.
    
    Parameters:
    
    getTransformerRequest -
    
    Returns:
    
    Result of the GetTransformer operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ThrottlingException - The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    InternalServerException - This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
    
    See Also:
    
    AWS API Documentation
  - getTransformerJob
```
GetTransformerJobResult getTransformerJob(GetTransformerJobRequest getTransformerJobRequest)
```
    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.
    
    Throws:
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ThrottlingException - The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    InternalServerException - This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
    
    See Also:
    
    AWS API Documentation
  - listCapabilities
```
ListCapabilitiesResult listCapabilities(ListCapabilitiesRequest listCapabilitiesRequest)
```
    Lists the capabilities associated with your Amazon Web Services account for your current or specified region. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.
    
    Parameters:
    
    listCapabilitiesRequest -
    
    Returns:
    
    Result of the ListCapabilities operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPartnerships
```
ListPartnershipsResult listPartnerships(ListPartnershipsRequest listPartnershipsRequest)
```
    Lists the partnerships associated with your Amazon Web Services account for your current or specified region. Partnerships link trading partners with your profile and a specific transformer, so that the EDI (electronic data interchange) documents that they upload to Amazon S3 can be processed according to their specifications.
    
    Parameters:
    
    listPartnershipsRequest -
    
    Returns:
    
    Result of the ListPartnerships operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ThrottlingException - The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    InternalServerException - This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
    
    See Also:
    
    AWS API Documentation
  - listProfiles
```
ListProfilesResult listProfiles(ListProfilesRequest listProfilesRequest)
```
    Lists the profiles associated with your Amazon Web Services account for your current or specified region. Profiles contain basic information about you and your business.
    
    Parameters:
    
    listProfilesRequest -
    
    Returns:
    
    Result of the ListProfiles operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a capability, partnership, profile, or transformer.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    See Also:
    
    AWS API Documentation
  - listTransformers
```
ListTransformersResult listTransformers(ListTransformersRequest listTransformersRequest)
```
    Lists the available transformers. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.
    
    Parameters:
    
    listTransformersRequest -
    
    Returns:
    
    Result of the ListTransformers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startTransformerJob
```
StartTransformerJobResult 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 B2BI Data Interchange.
    
    Parameters:
    
    startTransformerJobRequest -
    
    Returns:
    
    Result of the StartTransformerJob operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ThrottlingException - The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    InternalServerException - This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and other entities.
    
    There is no response returned from this call.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ThrottlingException - The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    See Also:
    
    AWS API Documentation
  - testMapping
```
TestMappingResult testMapping(TestMappingRequest testMappingRequest)
```
    Maps the input file according to the provided template file.
    
    Parameters:
    
    testMappingRequest -
    
    Returns:
    
    Result of the TestMapping operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ThrottlingException - The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    InternalServerException - This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
    
    See Also:
    
    AWS API Documentation
  - testParsing
```
TestParsingResult testParsing(TestParsingRequest testParsingRequest)
```
    Parses the input EDI (electronic data interchange) file.
    
    Parameters:
    
    testParsingRequest -
    
    Returns:
    
    Result of the TestParsing operation returned by the service.
    
    Throws:
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ThrottlingException - The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    InternalServerException - This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Detaches a key-value pair from the specified resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and other entities.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    See Also:
    
    AWS API Documentation
  - updateCapability
```
UpdateCapabilityResult updateCapability(UpdateCapabilityRequest updateCapabilityRequest)
```
    Updates some of the parameters for a capability, based on the specified parameters. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.
    
    Parameters:
    
    updateCapabilityRequest -
    
    Returns:
    
    Result of the UpdateCapability operation returned by the service.
    
    Throws:
    
    ConflictException - A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ThrottlingException - The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    ServiceQuotaExceededException - Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
    
    InternalServerException - This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
    
    See Also:
    
    AWS API Documentation
  - updatePartnership
```
UpdatePartnershipResult updatePartnership(UpdatePartnershipRequest updatePartnershipRequest)
```
    Updates some of the parameters for a partnership between a customer and trading partner. Partnerships link trading partners with your profile and a specific transformer, so that the EDI (electronic data interchange) documents that they upload to Amazon S3 can be processed according to their specifications.
    
    Parameters:
    
    updatePartnershipRequest -
    
    Returns:
    
    Result of the UpdatePartnership operation returned by the service.
    
    Throws:
    
    ConflictException - A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ThrottlingException - The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    ServiceQuotaExceededException - Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
    
    InternalServerException - This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
    
    See Also:
    
    AWS API Documentation
  - updateProfile
```
UpdateProfileResult updateProfile(UpdateProfileRequest updateProfileRequest)
```
    Updates the specified parameters for a profile. Profiles contain basic information about you and your business.
    
    Parameters:
    
    updateProfileRequest -
    
    Returns:
    
    Result of the UpdateProfile operation returned by the service.
    
    Throws:
    
    ConflictException - A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ThrottlingException - The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    ServiceQuotaExceededException - Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
    
    InternalServerException - This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
    
    See Also:
    
    AWS API Documentation
  - updateTransformer
```
UpdateTransformerResult updateTransformer(UpdateTransformerRequest updateTransformerRequest)
```
    Updates the specified parameters for a transformer. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.
    
    Parameters:
    
    updateTransformerRequest -
    
    Returns:
    
    Result of the UpdateTransformer operation returned by the service.
    
    Throws:
    
    ConflictException - A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
    
    AccessDeniedException - You do not have sufficient access to perform this action.
    
    ValidationException - Occurs when a B2BI object cannot be validated against a request from another object.
    
    ThrottlingException - The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
    
    ResourceNotFoundException - Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
    
    ServiceQuotaExceededException - Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
    
    InternalServerException - This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Interface AWSB2Bi

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createCapability

createPartnership

createProfile

createTransformer

deleteCapability

deletePartnership

deleteProfile

deleteTransformer

getCapability

getPartnership

getProfile

getTransformer

getTransformerJob

listCapabilities

listPartnerships

listProfiles

listTagsForResource

listTransformers

startTransformerJob

tagResource

testMapping

testParsing

untagResource

updateCapability

updatePartnership

updateProfile

updateTransformer

shutdown

getCachedResponseMetadata