com.amazonaws.services.b2bi.AWSB2Bi Maven / Gradle / Ivy
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.b2bi;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.b2bi.model.*;
/**
* Interface for accessing AWS B2BI.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.b2bi.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.
*
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSB2Bi {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "b2bi";
/**
*
* 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.
*
*
* @param createCapabilityRequest
* @return 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.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws 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.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.CreateCapability
* @see AWS API
* Documentation
*/
CreateCapabilityResult createCapability(CreateCapabilityRequest createCapabilityRequest);
/**
*
* 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.
*
*
* @param createPartnershipRequest
* @return 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.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws 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.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.CreatePartnership
* @see AWS API
* Documentation
*/
CreatePartnershipResult createPartnership(CreatePartnershipRequest createPartnershipRequest);
/**
*
* 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.
*
*
* @param createProfileRequest
* @return 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.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws 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.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.CreateProfile
* @see AWS API
* Documentation
*/
CreateProfileResult createProfile(CreateProfileRequest createProfileRequest);
/**
*
* Creates a transformer. A transformer describes how to process the incoming EDI documents and extract the
* necessary information to the output file.
*
*
* @param createTransformerRequest
* @return 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.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws 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.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.CreateTransformer
* @see AWS API
* Documentation
*/
CreateTransformerResult createTransformer(CreateTransformerRequest createTransformerRequest);
/**
*
* Deletes the specified capability. A trading capability contains the information required to transform incoming
* EDI documents into JSON or XML outputs.
*
*
* @param deleteCapabilityRequest
* @return 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.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.DeleteCapability
* @see AWS API
* Documentation
*/
DeleteCapabilityResult deleteCapability(DeleteCapabilityRequest deleteCapabilityRequest);
/**
*
* 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.
*
*
* @param deletePartnershipRequest
* @return 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.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.DeletePartnership
* @see AWS API
* Documentation
*/
DeletePartnershipResult deletePartnership(DeletePartnershipRequest deletePartnershipRequest);
/**
*
* Deletes the specified profile. A profile is the mechanism used to create the concept of a private network.
*
*
* @param deleteProfileRequest
* @return 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.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.DeleteProfile
* @see AWS API
* Documentation
*/
DeleteProfileResult deleteProfile(DeleteProfileRequest deleteProfileRequest);
/**
*
* Deletes the specified transformer. A transformer describes how to process the incoming EDI documents and extract
* the necessary information to the output file.
*
*
* @param deleteTransformerRequest
* @return 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.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.DeleteTransformer
* @see AWS API
* Documentation
*/
DeleteTransformerResult deleteTransformer(DeleteTransformerRequest deleteTransformerRequest);
/**
*
* Retrieves the details for the specified capability. A trading capability contains the information required to
* transform incoming EDI documents into JSON or XML outputs.
*
*
* @param getCapabilityRequest
* @return Result of the GetCapability operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.GetCapability
* @see AWS API
* Documentation
*/
GetCapabilityResult getCapability(GetCapabilityRequest getCapabilityRequest);
/**
*
* 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.
*
*
* @param getPartnershipRequest
* @return Result of the GetPartnership operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.GetPartnership
* @see AWS API
* Documentation
*/
GetPartnershipResult getPartnership(GetPartnershipRequest getPartnershipRequest);
/**
*
* 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.
*
*
* @param getProfileRequest
* @return Result of the GetProfile operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.GetProfile
* @see AWS API
* Documentation
*/
GetProfileResult getProfile(GetProfileRequest getProfileRequest);
/**
*
* Retrieves the details for the transformer specified by the transformer ID. A transformer describes how to process
* the incoming EDI documents and extract the necessary information to the output file.
*
*
* @param getTransformerRequest
* @return Result of the GetTransformer operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.GetTransformer
* @see AWS API
* Documentation
*/
GetTransformerResult getTransformer(GetTransformerRequest getTransformerRequest);
/**
*
* Returns the details of the transformer run, based on the Transformer job ID.
*
*
* @param getTransformerJobRequest
* @return Result of the GetTransformerJob operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.GetTransformerJob
* @see AWS API
* Documentation
*/
GetTransformerJobResult getTransformerJob(GetTransformerJobRequest getTransformerJobRequest);
/**
*
* 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.
*
*
* @param listCapabilitiesRequest
* @return Result of the ListCapabilities operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.ListCapabilities
* @see AWS API
* Documentation
*/
ListCapabilitiesResult listCapabilities(ListCapabilitiesRequest listCapabilitiesRequest);
/**
*
* 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.
*
*
* @param listPartnershipsRequest
* @return Result of the ListPartnerships operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.ListPartnerships
* @see AWS API
* Documentation
*/
ListPartnershipsResult listPartnerships(ListPartnershipsRequest listPartnershipsRequest);
/**
*
* 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.
*
*
* @param listProfilesRequest
* @return Result of the ListProfiles operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.ListProfiles
* @see AWS API
* Documentation
*/
ListProfilesResult listProfiles(ListProfilesRequest listProfilesRequest);
/**
*
* 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.
*
*
* @param listTagsForResourceRequest
* @return 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.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.ListTagsForResource
* @see AWS API
* Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Lists the available transformers. A transformer describes how to process the incoming EDI documents and extract
* the necessary information to the output file.
*
*
* @param listTransformersRequest
* @return Result of the ListTransformers operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.ListTransformers
* @see AWS API
* Documentation
*/
ListTransformersResult listTransformers(ListTransformersRequest listTransformersRequest);
/**
*
* 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.
*
*
* 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.
*
*
* @param startTransformerJobRequest
* @return Result of the StartTransformerJob 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.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.StartTransformerJob
* @see AWS API
* Documentation
*/
StartTransformerJobResult startTransformerJob(StartTransformerJobRequest startTransformerJobRequest);
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return 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.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* 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.
*
*
* @param testMappingRequest
* @return Result of the TestMapping operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.TestMapping
* @see AWS API
* Documentation
*/
TestMappingResult testMapping(TestMappingRequest testMappingRequest);
/**
*
* Parses the input EDI (electronic data interchange) file. The input file has a file size limit of 250 KB.
*
*
* @param testParsingRequest
* @return Result of the TestParsing operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.TestParsing
* @see AWS API
* Documentation
*/
TestParsingResult testParsing(TestParsingRequest testParsingRequest);
/**
*
* 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.
*
*
* @param untagResourceRequest
* @return 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.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* 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.
*
*
* @param updateCapabilityRequest
* @return 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.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws 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.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.UpdateCapability
* @see AWS API
* Documentation
*/
UpdateCapabilityResult updateCapability(UpdateCapabilityRequest updateCapabilityRequest);
/**
*
* 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.
*
*
* @param updatePartnershipRequest
* @return 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.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws 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.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.UpdatePartnership
* @see AWS API
* Documentation
*/
UpdatePartnershipResult updatePartnership(UpdatePartnershipRequest updatePartnershipRequest);
/**
*
* Updates the specified parameters for a profile. A profile is the mechanism used to create the concept of a
* private network.
*
*
* @param updateProfileRequest
* @return 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.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws 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.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.UpdateProfile
* @see AWS API
* Documentation
*/
UpdateProfileResult updateProfile(UpdateProfileRequest updateProfileRequest);
/**
*
* Updates the specified parameters for a transformer. A transformer describes how to process the incoming EDI
* documents and extract the necessary information to the output file.
*
*
* @param updateTransformerRequest
* @return 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.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* Occurs when a B2BI object cannot be validated against a request from another object.
* @throws ThrottlingException
* The request was denied due to throttling: the data speed and rendering may be limited depending on
* various parameters and conditions.
* @throws 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.
* @throws 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.
* @throws InternalServerException
* This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
* @sample AWSB2Bi.UpdateTransformer
* @see AWS API
* Documentation
*/
UpdateTransformerResult updateTransformer(UpdateTransformerRequest updateTransformerRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy