b2bi/aws.sdk.kotlin.services.b2bi

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

createCapability

inline suspend fun B2BiClient.createCapability(crossinline block: CreateCapabilityRequest.Builder.() -> Unit): CreateCapabilityResponse

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.

createPartnership

inline suspend fun B2BiClient.createPartnership(crossinline block: CreatePartnershipRequest.Builder.() -> Unit): CreatePartnershipResponse

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.

createProfile

inline suspend fun B2BiClient.createProfile(crossinline block: CreateProfileRequest.Builder.() -> Unit): CreateProfileResponse

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.

createTransformer

inline suspend fun B2BiClient.createTransformer(crossinline block: CreateTransformerRequest.Builder.() -> Unit): CreateTransformerResponse

Creates a transformer. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.

deleteCapability

inline suspend fun B2BiClient.deleteCapability(crossinline block: DeleteCapabilityRequest.Builder.() -> Unit): DeleteCapabilityResponse

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

deletePartnership

inline suspend fun B2BiClient.deletePartnership(crossinline block: DeletePartnershipRequest.Builder.() -> Unit): DeletePartnershipResponse

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.

deleteProfile

inline suspend fun B2BiClient.deleteProfile(crossinline block: DeleteProfileRequest.Builder.() -> Unit): DeleteProfileResponse

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

deleteTransformer

inline suspend fun B2BiClient.deleteTransformer(crossinline block: DeleteTransformerRequest.Builder.() -> Unit): DeleteTransformerResponse

Deletes the specified transformer. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.

getCapability

inline suspend fun B2BiClient.getCapability(crossinline block: GetCapabilityRequest.Builder.() -> Unit): GetCapabilityResponse

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

getPartnership

inline suspend fun B2BiClient.getPartnership(crossinline block: GetPartnershipRequest.Builder.() -> Unit): GetPartnershipResponse

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.

getProfile

inline suspend fun B2BiClient.getProfile(crossinline block: GetProfileRequest.Builder.() -> Unit): GetProfileResponse

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.

getTransformer

inline suspend fun B2BiClient.getTransformer(crossinline block: GetTransformerRequest.Builder.() -> Unit): GetTransformerResponse

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.

getTransformerJob

inline suspend fun B2BiClient.getTransformerJob(crossinline block: GetTransformerJobRequest.Builder.() -> Unit): GetTransformerJobResponse

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

listCapabilities

inline suspend fun B2BiClient.listCapabilities(crossinline block: ListCapabilitiesRequest.Builder.() -> Unit): ListCapabilitiesResponse

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.

listPartnerships

inline suspend fun B2BiClient.listPartnerships(crossinline block: ListPartnershipsRequest.Builder.() -> Unit): ListPartnershipsResponse

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.

listProfiles

inline suspend fun B2BiClient.listProfiles(crossinline block: ListProfilesRequest.Builder.() -> Unit): ListProfilesResponse

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.

listTagsForResource

inline suspend fun B2BiClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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.

listTransformers

inline suspend fun B2BiClient.listTransformers(crossinline block: ListTransformersRequest.Builder.() -> Unit): ListTransformersResponse

Lists the available transformers. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.

startTransformerJob

inline suspend fun B2BiClient.startTransformerJob(crossinline block: StartTransformerJobRequest.Builder.() -> Unit): StartTransformerJobResponse

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.

tagResource

inline suspend fun B2BiClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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.

testMapping

inline suspend fun B2BiClient.testMapping(crossinline block: TestMappingRequest.Builder.() -> Unit): TestMappingResponse

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.

testParsing

inline suspend fun B2BiClient.testParsing(crossinline block: TestParsingRequest.Builder.() -> Unit): TestParsingResponse

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

untagResource

inline suspend fun B2BiClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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.

updateCapability

inline suspend fun B2BiClient.updateCapability(crossinline block: UpdateCapabilityRequest.Builder.() -> Unit): UpdateCapabilityResponse

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.

updatePartnership

inline suspend fun B2BiClient.updatePartnership(crossinline block: UpdatePartnershipRequest.Builder.() -> Unit): UpdatePartnershipResponse

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.

updateProfile

inline suspend fun B2BiClient.updateProfile(crossinline block: UpdateProfileRequest.Builder.() -> Unit): UpdateProfileResponse

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

updateTransformer

inline suspend fun B2BiClient.updateTransformer(crossinline block: UpdateTransformerRequest.Builder.() -> Unit): UpdateTransformerResponse

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.

withConfig

fun B2BiClient.withConfig(block: B2BiClient.Config.Builder.() -> Unit): B2BiClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.