com.amazonaws.services.b2bi.AWSB2Bi Maven / Gradle / Ivy
Show all versions of aws-java-sdk-b2bi Show documentation
/*
* 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