AWS SDK for PHP 3.x (original) (raw)

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.

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample CreateCapability call

result=result = result=client->createCapability([ 'name' => 'b2biexample', 'type' => 'edi', 'clientToken' => 'foo', 'configuration' => [ 'edi' => [ 'type' => [ 'x12Details' => [ 'version' => 'VERSION_4010', 'transactionSet' => 'X12_110', ], ], 'inputLocation' => [ 'key' => 'input/', 'bucketName' => 'test-bucket', ], 'outputLocation' => [ 'key' => 'output/', 'bucketName' => 'test-bucket', ], 'transformerId' => 'tr-9a893cf536df4658b', ], ], 'instructionsDocuments' => [ [ 'key' => 'instructiondoc.txt', 'bucketName' => 'test-bucket', ], ], 'tags' => [ [ 'Key' => 'capabilityKey1', 'Value' => 'capabilityValue1', ], ], ]);

Result syntax:

[ 'name' => 'b2biexample', 'type' => 'edi', 'capabilityArn' => 'arn:aws:b2bi:us-west-2:123456789012:capability/ca-963a8121e4fc4e348', 'capabilityId' => 'ca-963a8121e4fc4e348', 'configuration' => [ 'edi' => [ 'type' => [ 'x12Details' => [ 'version' => 'VERSION_4010', 'transactionSet' => 'X12_110', ], ], 'inputLocation' => [ 'key' => 'input/', 'bucketName' => 'test-bucket', ], 'outputLocation' => [ 'key' => 'output/', 'bucketName' => 'test-bucket', ], 'transformerId' => 'tr-9a893cf536df4658b', ], ], 'createdAt' => , 'instructionsDocuments' => [ [ 'key' => 'instructiondoc.txt', 'bucketName' => 'test-bucket', ], ], ]

CreatePartnership

result=result = result=client->createPartnership([/* ... /]); promise=promise = promise=client->createPartnershipAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->createPartnership([ 'capabilities' => ['', ...], // REQUIRED 'capabilityOptions' => [ 'outboundEdi' => [ 'x12' => [ 'common' => [ 'delimiters' => [ 'componentSeparator' => '', 'dataElementSeparator' => '', 'segmentTerminator' => '', ], 'functionalGroupHeaders' => [ 'applicationReceiverCode' => '', 'applicationSenderCode' => '', 'responsibleAgencyCode' => '', ], 'interchangeControlHeaders' => [ 'acknowledgmentRequestedCode' => '', 'receiverId' => '', 'receiverIdQualifier' => '', 'repetitionSeparator' => '', 'senderId' => '', 'senderIdQualifier' => '', 'usageIndicatorCode' => '', ], 'validateEdi' => true || false, ], ], ], ], 'clientToken' => '', 'email' => '', // REQUIRED 'name' => '', // REQUIRED 'phone' => '', 'profileId' => '', // REQUIRED 'tags' => [ [ 'Key' => '', // REQUIRED 'Value' => '', // REQUIRED ], // ... ], ]);

Parameter Details

Members

capabilities

Required: Yes

Type: Array of strings

Specifies a list of the capabilities associated with this partnership.

capabilityOptions

Type: CapabilityOptions structure

Specify the structure that contains the details for the associated capabilities.

clientToken

Reserved for future use.

email

Required: Yes

Type: string

Specifies the email address associated with this trading partner.

name

Required: Yes

Type: string

Specifies a descriptive name for the partnership.

phone

Specifies the phone number associated with the partnership.

profileId

Required: Yes

Type: string

Specifies the unique, system-generated identifier for the profile connected to this partnership.

tags

Type: Array of Tag structures

Result Syntax

[ 'capabilities' => ['', ...], 'capabilityOptions' => [ 'outboundEdi' => [ 'x12' => [ 'common' => [ 'delimiters' => [ 'componentSeparator' => '', 'dataElementSeparator' => '', 'segmentTerminator' => '', ], 'functionalGroupHeaders' => [ 'applicationReceiverCode' => '', 'applicationSenderCode' => '', 'responsibleAgencyCode' => '', ], 'interchangeControlHeaders' => [ 'acknowledgmentRequestedCode' => '', 'receiverId' => '', 'receiverIdQualifier' => '', 'repetitionSeparator' => '', 'senderId' => '', 'senderIdQualifier' => '', 'usageIndicatorCode' => '', ], 'validateEdi' => true || false, ], ], ], ], 'createdAt' => , 'email' => '', 'name' => '', 'partnershipArn' => '', 'partnershipId' => '', 'phone' => '', 'profileId' => '', 'tradingPartnerId' => '', ]

Result Details

Members

capabilities

Returns one or more capabilities associated with this partnership.

capabilityOptions

Type: CapabilityOptions structure

Returns the structure that contains the details for the associated capabilities.

createdAt

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns a timestamp for creation date and time of the partnership.

email

Returns the email address associated with this trading partner.

name

Returns a descriptive name for the partnership.

partnershipArn

Required: Yes

Type: string

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

partnershipId

Required: Yes

Type: string

Returns the unique, system-generated identifier for a partnership.

phone

Returns the phone number associated with the partnership.

profileId

Required: Yes

Type: string

Returns the unique, system-generated identifier for the profile connected to this partnership.

tradingPartnerId

Returns the unique, system-generated identifier for a trading partner.

Errors

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.

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample CreatePartnership call

result=result = result=client->createPartnership([ 'name' => 'b2bipartner', 'capabilities' => [ 'ca-963a8121e4fc4e348', ], 'clientToken' => 'foo', 'email' => 'john@example.com', 'phone' => '5555555555', 'profileId' => 'p-60fbc37c87f04fce9', 'tags' => [ [ 'Key' => 'sampleKey1', 'Value' => 'sampleValue1', ], ], ]);

Result syntax:

[ 'name' => 'b2bipartner', 'capabilities' => [ 'ca-963a8121e4fc4e348', ], 'createdAt' => , 'email' => 'john@example.com', 'partnershipArn' => 'arn:aws:b2bi:us-west-2:123456789012:partnership/ps-60fbc37c87f04fce9', 'partnershipId' => 'ps-219fa02f5b4242af8', 'phone' => '5555555555', 'profileId' => 'p-60fbc37c87f04fce9', 'tradingPartnerId' => 'tp-2a17ca447f6f4a8a8', ]

CreateProfile

result=result = result=client->createProfile([/* ... /]); promise=promise = promise=client->createProfileAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->createProfile([ 'businessName' => '', // REQUIRED 'clientToken' => '', 'email' => '', 'logging' => 'ENABLED|DISABLED', // REQUIRED 'name' => '', // REQUIRED 'phone' => '', // REQUIRED 'tags' => [ [ 'Key' => '', // REQUIRED 'Value' => '', // REQUIRED ], // ... ], ]);

Parameter Details

Members

businessName

Required: Yes

Type: string

Specifies the name for the business associated with this profile.

clientToken

Reserved for future use.

email

Specifies the email address associated with this customer profile.

logging

Required: Yes

Type: string

Specifies whether or not logging is enabled for this profile.

name

Required: Yes

Type: string

Specifies the name of the profile.

phone

Required: Yes

Type: string

Specifies the phone number associated with the profile.

tags

Type: Array of Tag structures

Result Syntax

[ 'businessName' => '', 'createdAt' => , 'email' => '', 'logGroupName' => '', 'logging' => 'ENABLED|DISABLED', 'name' => '', 'phone' => '', 'profileArn' => '', 'profileId' => '', ]

Result Details

Members

businessName

Required: Yes

Type: string

Returns the name for the business associated with this profile.

createdAt

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns a timestamp representing the time the profile was created.

email

Returns the email address associated with this customer profile.

logGroupName

Returns the name of the logging group.

logging

Returns whether or not logging is turned on for this profile.

name

Required: Yes

Type: string

Returns the name of the profile, used to identify it.

phone

Required: Yes

Type: string

Returns the phone number associated with the profile.

profileArn

Required: Yes

Type: string

Returns an Amazon Resource Name (ARN) for the profile.

profileId

Required: Yes

Type: string

Returns the unique, system-generated identifier for the profile.

Errors

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.

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample CreateProfile call

result=result = result=client->createProfile([ 'name' => 'Shipping Profile', 'businessName' => 'John's Shipping', 'clientToken' => 'foo', 'email' => 'john@example.com', 'logging' => 'ENABLED', 'phone' => '5555555555', 'tags' => [ [ 'Key' => 'sampleKey', 'Value' => 'sampleValue', ], ], ]);

Result syntax:

[ 'name' => 'Shipping Profile', 'businessName' => 'John's Trucking', 'createdAt' => , 'email' => 'john@example.com', 'logGroupName' => 'b2bi/p-60fbc37c87f04fce9-Logs', 'logging' => 'ENABLED', 'phone' => '5555555555', 'profileArn' => 'arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9', 'profileId' => 'p-60fbc37c87f04fce9', ]

CreateStarterMappingTemplate

result=result = result=client->createStarterMappingTemplate([/* ... /]); promise=promise = promise=client->createStarterMappingTemplateAsync([/ ... */]);

Amazon Web Services B2B Data Interchange uses a mapping template in JSONata or XSLT format to transform a customer input file into a JSON or XML file that can be converted to EDI.

If you provide a sample EDI file with the same structure as the EDI files that you wish to generate, then the service can generate a mapping template. The starter template contains placeholder values which you can replace with JSONata or XSLT expressions to take data from your input file and insert it into the JSON or XML file that is used to generate the EDI.

If you do not provide a sample EDI file, then the service can generate a mapping template based on the EDI settings in the templateDetails parameter.

Currently, we only support generating a template that can generate the input to produce an Outbound X12 EDI file.

Parameter Syntax

result=result = result=client->createStarterMappingTemplate([ 'mappingType' => 'JSONATA|XSLT', // REQUIRED 'outputSampleLocation' => [ 'bucketName' => '', 'key' => '', ], 'templateDetails' => [ // REQUIRED 'x12' => [ 'transactionSet' => 'X12_100|X12_101|X12_102|X12_103|X12_104|X12_105|X12_106|X12_107|X12_108|X12_109|X12_110|X12_111|X12_112|X12_113|X12_120|X12_121|X12_124|X12_125|X12_126|X12_127|X12_128|X12_129|X12_130|X12_131|X12_132|X12_133|X12_135|X12_138|X12_139|X12_140|X12_141|X12_142|X12_143|X12_144|X12_146|X12_147|X12_148|X12_149|X12_150|X12_151|X12_152|X12_153|X12_154|X12_155|X12_157|X12_158|X12_159|X12_160|X12_161|X12_163|X12_170|X12_175|X12_176|X12_179|X12_180|X12_185|X12_186|X12_187|X12_188|X12_189|X12_190|X12_191|X12_194|X12_195|X12_196|X12_197|X12_198|X12_199|X12_200|X12_201|X12_202|X12_203|X12_204|X12_205|X12_206|X12_210|X12_211|X12_212|X12_213|X12_214|X12_215|X12_216|X12_217|X12_218|X12_219|X12_220|X12_222|X12_223|X12_224|X12_225|X12_227|X12_228|X12_240|X12_242|X12_244|X12_245|X12_248|X12_249|X12_250|X12_251|X12_252|X12_255|X12_256|X12_259|X12_260|X12_261|X12_262|X12_263|X12_264|X12_265|X12_266|X12_267|X12_268|X12_269|X12_270|X12_271|X12_272|X12_273|X12_274|X12_275|X12_276|X12_277|X12_278|X12_280|X12_283|X12_284|X12_285|X12_286|X12_288|X12_290|X12_300|X12_301|X12_303|X12_304|X12_309|X12_310|X12_311|X12_312|X12_313|X12_315|X12_317|X12_319|X12_322|X12_323|X12_324|X12_325|X12_326|X12_350|X12_352|X12_353|X12_354|X12_355|X12_356|X12_357|X12_358|X12_361|X12_362|X12_404|X12_410|X12_412|X12_414|X12_417|X12_418|X12_419|X12_420|X12_421|X12_422|X12_423|X12_424|X12_425|X12_426|X12_429|X12_431|X12_432|X12_433|X12_434|X12_435|X12_436|X12_437|X12_440|X12_451|X12_452|X12_453|X12_455|X12_456|X12_460|X12_463|X12_466|X12_468|X12_470|X12_475|X12_485|X12_486|X12_490|X12_492|X12_494|X12_500|X12_501|X12_503|X12_504|X12_511|X12_517|X12_521|X12_527|X12_536|X12_540|X12_561|X12_567|X12_568|X12_601|X12_602|X12_620|X12_625|X12_650|X12_715|X12_753|X12_754|X12_805|X12_806|X12_810|X12_811|X12_812|X12_813|X12_814|X12_815|X12_816|X12_818|X12_819|X12_820|X12_821|X12_822|X12_823|X12_824|X12_826|X12_827|X12_828|X12_829|X12_830|X12_831|X12_832|X12_833|X12_834|X12_835|X12_836|X12_837|X12_838|X12_839|X12_840|X12_841|X12_842|X12_843|X12_844|X12_845|X12_846|X12_847|X12_848|X12_849|X12_850|X12_851|X12_852|X12_853|X12_854|X12_855|X12_856|X12_857|X12_858|X12_859|X12_860|X12_861|X12_862|X12_863|X12_864|X12_865|X12_866|X12_867|X12_868|X12_869|X12_870|X12_871|X12_872|X12_873|X12_874|X12_875|X12_876|X12_877|X12_878|X12_879|X12_880|X12_881|X12_882|X12_883|X12_884|X12_885|X12_886|X12_887|X12_888|X12_889|X12_891|X12_893|X12_894|X12_895|X12_896|X12_920|X12_924|X12_925|X12_926|X12_928|X12_940|X12_943|X12_944|X12_945|X12_947|X12_980|X12_990|X12_993|X12_996|X12_997|X12_998|X12_999|X12_270_X279|X12_271_X279|X12_275_X210|X12_275_X211|X12_276_X212|X12_277_X212|X12_277_X214|X12_277_X364|X12_278_X217|X12_820_X218|X12_820_X306|X12_824_X186|X12_834_X220|X12_834_X307|X12_834_X318|X12_835_X221|X12_837_X222|X12_837_X223|X12_837_X224|X12_837_X291|X12_837_X292|X12_837_X298|X12_999_X231', 'version' => 'VERSION_4010|VERSION_4030|VERSION_4050|VERSION_4060|VERSION_5010|VERSION_5010_HIPAA', ], ], ]);

Parameter Details

Members

mappingType

Required: Yes

Type: string

Specify the format for the mapping template: either JSONATA or XSLT.

outputSampleLocation

Type: S3Location structure

Specify the location of the sample EDI file that is used to generate the mapping template.

templateDetails

Required: Yes

Type: TemplateDetails structure

Describes the details needed for generating the template. Specify the X12 transaction set and version for which the template is used: currently, we only support X12.

Result Syntax

[ 'mappingTemplate' => '', ]

Result Details

Members

mappingTemplate

Required: Yes

Type: string

Returns a string that represents the mapping template.

Errors

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample CreateStarterMappingTemplate call

result=result = result=client->createStarterMappingTemplate([ 'mappingType' => 'JSONATA', 'outputSampleLocation' => [ 'key' => 'output-sample-key', 'bucketName' => 'output-sample-bucket', ], 'templateDetails' => [ 'x12' => [ 'version' => 'VERSION_4010', 'transactionSet' => 'X12_110', ], ], ]);

Result syntax:

[ 'mappingTemplate' => 'Example Mapping Template', ]

CreateTransformer

result=result = result=client->createTransformer([/* ... /]); promise=promise = promise=client->createTransformerAsync([/ ... */]);

Creates a transformer. Amazon Web Services B2B Data Interchange currently supports two scenarios:

Inbound EDI: the Amazon Web Services customer receives an EDI file from their trading partner. Amazon Web Services B2B Data Interchange converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer, in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires.
Outbound EDI: the Amazon Web Services customer has a JSON or XML file containing data that they wish to use in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.

The following fields are provided for backwards compatibility only: fileFormat, mappingTemplate, ediType, and sampleDocument.

Use the mapping data type in place of mappingTemplate and fileFormat
Use the sampleDocuments data type in place of sampleDocument
Use either the inputConversion or outputConversion in place of ediType

Parameter Syntax

result=result = result=client->createTransformer([ 'clientToken' => '', 'ediType' => [ 'x12Details' => [ 'transactionSet' => 'X12_100|X12_101|X12_102|X12_103|X12_104|X12_105|X12_106|X12_107|X12_108|X12_109|X12_110|X12_111|X12_112|X12_113|X12_120|X12_121|X12_124|X12_125|X12_126|X12_127|X12_128|X12_129|X12_130|X12_131|X12_132|X12_133|X12_135|X12_138|X12_139|X12_140|X12_141|X12_142|X12_143|X12_144|X12_146|X12_147|X12_148|X12_149|X12_150|X12_151|X12_152|X12_153|X12_154|X12_155|X12_157|X12_158|X12_159|X12_160|X12_161|X12_163|X12_170|X12_175|X12_176|X12_179|X12_180|X12_185|X12_186|X12_187|X12_188|X12_189|X12_190|X12_191|X12_194|X12_195|X12_196|X12_197|X12_198|X12_199|X12_200|X12_201|X12_202|X12_203|X12_204|X12_205|X12_206|X12_210|X12_211|X12_212|X12_213|X12_214|X12_215|X12_216|X12_217|X12_218|X12_219|X12_220|X12_222|X12_223|X12_224|X12_225|X12_227|X12_228|X12_240|X12_242|X12_244|X12_245|X12_248|X12_249|X12_250|X12_251|X12_252|X12_255|X12_256|X12_259|X12_260|X12_261|X12_262|X12_263|X12_264|X12_265|X12_266|X12_267|X12_268|X12_269|X12_270|X12_271|X12_272|X12_273|X12_274|X12_275|X12_276|X12_277|X12_278|X12_280|X12_283|X12_284|X12_285|X12_286|X12_288|X12_290|X12_300|X12_301|X12_303|X12_304|X12_309|X12_310|X12_311|X12_312|X12_313|X12_315|X12_317|X12_319|X12_322|X12_323|X12_324|X12_325|X12_326|X12_350|X12_352|X12_353|X12_354|X12_355|X12_356|X12_357|X12_358|X12_361|X12_362|X12_404|X12_410|X12_412|X12_414|X12_417|X12_418|X12_419|X12_420|X12_421|X12_422|X12_423|X12_424|X12_425|X12_426|X12_429|X12_431|X12_432|X12_433|X12_434|X12_435|X12_436|X12_437|X12_440|X12_451|X12_452|X12_453|X12_455|X12_456|X12_460|X12_463|X12_466|X12_468|X12_470|X12_475|X12_485|X12_486|X12_490|X12_492|X12_494|X12_500|X12_501|X12_503|X12_504|X12_511|X12_517|X12_521|X12_527|X12_536|X12_540|X12_561|X12_567|X12_568|X12_601|X12_602|X12_620|X12_625|X12_650|X12_715|X12_753|X12_754|X12_805|X12_806|X12_810|X12_811|X12_812|X12_813|X12_814|X12_815|X12_816|X12_818|X12_819|X12_820|X12_821|X12_822|X12_823|X12_824|X12_826|X12_827|X12_828|X12_829|X12_830|X12_831|X12_832|X12_833|X12_834|X12_835|X12_836|X12_837|X12_838|X12_839|X12_840|X12_841|X12_842|X12_843|X12_844|X12_845|X12_846|X12_847|X12_848|X12_849|X12_850|X12_851|X12_852|X12_853|X12_854|X12_855|X12_856|X12_857|X12_858|X12_859|X12_860|X12_861|X12_862|X12_863|X12_864|X12_865|X12_866|X12_867|X12_868|X12_869|X12_870|X12_871|X12_872|X12_873|X12_874|X12_875|X12_876|X12_877|X12_878|X12_879|X12_880|X12_881|X12_882|X12_883|X12_884|X12_885|X12_886|X12_887|X12_888|X12_889|X12_891|X12_893|X12_894|X12_895|X12_896|X12_920|X12_924|X12_925|X12_926|X12_928|X12_940|X12_943|X12_944|X12_945|X12_947|X12_980|X12_990|X12_993|X12_996|X12_997|X12_998|X12_999|X12_270_X279|X12_271_X279|X12_275_X210|X12_275_X211|X12_276_X212|X12_277_X212|X12_277_X214|X12_277_X364|X12_278_X217|X12_820_X218|X12_820_X306|X12_824_X186|X12_834_X220|X12_834_X307|X12_834_X318|X12_835_X221|X12_837_X222|X12_837_X223|X12_837_X224|X12_837_X291|X12_837_X292|X12_837_X298|X12_999_X231', 'version' => 'VERSION_4010|VERSION_4030|VERSION_4050|VERSION_4060|VERSION_5010|VERSION_5010_HIPAA', ], ], 'fileFormat' => 'XML|JSON|NOT_USED', 'inputConversion' => [ 'formatOptions' => [ 'x12' => [ 'transactionSet' => 'X12_100|X12_101|X12_102|X12_103|X12_104|X12_105|X12_106|X12_107|X12_108|X12_109|X12_110|X12_111|X12_112|X12_113|X12_120|X12_121|X12_124|X12_125|X12_126|X12_127|X12_128|X12_129|X12_130|X12_131|X12_132|X12_133|X12_135|X12_138|X12_139|X12_140|X12_141|X12_142|X12_143|X12_144|X12_146|X12_147|X12_148|X12_149|X12_150|X12_151|X12_152|X12_153|X12_154|X12_155|X12_157|X12_158|X12_159|X12_160|X12_161|X12_163|X12_170|X12_175|X12_176|X12_179|X12_180|X12_185|X12_186|X12_187|X12_188|X12_189|X12_190|X12_191|X12_194|X12_195|X12_196|X12_197|X12_198|X12_199|X12_200|X12_201|X12_202|X12_203|X12_204|X12_205|X12_206|X12_210|X12_211|X12_212|X12_213|X12_214|X12_215|X12_216|X12_217|X12_218|X12_219|X12_220|X12_222|X12_223|X12_224|X12_225|X12_227|X12_228|X12_240|X12_242|X12_244|X12_245|X12_248|X12_249|X12_250|X12_251|X12_252|X12_255|X12_256|X12_259|X12_260|X12_261|X12_262|X12_263|X12_264|X12_265|X12_266|X12_267|X12_268|X12_269|X12_270|X12_271|X12_272|X12_273|X12_274|X12_275|X12_276|X12_277|X12_278|X12_280|X12_283|X12_284|X12_285|X12_286|X12_288|X12_290|X12_300|X12_301|X12_303|X12_304|X12_309|X12_310|X12_311|X12_312|X12_313|X12_315|X12_317|X12_319|X12_322|X12_323|X12_324|X12_325|X12_326|X12_350|X12_352|X12_353|X12_354|X12_355|X12_356|X12_357|X12_358|X12_361|X12_362|X12_404|X12_410|X12_412|X12_414|X12_417|X12_418|X12_419|X12_420|X12_421|X12_422|X12_423|X12_424|X12_425|X12_426|X12_429|X12_431|X12_432|X12_433|X12_434|X12_435|X12_436|X12_437|X12_440|X12_451|X12_452|X12_453|X12_455|X12_456|X12_460|X12_463|X12_466|X12_468|X12_470|X12_475|X12_485|X12_486|X12_490|X12_492|X12_494|X12_500|X12_501|X12_503|X12_504|X12_511|X12_517|X12_521|X12_527|X12_536|X12_540|X12_561|X12_567|X12_568|X12_601|X12_602|X12_620|X12_625|X12_650|X12_715|X12_753|X12_754|X12_805|X12_806|X12_810|X12_811|X12_812|X12_813|X12_814|X12_815|X12_816|X12_818|X12_819|X12_820|X12_821|X12_822|X12_823|X12_824|X12_826|X12_827|X12_828|X12_829|X12_830|X12_831|X12_832|X12_833|X12_834|X12_835|X12_836|X12_837|X12_838|X12_839|X12_840|X12_841|X12_842|X12_843|X12_844|X12_845|X12_846|X12_847|X12_848|X12_849|X12_850|X12_851|X12_852|X12_853|X12_854|X12_855|X12_856|X12_857|X12_858|X12_859|X12_860|X12_861|X12_862|X12_863|X12_864|X12_865|X12_866|X12_867|X12_868|X12_869|X12_870|X12_871|X12_872|X12_873|X12_874|X12_875|X12_876|X12_877|X12_878|X12_879|X12_880|X12_881|X12_882|X12_883|X12_884|X12_885|X12_886|X12_887|X12_888|X12_889|X12_891|X12_893|X12_894|X12_895|X12_896|X12_920|X12_924|X12_925|X12_926|X12_928|X12_940|X12_943|X12_944|X12_945|X12_947|X12_980|X12_990|X12_993|X12_996|X12_997|X12_998|X12_999|X12_270_X279|X12_271_X279|X12_275_X210|X12_275_X211|X12_276_X212|X12_277_X212|X12_277_X214|X12_277_X364|X12_278_X217|X12_820_X218|X12_820_X306|X12_824_X186|X12_834_X220|X12_834_X307|X12_834_X318|X12_835_X221|X12_837_X222|X12_837_X223|X12_837_X224|X12_837_X291|X12_837_X292|X12_837_X298|X12_999_X231', 'version' => 'VERSION_4010|VERSION_4030|VERSION_4050|VERSION_4060|VERSION_5010|VERSION_5010_HIPAA', ], ], 'fromFormat' => 'X12', // REQUIRED ], 'mapping' => [ 'template' => '', 'templateLanguage' => 'XSLT|JSONATA', // REQUIRED ], 'mappingTemplate' => '', 'name' => '', // REQUIRED 'outputConversion' => [ 'formatOptions' => [ 'x12' => [ 'transactionSet' => 'X12_100|X12_101|X12_102|X12_103|X12_104|X12_105|X12_106|X12_107|X12_108|X12_109|X12_110|X12_111|X12_112|X12_113|X12_120|X12_121|X12_124|X12_125|X12_126|X12_127|X12_128|X12_129|X12_130|X12_131|X12_132|X12_133|X12_135|X12_138|X12_139|X12_140|X12_141|X12_142|X12_143|X12_144|X12_146|X12_147|X12_148|X12_149|X12_150|X12_151|X12_152|X12_153|X12_154|X12_155|X12_157|X12_158|X12_159|X12_160|X12_161|X12_163|X12_170|X12_175|X12_176|X12_179|X12_180|X12_185|X12_186|X12_187|X12_188|X12_189|X12_190|X12_191|X12_194|X12_195|X12_196|X12_197|X12_198|X12_199|X12_200|X12_201|X12_202|X12_203|X12_204|X12_205|X12_206|X12_210|X12_211|X12_212|X12_213|X12_214|X12_215|X12_216|X12_217|X12_218|X12_219|X12_220|X12_222|X12_223|X12_224|X12_225|X12_227|X12_228|X12_240|X12_242|X12_244|X12_245|X12_248|X12_249|X12_250|X12_251|X12_252|X12_255|X12_256|X12_259|X12_260|X12_261|X12_262|X12_263|X12_264|X12_265|X12_266|X12_267|X12_268|X12_269|X12_270|X12_271|X12_272|X12_273|X12_274|X12_275|X12_276|X12_277|X12_278|X12_280|X12_283|X12_284|X12_285|X12_286|X12_288|X12_290|X12_300|X12_301|X12_303|X12_304|X12_309|X12_310|X12_311|X12_312|X12_313|X12_315|X12_317|X12_319|X12_322|X12_323|X12_324|X12_325|X12_326|X12_350|X12_352|X12_353|X12_354|X12_355|X12_356|X12_357|X12_358|X12_361|X12_362|X12_404|X12_410|X12_412|X12_414|X12_417|X12_418|X12_419|X12_420|X12_421|X12_422|X12_423|X12_424|X12_425|X12_426|X12_429|X12_431|X12_432|X12_433|X12_434|X12_435|X12_436|X12_437|X12_440|X12_451|X12_452|X12_453|X12_455|X12_456|X12_460|X12_463|X12_466|X12_468|X12_470|X12_475|X12_485|X12_486|X12_490|X12_492|X12_494|X12_500|X12_501|X12_503|X12_504|X12_511|X12_517|X12_521|X12_527|X12_536|X12_540|X12_561|X12_567|X12_568|X12_601|X12_602|X12_620|X12_625|X12_650|X12_715|X12_753|X12_754|X12_805|X12_806|X12_810|X12_811|X12_812|X12_813|X12_814|X12_815|X12_816|X12_818|X12_819|X12_820|X12_821|X12_822|X12_823|X12_824|X12_826|X12_827|X12_828|X12_829|X12_830|X12_831|X12_832|X12_833|X12_834|X12_835|X12_836|X12_837|X12_838|X12_839|X12_840|X12_841|X12_842|X12_843|X12_844|X12_845|X12_846|X12_847|X12_848|X12_849|X12_850|X12_851|X12_852|X12_853|X12_854|X12_855|X12_856|X12_857|X12_858|X12_859|X12_860|X12_861|X12_862|X12_863|X12_864|X12_865|X12_866|X12_867|X12_868|X12_869|X12_870|X12_871|X12_872|X12_873|X12_874|X12_875|X12_876|X12_877|X12_878|X12_879|X12_880|X12_881|X12_882|X12_883|X12_884|X12_885|X12_886|X12_887|X12_888|X12_889|X12_891|X12_893|X12_894|X12_895|X12_896|X12_920|X12_924|X12_925|X12_926|X12_928|X12_940|X12_943|X12_944|X12_945|X12_947|X12_980|X12_990|X12_993|X12_996|X12_997|X12_998|X12_999|X12_270_X279|X12_271_X279|X12_275_X210|X12_275_X211|X12_276_X212|X12_277_X212|X12_277_X214|X12_277_X364|X12_278_X217|X12_820_X218|X12_820_X306|X12_824_X186|X12_834_X220|X12_834_X307|X12_834_X318|X12_835_X221|X12_837_X222|X12_837_X223|X12_837_X224|X12_837_X291|X12_837_X292|X12_837_X298|X12_999_X231', 'version' => 'VERSION_4010|VERSION_4030|VERSION_4050|VERSION_4060|VERSION_5010|VERSION_5010_HIPAA', ], ], 'toFormat' => 'X12', // REQUIRED ], 'sampleDocument' => '', 'sampleDocuments' => [ 'bucketName' => '', // REQUIRED 'keys' => [ // REQUIRED [ 'input' => '', 'output' => '', ], // ... ], ], 'tags' => [ [ 'Key' => '', // REQUIRED 'Value' => '', // REQUIRED ], // ... ], ]);

Parameter Details

Members

clientToken

Reserved for future use.

ediType

Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

fileFormat

Specifies that the currently supported file formats for EDI transformations are JSON and XML.

inputConversion

Type: InputConversion structure

Specify the InputConversion object, which contains the format options for the inbound transformation.

mapping

Specify the structure that contains the mapping template and its language (either XSLT or JSONATA).

mappingTemplate

Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

This parameter is available for backwards compatibility. Use the Mapping data type instead.

name

Required: Yes

Type: string

Specifies the name of the transformer, used to identify it.

outputConversion

Type: OutputConversion structure

A structure that contains the OutputConversion object, which contains the format options for the outbound transformation.

sampleDocument

Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.

sampleDocuments

Type: SampleDocuments structure

Specify a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

tags

Type: Array of Tag structures

Result Syntax

[ 'createdAt' => , 'ediType' => [ 'x12Details' => [ 'transactionSet' => 'X12_100|X12_101|X12_102|X12_103|X12_104|X12_105|X12_106|X12_107|X12_108|X12_109|X12_110|X12_111|X12_112|X12_113|X12_120|X12_121|X12_124|X12_125|X12_126|X12_127|X12_128|X12_129|X12_130|X12_131|X12_132|X12_133|X12_135|X12_138|X12_139|X12_140|X12_141|X12_142|X12_143|X12_144|X12_146|X12_147|X12_148|X12_149|X12_150|X12_151|X12_152|X12_153|X12_154|X12_155|X12_157|X12_158|X12_159|X12_160|X12_161|X12_163|X12_170|X12_175|X12_176|X12_179|X12_180|X12_185|X12_186|X12_187|X12_188|X12_189|X12_190|X12_191|X12_194|X12_195|X12_196|X12_197|X12_198|X12_199|X12_200|X12_201|X12_202|X12_203|X12_204|X12_205|X12_206|X12_210|X12_211|X12_212|X12_213|X12_214|X12_215|X12_216|X12_217|X12_218|X12_219|X12_220|X12_222|X12_223|X12_224|X12_225|X12_227|X12_228|X12_240|X12_242|X12_244|X12_245|X12_248|X12_249|X12_250|X12_251|X12_252|X12_255|X12_256|X12_259|X12_260|X12_261|X12_262|X12_263|X12_264|X12_265|X12_266|X12_267|X12_268|X12_269|X12_270|X12_271|X12_272|X12_273|X12_274|X12_275|X12_276|X12_277|X12_278|X12_280|X12_283|X12_284|X12_285|X12_286|X12_288|X12_290|X12_300|X12_301|X12_303|X12_304|X12_309|X12_310|X12_311|X12_312|X12_313|X12_315|X12_317|X12_319|X12_322|X12_323|X12_324|X12_325|X12_326|X12_350|X12_352|X12_353|X12_354|X12_355|X12_356|X12_357|X12_358|X12_361|X12_362|X12_404|X12_410|X12_412|X12_414|X12_417|X12_418|X12_419|X12_420|X12_421|X12_422|X12_423|X12_424|X12_425|X12_426|X12_429|X12_431|X12_432|X12_433|X12_434|X12_435|X12_436|X12_437|X12_440|X12_451|X12_452|X12_453|X12_455|X12_456|X12_460|X12_463|X12_466|X12_468|X12_470|X12_475|X12_485|X12_486|X12_490|X12_492|X12_494|X12_500|X12_501|X12_503|X12_504|X12_511|X12_517|X12_521|X12_527|X12_536|X12_540|X12_561|X12_567|X12_568|X12_601|X12_602|X12_620|X12_625|X12_650|X12_715|X12_753|X12_754|X12_805|X12_806|X12_810|X12_811|X12_812|X12_813|X12_814|X12_815|X12_816|X12_818|X12_819|X12_820|X12_821|X12_822|X12_823|X12_824|X12_826|X12_827|X12_828|X12_829|X12_830|X12_831|X12_832|X12_833|X12_834|X12_835|X12_836|X12_837|X12_838|X12_839|X12_840|X12_841|X12_842|X12_843|X12_844|X12_845|X12_846|X12_847|X12_848|X12_849|X12_850|X12_851|X12_852|X12_853|X12_854|X12_855|X12_856|X12_857|X12_858|X12_859|X12_860|X12_861|X12_862|X12_863|X12_864|X12_865|X12_866|X12_867|X12_868|X12_869|X12_870|X12_871|X12_872|X12_873|X12_874|X12_875|X12_876|X12_877|X12_878|X12_879|X12_880|X12_881|X12_882|X12_883|X12_884|X12_885|X12_886|X12_887|X12_888|X12_889|X12_891|X12_893|X12_894|X12_895|X12_896|X12_920|X12_924|X12_925|X12_926|X12_928|X12_940|X12_943|X12_944|X12_945|X12_947|X12_980|X12_990|X12_993|X12_996|X12_997|X12_998|X12_999|X12_270_X279|X12_271_X279|X12_275_X210|X12_275_X211|X12_276_X212|X12_277_X212|X12_277_X214|X12_277_X364|X12_278_X217|X12_820_X218|X12_820_X306|X12_824_X186|X12_834_X220|X12_834_X307|X12_834_X318|X12_835_X221|X12_837_X222|X12_837_X223|X12_837_X224|X12_837_X291|X12_837_X292|X12_837_X298|X12_999_X231', 'version' => 'VERSION_4010|VERSION_4030|VERSION_4050|VERSION_4060|VERSION_5010|VERSION_5010_HIPAA', ], ], 'fileFormat' => 'XML|JSON|NOT_USED', 'inputConversion' => [ 'formatOptions' => [ 'x12' => [ 'transactionSet' => 'X12_100|X12_101|X12_102|X12_103|X12_104|X12_105|X12_106|X12_107|X12_108|X12_109|X12_110|X12_111|X12_112|X12_113|X12_120|X12_121|X12_124|X12_125|X12_126|X12_127|X12_128|X12_129|X12_130|X12_131|X12_132|X12_133|X12_135|X12_138|X12_139|X12_140|X12_141|X12_142|X12_143|X12_144|X12_146|X12_147|X12_148|X12_149|X12_150|X12_151|X12_152|X12_153|X12_154|X12_155|X12_157|X12_158|X12_159|X12_160|X12_161|X12_163|X12_170|X12_175|X12_176|X12_179|X12_180|X12_185|X12_186|X12_187|X12_188|X12_189|X12_190|X12_191|X12_194|X12_195|X12_196|X12_197|X12_198|X12_199|X12_200|X12_201|X12_202|X12_203|X12_204|X12_205|X12_206|X12_210|X12_211|X12_212|X12_213|X12_214|X12_215|X12_216|X12_217|X12_218|X12_219|X12_220|X12_222|X12_223|X12_224|X12_225|X12_227|X12_228|X12_240|X12_242|X12_244|X12_245|X12_248|X12_249|X12_250|X12_251|X12_252|X12_255|X12_256|X12_259|X12_260|X12_261|X12_262|X12_263|X12_264|X12_265|X12_266|X12_267|X12_268|X12_269|X12_270|X12_271|X12_272|X12_273|X12_274|X12_275|X12_276|X12_277|X12_278|X12_280|X12_283|X12_284|X12_285|X12_286|X12_288|X12_290|X12_300|X12_301|X12_303|X12_304|X12_309|X12_310|X12_311|X12_312|X12_313|X12_315|X12_317|X12_319|X12_322|X12_323|X12_324|X12_325|X12_326|X12_350|X12_352|X12_353|X12_354|X12_355|X12_356|X12_357|X12_358|X12_361|X12_362|X12_404|X12_410|X12_412|X12_414|X12_417|X12_418|X12_419|X12_420|X12_421|X12_422|X12_423|X12_424|X12_425|X12_426|X12_429|X12_431|X12_432|X12_433|X12_434|X12_435|X12_436|X12_437|X12_440|X12_451|X12_452|X12_453|X12_455|X12_456|X12_460|X12_463|X12_466|X12_468|X12_470|X12_475|X12_485|X12_486|X12_490|X12_492|X12_494|X12_500|X12_501|X12_503|X12_504|X12_511|X12_517|X12_521|X12_527|X12_536|X12_540|X12_561|X12_567|X12_568|X12_601|X12_602|X12_620|X12_625|X12_650|X12_715|X12_753|X12_754|X12_805|X12_806|X12_810|X12_811|X12_812|X12_813|X12_814|X12_815|X12_816|X12_818|X12_819|X12_820|X12_821|X12_822|X12_823|X12_824|X12_826|X12_827|X12_828|X12_829|X12_830|X12_831|X12_832|X12_833|X12_834|X12_835|X12_836|X12_837|X12_838|X12_839|X12_840|X12_841|X12_842|X12_843|X12_844|X12_845|X12_846|X12_847|X12_848|X12_849|X12_850|X12_851|X12_852|X12_853|X12_854|X12_855|X12_856|X12_857|X12_858|X12_859|X12_860|X12_861|X12_862|X12_863|X12_864|X12_865|X12_866|X12_867|X12_868|X12_869|X12_870|X12_871|X12_872|X12_873|X12_874|X12_875|X12_876|X12_877|X12_878|X12_879|X12_880|X12_881|X12_882|X12_883|X12_884|X12_885|X12_886|X12_887|X12_888|X12_889|X12_891|X12_893|X12_894|X12_895|X12_896|X12_920|X12_924|X12_925|X12_926|X12_928|X12_940|X12_943|X12_944|X12_945|X12_947|X12_980|X12_990|X12_993|X12_996|X12_997|X12_998|X12_999|X12_270_X279|X12_271_X279|X12_275_X210|X12_275_X211|X12_276_X212|X12_277_X212|X12_277_X214|X12_277_X364|X12_278_X217|X12_820_X218|X12_820_X306|X12_824_X186|X12_834_X220|X12_834_X307|X12_834_X318|X12_835_X221|X12_837_X222|X12_837_X223|X12_837_X224|X12_837_X291|X12_837_X292|X12_837_X298|X12_999_X231', 'version' => 'VERSION_4010|VERSION_4030|VERSION_4050|VERSION_4060|VERSION_5010|VERSION_5010_HIPAA', ], ], 'fromFormat' => 'X12', ], 'mapping' => [ 'template' => '', 'templateLanguage' => 'XSLT|JSONATA', ], 'mappingTemplate' => '', 'name' => '', 'outputConversion' => [ 'formatOptions' => [ 'x12' => [ 'transactionSet' => 'X12_100|X12_101|X12_102|X12_103|X12_104|X12_105|X12_106|X12_107|X12_108|X12_109|X12_110|X12_111|X12_112|X12_113|X12_120|X12_121|X12_124|X12_125|X12_126|X12_127|X12_128|X12_129|X12_130|X12_131|X12_132|X12_133|X12_135|X12_138|X12_139|X12_140|X12_141|X12_142|X12_143|X12_144|X12_146|X12_147|X12_148|X12_149|X12_150|X12_151|X12_152|X12_153|X12_154|X12_155|X12_157|X12_158|X12_159|X12_160|X12_161|X12_163|X12_170|X12_175|X12_176|X12_179|X12_180|X12_185|X12_186|X12_187|X12_188|X12_189|X12_190|X12_191|X12_194|X12_195|X12_196|X12_197|X12_198|X12_199|X12_200|X12_201|X12_202|X12_203|X12_204|X12_205|X12_206|X12_210|X12_211|X12_212|X12_213|X12_214|X12_215|X12_216|X12_217|X12_218|X12_219|X12_220|X12_222|X12_223|X12_224|X12_225|X12_227|X12_228|X12_240|X12_242|X12_244|X12_245|X12_248|X12_249|X12_250|X12_251|X12_252|X12_255|X12_256|X12_259|X12_260|X12_261|X12_262|X12_263|X12_264|X12_265|X12_266|X12_267|X12_268|X12_269|X12_270|X12_271|X12_272|X12_273|X12_274|X12_275|X12_276|X12_277|X12_278|X12_280|X12_283|X12_284|X12_285|X12_286|X12_288|X12_290|X12_300|X12_301|X12_303|X12_304|X12_309|X12_310|X12_311|X12_312|X12_313|X12_315|X12_317|X12_319|X12_322|X12_323|X12_324|X12_325|X12_326|X12_350|X12_352|X12_353|X12_354|X12_355|X12_356|X12_357|X12_358|X12_361|X12_362|X12_404|X12_410|X12_412|X12_414|X12_417|X12_418|X12_419|X12_420|X12_421|X12_422|X12_423|X12_424|X12_425|X12_426|X12_429|X12_431|X12_432|X12_433|X12_434|X12_435|X12_436|X12_437|X12_440|X12_451|X12_452|X12_453|X12_455|X12_456|X12_460|X12_463|X12_466|X12_468|X12_470|X12_475|X12_485|X12_486|X12_490|X12_492|X12_494|X12_500|X12_501|X12_503|X12_504|X12_511|X12_517|X12_521|X12_527|X12_536|X12_540|X12_561|X12_567|X12_568|X12_601|X12_602|X12_620|X12_625|X12_650|X12_715|X12_753|X12_754|X12_805|X12_806|X12_810|X12_811|X12_812|X12_813|X12_814|X12_815|X12_816|X12_818|X12_819|X12_820|X12_821|X12_822|X12_823|X12_824|X12_826|X12_827|X12_828|X12_829|X12_830|X12_831|X12_832|X12_833|X12_834|X12_835|X12_836|X12_837|X12_838|X12_839|X12_840|X12_841|X12_842|X12_843|X12_844|X12_845|X12_846|X12_847|X12_848|X12_849|X12_850|X12_851|X12_852|X12_853|X12_854|X12_855|X12_856|X12_857|X12_858|X12_859|X12_860|X12_861|X12_862|X12_863|X12_864|X12_865|X12_866|X12_867|X12_868|X12_869|X12_870|X12_871|X12_872|X12_873|X12_874|X12_875|X12_876|X12_877|X12_878|X12_879|X12_880|X12_881|X12_882|X12_883|X12_884|X12_885|X12_886|X12_887|X12_888|X12_889|X12_891|X12_893|X12_894|X12_895|X12_896|X12_920|X12_924|X12_925|X12_926|X12_928|X12_940|X12_943|X12_944|X12_945|X12_947|X12_980|X12_990|X12_993|X12_996|X12_997|X12_998|X12_999|X12_270_X279|X12_271_X279|X12_275_X210|X12_275_X211|X12_276_X212|X12_277_X212|X12_277_X214|X12_277_X364|X12_278_X217|X12_820_X218|X12_820_X306|X12_824_X186|X12_834_X220|X12_834_X307|X12_834_X318|X12_835_X221|X12_837_X222|X12_837_X223|X12_837_X224|X12_837_X291|X12_837_X292|X12_837_X298|X12_999_X231', 'version' => 'VERSION_4010|VERSION_4030|VERSION_4050|VERSION_4060|VERSION_5010|VERSION_5010_HIPAA', ], ], 'toFormat' => 'X12', ], 'sampleDocument' => '', 'sampleDocuments' => [ 'bucketName' => '', 'keys' => [ [ 'input' => '', 'output' => '', ], // ... ], ], 'status' => 'active|inactive', 'transformerArn' => '', 'transformerId' => '', ]

Result Details

Members

createdAt

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns a timestamp for creation date and time of the transformer.

ediType

Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

fileFormat

Returns that the currently supported file formats for EDI transformations are JSON and XML.

inputConversion

Type: InputConversion structure

Returns the InputConversion object, which contains the format options for the inbound transformation.

mapping

Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).

mappingTemplate

Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

name

Required: Yes

Type: string

Returns the name of the transformer, used to identify it.

outputConversion

Type: OutputConversion structure

Returns the OutputConversion object, which contains the format options for the outbound transformation.

sampleDocument

Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

sampleDocuments

Type: SampleDocuments structure

Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

status

Required: Yes

Type: string

Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.

transformerArn

Required: Yes

Type: string

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

transformerId

Required: Yes

Type: string

Returns the system-assigned unique identifier for the transformer.

Errors

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.

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample CreateTransformer call

result=result = result=client->createTransformer([ 'name' => 'transformX12', 'clientToken' => 'foo', 'inputConversion' => [ 'formatOptions' => [ 'x12' => [ 'version' => 'VERSION_4010', 'transactionSet' => 'X12_110', ], ], 'fromFormat' => 'X12', ], 'mapping' => [ 'template' => '{}', 'templateLanguage' => 'JSONATA', ], 'sampleDocuments' => [ 'bucketName' => 'test-bucket', 'keys' => [ [ 'input' => 'sampleDoc.txt', ], ], ], 'tags' => [ [ 'Key' => 'sampleKey', 'Value' => 'sampleValue', ], ], ]);

Result syntax:

[ 'name' => 'transformX12', 'createdAt' => , 'inputConversion' => [ 'formatOptions' => [ 'x12' => [ 'version' => 'VERSION_4010', 'transactionSet' => 'X12_110', ], ], 'fromFormat' => 'X12', ], 'mapping' => [ 'template' => '{}', 'templateLanguage' => 'JSONATA', ], 'sampleDocuments' => [ 'bucketName' => 'test-bucket', 'keys' => [ [ 'input' => 'sampleDoc.txt', ], ], ], 'status' => 'inactive', 'transformerArn' => 'arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9', 'transformerId' => 'tr-974c129999f84d8c9', ]

DeleteCapability

result=result = result=client->deleteCapability([/* ... /]); promise=promise = promise=client->deleteCapabilityAsync([/ ... */]);

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

Parameter Syntax

result=result = result=client->deleteCapability([ 'capabilityId' => '', // REQUIRED ]);

Parameter Details

Members

capabilityId

Required: Yes

Type: string

Specifies a system-assigned unique identifier for the capability.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

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.

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample DeleteCapabilty call

result=result = result=client->deleteCapability([ 'capabilityId' => 'ca-963a8121e4fc4e348', ]);

DeletePartnership

result=result = result=client->deletePartnership([/* ... /]); promise=promise = promise=client->deletePartnershipAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->deletePartnership([ 'partnershipId' => '', // REQUIRED ]);

Parameter Details

Members

partnershipId

Required: Yes

Type: string

Specifies the unique, system-generated identifier for a partnership.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

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.

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample DeletePartnership call

result=result = result=client->deletePartnership([ 'partnershipId' => 'ps-219fa02f5b4242af8', ]);

DeleteProfile

result=result = result=client->deleteProfile([/* ... /]); promise=promise = promise=client->deleteProfileAsync([/ ... */]);

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

Parameter Syntax

result=result = result=client->deleteProfile([ 'profileId' => '', // REQUIRED ]);

Parameter Details

Members

profileId

Required: Yes

Type: string

Specifies the unique, system-generated identifier for the profile.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

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.

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample DeleteProfile call

result=result = result=client->deleteProfile([ 'profileId' => 'p-60fbc37c87f04fce9', ]);

DeleteTransformer

result=result = result=client->deleteTransformer([/* ... /]); promise=promise = promise=client->deleteTransformerAsync([/ ... */]);

Deletes the specified transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.

Parameter Syntax

result=result = result=client->deleteTransformer([ 'transformerId' => '', // REQUIRED ]);

Parameter Details

Members

transformerId

Required: Yes

Type: string

Specifies the system-assigned unique identifier for the transformer.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

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.

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample DeleteTransformer call

result=result = result=client->deleteTransformer([ 'transformerId' => 'tr-974c129999f84d8c9', ]);

GenerateMapping

result=result = result=client->generateMapping([/* ... /]); promise=promise = promise=client->generateMappingAsync([/ ... */]);

Takes sample input and output documents and uses Amazon Bedrock to generate a mapping automatically. Depending on the accuracy and other factors, you can then edit the mapping for your needs.

Before you can use the AI-assisted feature for Amazon Web Services B2B Data Interchange you must enable models in Amazon Bedrock. For details, see AI-assisted template mapping prerequisites in the Amazon Web Services B2B Data Interchange User guide.

Parameter Syntax

result=result = result=client->generateMapping([ 'inputFileContent' => '', // REQUIRED 'mappingType' => 'JSONATA|XSLT', // REQUIRED 'outputFileContent' => '', // REQUIRED ]);

Parameter Details

Members

inputFileContent

Required: Yes

Type: string

Provide the contents of a sample X12 EDI file (for inbound EDI) or JSON/XML file (for outbound EDI) to use as a starting point for the mapping.

mappingType

Required: Yes

Type: string

Specify the mapping type: either JSONATA or XSLT.

outputFileContent

Required: Yes

Type: string

Provide the contents of a sample X12 EDI file (for outbound EDI) or JSON/XML file (for inbound EDI) to use as a target for the mapping.

Result Syntax

[ 'mappingAccuracy' => , 'mappingTemplate' => '', ]

Result Details

Members

mappingAccuracy

Returns a percentage that estimates the accuracy of the generated mapping.

mappingTemplate

Required: Yes

Type: string

Returns a mapping template based on your inputs.

Errors

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample GenerateMapping call

result=result = result=client->generateMapping([ 'inputFileContent' => 'Sample input file content', 'mappingType' => 'JSONATA', 'outputFileContent' => 'Sample output file content', ]);

Result syntax:

[ 'mappingAccuracy' => 0.95, 'mappingTemplate' => 'Sample mapping content', ]

GetCapability

result=result = result=client->getCapability([/* ... /]); promise=promise = promise=client->getCapabilityAsync([/ ... */]);

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

Parameter Syntax

result=result = result=client->getCapability([ 'capabilityId' => '', // REQUIRED ]);

Parameter Details

Members

capabilityId

Required: Yes

Type: string

Specifies a system-assigned unique identifier for the capability.

Result Syntax

Result Details

Members

capabilityArn

Required: Yes

Type: string

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

capabilityId

Required: Yes

Type: string

Returns a system-assigned unique identifier for the capability.

configuration

Required: Yes

Type: CapabilityConfiguration structure

Returns a structure that contains the details for a capability.

createdAt

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns a timestamp for creation date and time of the capability.

instructionsDocuments

Type: Array of S3Location structures

modifiedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns a timestamp for last time the capability was modified.

name

Required: Yes

Type: string

Returns the name of the capability, used to identify it.

type

Required: Yes

Type: string

Returns the type of the capability. Currently, only edi is supported.

Errors

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample GetCapabilty call

result=result = result=client->getCapability([ 'capabilityId' => 'ca-963a8121e4fc4e348', ]);

Result syntax:

GetPartnership

result=result = result=client->getPartnership([/* ... /]); promise=promise = promise=client->getPartnershipAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->getPartnership([ 'partnershipId' => '', // REQUIRED ]);

Parameter Details

Members

partnershipId

Required: Yes

Type: string

Specifies the unique, system-generated identifier for a partnership.

Result Syntax

[ 'capabilities' => ['', ...], 'capabilityOptions' => [ 'outboundEdi' => [ 'x12' => [ 'common' => [ 'delimiters' => [ 'componentSeparator' => '', 'dataElementSeparator' => '', 'segmentTerminator' => '', ], 'functionalGroupHeaders' => [ 'applicationReceiverCode' => '', 'applicationSenderCode' => '', 'responsibleAgencyCode' => '', ], 'interchangeControlHeaders' => [ 'acknowledgmentRequestedCode' => '', 'receiverId' => '', 'receiverIdQualifier' => '', 'repetitionSeparator' => '', 'senderId' => '', 'senderIdQualifier' => '', 'usageIndicatorCode' => '', ], 'validateEdi' => true || false, ], ], ], ], 'createdAt' => , 'email' => '', 'modifiedAt' => , 'name' => '', 'partnershipArn' => '', 'partnershipId' => '', 'phone' => '', 'profileId' => '', 'tradingPartnerId' => '', ]

Result Details

Members

capabilities

Returns one or more capabilities associated with this partnership.

capabilityOptions

Type: CapabilityOptions structure

Contains the details for an Outbound EDI capability.

createdAt

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns a timestamp for creation date and time of the partnership.

email

Returns the email address associated with this trading partner.

modifiedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns a timestamp that identifies the most recent date and time that the partnership was modified.

name

Returns the display name of the partnership

partnershipArn

Required: Yes

Type: string

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

partnershipId

Required: Yes

Type: string

Returns the unique, system-generated identifier for a partnership.

phone

Returns the phone number associated with the partnership.

profileId

Required: Yes

Type: string

Returns the unique, system-generated identifier for the profile connected to this partnership.

tradingPartnerId

Returns the unique identifier for the partner for this partnership.

Errors

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample GetPartnership call

result=result = result=client->getPartnership([ 'partnershipId' => 'ps-219fa02f5b4242af8', ]);

Result syntax:

[ 'name' => 'b2bipartner', 'capabilities' => [ 'ca-963a8121e4fc4e348', ], 'createdAt' => , 'email' => 'john@example.com', 'modifiedAt' => , 'partnershipArn' => 'arn:aws:b2bi:us-west-2:123456789012:partnership/ps-219fa02f5b4242af8', 'partnershipId' => 'ps-219fa02f5b4242af8', 'phone' => '5555555555', 'profileId' => 'p-60fbc37c87f04fce9', 'tradingPartnerId' => 'tp-2a17ca447f6f4a8a8', ]

GetProfile

result=result = result=client->getProfile([/* ... /]); promise=promise = promise=client->getProfileAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->getProfile([ 'profileId' => '', // REQUIRED ]);

Parameter Details

Members

profileId

Required: Yes

Type: string

Specifies the unique, system-generated identifier for the profile.

Result Syntax

[ 'businessName' => '', 'createdAt' => , 'email' => '', 'logGroupName' => '', 'logging' => 'ENABLED|DISABLED', 'modifiedAt' => , 'name' => '', 'phone' => '', 'profileArn' => '', 'profileId' => '', ]

Result Details

Members

businessName

Required: Yes

Type: string

Returns the name for the business associated with this profile.

createdAt

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns a timestamp for creation date and time of the transformer.

email

Returns the email address associated with this customer profile.

logGroupName

Returns the name of the logging group.

logging

Returns whether or not logging is enabled for this profile.

modifiedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns a timestamp for last time the profile was modified.

name

Required: Yes

Type: string

Returns the name of the profile, used to identify it.

phone

Required: Yes

Type: string

Returns the phone number associated with the profile.

profileArn

Required: Yes

Type: string

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

profileId

Required: Yes

Type: string

Returns the unique, system-generated identifier for the profile.

Errors

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample GetProfile call

result=result = result=client->getProfile([ 'profileId' => 'p-60fbc37c87f04fce9', ]);

Result syntax:

GetTransformer

result=result = result=client->getTransformer([/* ... /]); promise=promise = promise=client->getTransformerAsync([/ ... */]);

Retrieves the details for the transformer specified by the transformer ID. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.

Parameter Syntax

result=result = result=client->getTransformer([ 'transformerId' => '', // REQUIRED ]);

Parameter Details

Members

transformerId

Required: Yes

Type: string

Specifies the system-assigned unique identifier for the transformer.

Result Syntax

[ 'createdAt' => , 'ediType' => [ 'x12Details' => [ 'transactionSet' => 'X12_100|X12_101|X12_102|X12_103|X12_104|X12_105|X12_106|X12_107|X12_108|X12_109|X12_110|X12_111|X12_112|X12_113|X12_120|X12_121|X12_124|X12_125|X12_126|X12_127|X12_128|X12_129|X12_130|X12_131|X12_132|X12_133|X12_135|X12_138|X12_139|X12_140|X12_141|X12_142|X12_143|X12_144|X12_146|X12_147|X12_148|X12_149|X12_150|X12_151|X12_152|X12_153|X12_154|X12_155|X12_157|X12_158|X12_159|X12_160|X12_161|X12_163|X12_170|X12_175|X12_176|X12_179|X12_180|X12_185|X12_186|X12_187|X12_188|X12_189|X12_190|X12_191|X12_194|X12_195|X12_196|X12_197|X12_198|X12_199|X12_200|X12_201|X12_202|X12_203|X12_204|X12_205|X12_206|X12_210|X12_211|X12_212|X12_213|X12_214|X12_215|X12_216|X12_217|X12_218|X12_219|X12_220|X12_222|X12_223|X12_224|X12_225|X12_227|X12_228|X12_240|X12_242|X12_244|X12_245|X12_248|X12_249|X12_250|X12_251|X12_252|X12_255|X12_256|X12_259|X12_260|X12_261|X12_262|X12_263|X12_264|X12_265|X12_266|X12_267|X12_268|X12_269|X12_270|X12_271|X12_272|X12_273|X12_274|X12_275|X12_276|X12_277|X12_278|X12_280|X12_283|X12_284|X12_285|X12_286|X12_288|X12_290|X12_300|X12_301|X12_303|X12_304|X12_309|X12_310|X12_311|X12_312|X12_313|X12_315|X12_317|X12_319|X12_322|X12_323|X12_324|X12_325|X12_326|X12_350|X12_352|X12_353|X12_354|X12_355|X12_356|X12_357|X12_358|X12_361|X12_362|X12_404|X12_410|X12_412|X12_414|X12_417|X12_418|X12_419|X12_420|X12_421|X12_422|X12_423|X12_424|X12_425|X12_426|X12_429|X12_431|X12_432|X12_433|X12_434|X12_435|X12_436|X12_437|X12_440|X12_451|X12_452|X12_453|X12_455|X12_456|X12_460|X12_463|X12_466|X12_468|X12_470|X12_475|X12_485|X12_486|X12_490|X12_492|X12_494|X12_500|X12_501|X12_503|X12_504|X12_511|X12_517|X12_521|X12_527|X12_536|X12_540|X12_561|X12_567|X12_568|X12_601|X12_602|X12_620|X12_625|X12_650|X12_715|X12_753|X12_754|X12_805|X12_806|X12_810|X12_811|X12_812|X12_813|X12_814|X12_815|X12_816|X12_818|X12_819|X12_820|X12_821|X12_822|X12_823|X12_824|X12_826|X12_827|X12_828|X12_829|X12_830|X12_831|X12_832|X12_833|X12_834|X12_835|X12_836|X12_837|X12_838|X12_839|X12_840|X12_841|X12_842|X12_843|X12_844|X12_845|X12_846|X12_847|X12_848|X12_849|X12_850|X12_851|X12_852|X12_853|X12_854|X12_855|X12_856|X12_857|X12_858|X12_859|X12_860|X12_861|X12_862|X12_863|X12_864|X12_865|X12_866|X12_867|X12_868|X12_869|X12_870|X12_871|X12_872|X12_873|X12_874|X12_875|X12_876|X12_877|X12_878|X12_879|X12_880|X12_881|X12_882|X12_883|X12_884|X12_885|X12_886|X12_887|X12_888|X12_889|X12_891|X12_893|X12_894|X12_895|X12_896|X12_920|X12_924|X12_925|X12_926|X12_928|X12_940|X12_943|X12_944|X12_945|X12_947|X12_980|X12_990|X12_993|X12_996|X12_997|X12_998|X12_999|X12_270_X279|X12_271_X279|X12_275_X210|X12_275_X211|X12_276_X212|X12_277_X212|X12_277_X214|X12_277_X364|X12_278_X217|X12_820_X218|X12_820_X306|X12_824_X186|X12_834_X220|X12_834_X307|X12_834_X318|X12_835_X221|X12_837_X222|X12_837_X223|X12_837_X224|X12_837_X291|X12_837_X292|X12_837_X298|X12_999_X231', 'version' => 'VERSION_4010|VERSION_4030|VERSION_4050|VERSION_4060|VERSION_5010|VERSION_5010_HIPAA', ], ], 'fileFormat' => 'XML|JSON|NOT_USED', 'inputConversion' => [ 'formatOptions' => [ 'x12' => [ 'transactionSet' => 'X12_100|X12_101|X12_102|X12_103|X12_104|X12_105|X12_106|X12_107|X12_108|X12_109|X12_110|X12_111|X12_112|X12_113|X12_120|X12_121|X12_124|X12_125|X12_126|X12_127|X12_128|X12_129|X12_130|X12_131|X12_132|X12_133|X12_135|X12_138|X12_139|X12_140|X12_141|X12_142|X12_143|X12_144|X12_146|X12_147|X12_148|X12_149|X12_150|X12_151|X12_152|X12_153|X12_154|X12_155|X12_157|X12_158|X12_159|X12_160|X12_161|X12_163|X12_170|X12_175|X12_176|X12_179|X12_180|X12_185|X12_186|X12_187|X12_188|X12_189|X12_190|X12_191|X12_194|X12_195|X12_196|X12_197|X12_198|X12_199|X12_200|X12_201|X12_202|X12_203|X12_204|X12_205|X12_206|X12_210|X12_211|X12_212|X12_213|X12_214|X12_215|X12_216|X12_217|X12_218|X12_219|X12_220|X12_222|X12_223|X12_224|X12_225|X12_227|X12_228|X12_240|X12_242|X12_244|X12_245|X12_248|X12_249|X12_250|X12_251|X12_252|X12_255|X12_256|X12_259|X12_260|X12_261|X12_262|X12_263|X12_264|X12_265|X12_266|X12_267|X12_268|X12_269|X12_270|X12_271|X12_272|X12_273|X12_274|X12_275|X12_276|X12_277|X12_278|X12_280|X12_283|X12_284|X12_285|X12_286|X12_288|X12_290|X12_300|X12_301|X12_303|X12_304|X12_309|X12_310|X12_311|X12_312|X12_313|X12_315|X12_317|X12_319|X12_322|X12_323|X12_324|X12_325|X12_326|X12_350|X12_352|X12_353|X12_354|X12_355|X12_356|X12_357|X12_358|X12_361|X12_362|X12_404|X12_410|X12_412|X12_414|X12_417|X12_418|X12_419|X12_420|X12_421|X12_422|X12_423|X12_424|X12_425|X12_426|X12_429|X12_431|X12_432|X12_433|X12_434|X12_435|X12_436|X12_437|X12_440|X12_451|X12_452|X12_453|X12_455|X12_456|X12_460|X12_463|X12_466|X12_468|X12_470|X12_475|X12_485|X12_486|X12_490|X12_492|X12_494|X12_500|X12_501|X12_503|X12_504|X12_511|X12_517|X12_521|X12_527|X12_536|X12_540|X12_561|X12_567|X12_568|X12_601|X12_602|X12_620|X12_625|X12_650|X12_715|X12_753|X12_754|X12_805|X12_806|X12_810|X12_811|X12_812|X12_813|X12_814|X12_815|X12_816|X12_818|X12_819|X12_820|X12_821|X12_822|X12_823|X12_824|X12_826|X12_827|X12_828|X12_829|X12_830|X12_831|X12_832|X12_833|X12_834|X12_835|X12_836|X12_837|X12_838|X12_839|X12_840|X12_841|X12_842|X12_843|X12_844|X12_845|X12_846|X12_847|X12_848|X12_849|X12_850|X12_851|X12_852|X12_853|X12_854|X12_855|X12_856|X12_857|X12_858|X12_859|X12_860|X12_861|X12_862|X12_863|X12_864|X12_865|X12_866|X12_867|X12_868|X12_869|X12_870|X12_871|X12_872|X12_873|X12_874|X12_875|X12_876|X12_877|X12_878|X12_879|X12_880|X12_881|X12_882|X12_883|X12_884|X12_885|X12_886|X12_887|X12_888|X12_889|X12_891|X12_893|X12_894|X12_895|X12_896|X12_920|X12_924|X12_925|X12_926|X12_928|X12_940|X12_943|X12_944|X12_945|X12_947|X12_980|X12_990|X12_993|X12_996|X12_997|X12_998|X12_999|X12_270_X279|X12_271_X279|X12_275_X210|X12_275_X211|X12_276_X212|X12_277_X212|X12_277_X214|X12_277_X364|X12_278_X217|X12_820_X218|X12_820_X306|X12_824_X186|X12_834_X220|X12_834_X307|X12_834_X318|X12_835_X221|X12_837_X222|X12_837_X223|X12_837_X224|X12_837_X291|X12_837_X292|X12_837_X298|X12_999_X231', 'version' => 'VERSION_4010|VERSION_4030|VERSION_4050|VERSION_4060|VERSION_5010|VERSION_5010_HIPAA', ], ], 'fromFormat' => 'X12', ], 'mapping' => [ 'template' => '', 'templateLanguage' => 'XSLT|JSONATA', ], 'mappingTemplate' => '', 'modifiedAt' => , 'name' => '', 'outputConversion' => [ 'formatOptions' => [ 'x12' => [ 'transactionSet' => 'X12_100|X12_101|X12_102|X12_103|X12_104|X12_105|X12_106|X12_107|X12_108|X12_109|X12_110|X12_111|X12_112|X12_113|X12_120|X12_121|X12_124|X12_125|X12_126|X12_127|X12_128|X12_129|X12_130|X12_131|X12_132|X12_133|X12_135|X12_138|X12_139|X12_140|X12_141|X12_142|X12_143|X12_144|X12_146|X12_147|X12_148|X12_149|X12_150|X12_151|X12_152|X12_153|X12_154|X12_155|X12_157|X12_158|X12_159|X12_160|X12_161|X12_163|X12_170|X12_175|X12_176|X12_179|X12_180|X12_185|X12_186|X12_187|X12_188|X12_189|X12_190|X12_191|X12_194|X12_195|X12_196|X12_197|X12_198|X12_199|X12_200|X12_201|X12_202|X12_203|X12_204|X12_205|X12_206|X12_210|X12_211|X12_212|X12_213|X12_214|X12_215|X12_216|X12_217|X12_218|X12_219|X12_220|X12_222|X12_223|X12_224|X12_225|X12_227|X12_228|X12_240|X12_242|X12_244|X12_245|X12_248|X12_249|X12_250|X12_251|X12_252|X12_255|X12_256|X12_259|X12_260|X12_261|X12_262|X12_263|X12_264|X12_265|X12_266|X12_267|X12_268|X12_269|X12_270|X12_271|X12_272|X12_273|X12_274|X12_275|X12_276|X12_277|X12_278|X12_280|X12_283|X12_284|X12_285|X12_286|X12_288|X12_290|X12_300|X12_301|X12_303|X12_304|X12_309|X12_310|X12_311|X12_312|X12_313|X12_315|X12_317|X12_319|X12_322|X12_323|X12_324|X12_325|X12_326|X12_350|X12_352|X12_353|X12_354|X12_355|X12_356|X12_357|X12_358|X12_361|X12_362|X12_404|X12_410|X12_412|X12_414|X12_417|X12_418|X12_419|X12_420|X12_421|X12_422|X12_423|X12_424|X12_425|X12_426|X12_429|X12_431|X12_432|X12_433|X12_434|X12_435|X12_436|X12_437|X12_440|X12_451|X12_452|X12_453|X12_455|X12_456|X12_460|X12_463|X12_466|X12_468|X12_470|X12_475|X12_485|X12_486|X12_490|X12_492|X12_494|X12_500|X12_501|X12_503|X12_504|X12_511|X12_517|X12_521|X12_527|X12_536|X12_540|X12_561|X12_567|X12_568|X12_601|X12_602|X12_620|X12_625|X12_650|X12_715|X12_753|X12_754|X12_805|X12_806|X12_810|X12_811|X12_812|X12_813|X12_814|X12_815|X12_816|X12_818|X12_819|X12_820|X12_821|X12_822|X12_823|X12_824|X12_826|X12_827|X12_828|X12_829|X12_830|X12_831|X12_832|X12_833|X12_834|X12_835|X12_836|X12_837|X12_838|X12_839|X12_840|X12_841|X12_842|X12_843|X12_844|X12_845|X12_846|X12_847|X12_848|X12_849|X12_850|X12_851|X12_852|X12_853|X12_854|X12_855|X12_856|X12_857|X12_858|X12_859|X12_860|X12_861|X12_862|X12_863|X12_864|X12_865|X12_866|X12_867|X12_868|X12_869|X12_870|X12_871|X12_872|X12_873|X12_874|X12_875|X12_876|X12_877|X12_878|X12_879|X12_880|X12_881|X12_882|X12_883|X12_884|X12_885|X12_886|X12_887|X12_888|X12_889|X12_891|X12_893|X12_894|X12_895|X12_896|X12_920|X12_924|X12_925|X12_926|X12_928|X12_940|X12_943|X12_944|X12_945|X12_947|X12_980|X12_990|X12_993|X12_996|X12_997|X12_998|X12_999|X12_270_X279|X12_271_X279|X12_275_X210|X12_275_X211|X12_276_X212|X12_277_X212|X12_277_X214|X12_277_X364|X12_278_X217|X12_820_X218|X12_820_X306|X12_824_X186|X12_834_X220|X12_834_X307|X12_834_X318|X12_835_X221|X12_837_X222|X12_837_X223|X12_837_X224|X12_837_X291|X12_837_X292|X12_837_X298|X12_999_X231', 'version' => 'VERSION_4010|VERSION_4030|VERSION_4050|VERSION_4060|VERSION_5010|VERSION_5010_HIPAA', ], ], 'toFormat' => 'X12', ], 'sampleDocument' => '', 'sampleDocuments' => [ 'bucketName' => '', 'keys' => [ [ 'input' => '', 'output' => '', ], // ... ], ], 'status' => 'active|inactive', 'transformerArn' => '', 'transformerId' => '', ]

Result Details

Members

createdAt

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns a timestamp for creation date and time of the transformer.

ediType

fileFormat

Returns that the currently supported file formats for EDI transformations are JSON and XML.

inputConversion

Type: InputConversion structure

Returns the InputConversion object, which contains the format options for the inbound transformation.

mapping

Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).

mappingTemplate

Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

modifiedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns a timestamp for last time the transformer was modified.

name

Required: Yes

Type: string

Returns the name of the transformer, used to identify it.

outputConversion

Type: OutputConversion structure

Returns the OutputConversion object, which contains the format options for the outbound transformation.

sampleDocument

Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

sampleDocuments

Type: SampleDocuments structure

Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

status

Required: Yes

Type: string

Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.

transformerArn

Required: Yes

Type: string

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

transformerId

Required: Yes

Type: string

Returns the system-assigned unique identifier for the transformer.

Errors

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample GetTransformer call

result=result = result=client->getTransformer([ 'transformerId' => 'tr-974c129999f84d8c9', ]);

Result syntax:

GetTransformerJob

result=result = result=client->getTransformerJob([/* ... /]); promise=promise = promise=client->getTransformerJobAsync([/ ... */]);

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

Parameter Syntax

result=result = result=client->getTransformerJob([ 'transformerId' => '', // REQUIRED 'transformerJobId' => '', // REQUIRED ]);

Parameter Details

Members

transformerId

Required: Yes

Type: string

Specifies the system-assigned unique identifier for the transformer.

transformerJobId

Required: Yes

Type: string

Specifies the unique, system-generated identifier for a transformer run.

Result Syntax

[ 'message' => '', 'outputFiles' => [ [ 'bucketName' => '', 'key' => '', ], // ... ], 'status' => 'running|succeeded|failed', ]

Result Details

Members

message

Returns an optional error message, which gets populated when the job is not run successfully.

outputFiles

Type: Array of S3Location structures

Returns the location for the output files. If the caller specified a directory for the output, then this contains the full path to the output file, including the file name generated by the service.

status

Required: Yes

Type: string

Returns the current state of the transformer job, either running, succeeded, or failed.

Errors

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample GetTransformerJob call

result=result = result=client->getTransformerJob([ 'transformerId' => 'tr-974c129999f84d8c9', 'transformerJobId' => 'tj-vpYxfV7yQOqjMSYllEslLw', ]);

Result syntax:

[ 'message' => 'Transformed, writing output', 'outputFiles' => [ [ 'key' => 'output/sample-214.edi.2023-11-01T10:44:03.353Z.json', 'bucketName' => 'gt-edi-test', ], ], 'status' => 'succeeded', ]

ListCapabilities

result=result = result=client->listCapabilities([/* ... /]); promise=promise = promise=client->listCapabilitiesAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->listCapabilities([ 'maxResults' => , 'nextToken' => '', ]);

Parameter Details

Members

maxResults

Specifies the maximum number of capabilities to return.

nextToken

When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

Result Syntax

[ 'capabilities' => [ [ 'capabilityId' => '', 'createdAt' => , 'modifiedAt' => , 'name' => '', 'type' => 'edi', ], // ... ], 'nextToken' => '', ]

Result Details

Members

capabilities

Required: Yes

Type: Array of CapabilitySummary structures

Returns one or more capabilities associated with this partnership.

nextToken

Errors

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample ListCapabilities call

result=result = result=client->listCapabilities([ 'maxResults' => 50, 'nextToken' => 'foo', ]);

Result syntax:

[ 'capabilities' => [ [ 'name' => 'b2biexample', 'type' => 'edi', 'capabilityId' => 'ca-963a8121e4fc4e348', 'createdAt' => , 'modifiedAt' => , ], ], 'nextToken' => 'foo', ]

ListPartnerships

result=result = result=client->listPartnerships([/* ... /]); promise=promise = promise=client->listPartnershipsAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->listPartnerships([ 'maxResults' => , 'nextToken' => '', 'profileId' => '', ]);

Parameter Details

Members

maxResults

Specifies the maximum number of capabilities to return.

nextToken

profileId

Specifies the unique, system-generated identifier for the profile connected to this partnership.

Result Syntax

[ 'nextToken' => '', 'partnerships' => [ [ 'capabilities' => ['', ...], 'capabilityOptions' => [ 'outboundEdi' => [ 'x12' => [ 'common' => [ 'delimiters' => [ 'componentSeparator' => '', 'dataElementSeparator' => '', 'segmentTerminator' => '', ], 'functionalGroupHeaders' => [ 'applicationReceiverCode' => '', 'applicationSenderCode' => '', 'responsibleAgencyCode' => '', ], 'interchangeControlHeaders' => [ 'acknowledgmentRequestedCode' => '', 'receiverId' => '', 'receiverIdQualifier' => '', 'repetitionSeparator' => '', 'senderId' => '', 'senderIdQualifier' => '', 'usageIndicatorCode' => '', ], 'validateEdi' => true || false, ], ], ], ], 'createdAt' => , 'modifiedAt' => , 'name' => '', 'partnershipId' => '', 'profileId' => '', 'tradingPartnerId' => '', ], // ... ], ]

Result Details

Members

nextToken

partnerships

Required: Yes

Type: Array of PartnershipSummary structures

Specifies a list of your partnerships.

Errors

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample ListPartnerships call

result=result = result=client->listPartnerships([ 'maxResults' => 50, 'nextToken' => 'foo', 'profileId' => 'p-60fbc37c87f04fce9', ]);

Result syntax:

[ 'nextToken' => 'string', 'partnerships' => [ [ 'name' => 'b2bipartner', 'capabilities' => [ 'ca-963a8121e4fc4e348', ], 'createdAt' => , 'modifiedAt' => , 'partnershipId' => 'ps-219fa02f5b4242af8', 'profileId' => 'p-60fbc37c87f04fce9', 'tradingPartnerId' => 'tp-2a17ca447f6f4a8a8', ], ], ]

ListProfiles

result=result = result=client->listProfiles([/* ... /]); promise=promise = promise=client->listProfilesAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->listProfiles([ 'maxResults' => , 'nextToken' => '', ]);

Parameter Details

Members

maxResults

Specifies the maximum number of profiles to return.

nextToken

Result Syntax

[ 'nextToken' => '', 'profiles' => [ [ 'businessName' => '', 'createdAt' => , 'logGroupName' => '', 'logging' => 'ENABLED|DISABLED', 'modifiedAt' => , 'name' => '', 'profileId' => '', ], // ... ], ]

Result Details

Members

nextToken

profiles

Required: Yes

Type: Array of ProfileSummary structures

Returns an array of ProfileSummary objects.

Errors

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample ListProfiles call

result=result = result=client->listProfiles([ 'maxResults' => 50, 'nextToken' => 'foo', ]);

Result syntax:

[ 'nextToken' => 'foo', 'profiles' => [ [ 'name' => 'Shipping Profile', 'businessName' => 'John's Trucking', 'createdAt' => , 'logGroupName' => 'b2bi/p-60fbc37c87f04fce9-Logs', 'logging' => 'ENABLED', 'profileId' => 'p-60fbc37c87f04fce9', ], ], ]

ListTagsForResource

result=result = result=client->listTagsForResource([/* ... /]); promise=promise = promise=client->listTagsForResourceAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->listTagsForResource([ 'ResourceARN' => '', // REQUIRED ]);

Parameter Details

Members

ResourceARN

Required: Yes

Type: string

Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

Result Syntax

[ 'Tags' => [ [ 'Key' => '', 'Value' => '', ], // ... ], ]

Result Details

Members

Tags

Type: Array of Tag structures

Returns the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

Errors

Occurs when a B2BI object cannot be validated against a request from another object.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample ListTagsForResources call

result=result = result=client->listTagsForResource([ 'ResourceARN' => 'arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9', ]);

Result syntax:

[ 'Tags' => [ [ 'Key' => 'sampleKey', 'Value' => 'SampleValue', ], ], ]

ListTransformers

result=result = result=client->listTransformers([/* ... /]); promise=promise = promise=client->listTransformersAsync([/ ... */]);

Lists the available transformers. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.

Parameter Syntax

result=result = result=client->listTransformers([ 'maxResults' => , 'nextToken' => '', ]);

Parameter Details

Members

maxResults

Specifies the number of items to return for the API response.

nextToken

Result Syntax

[ 'nextToken' => '', 'transformers' => [ [ 'createdAt' => , 'ediType' => [ 'x12Details' => [ 'transactionSet' => 'X12_100|X12_101|X12_102|X12_103|X12_104|X12_105|X12_106|X12_107|X12_108|X12_109|X12_110|X12_111|X12_112|X12_113|X12_120|X12_121|X12_124|X12_125|X12_126|X12_127|X12_128|X12_129|X12_130|X12_131|X12_132|X12_133|X12_135|X12_138|X12_139|X12_140|X12_141|X12_142|X12_143|X12_144|X12_146|X12_147|X12_148|X12_149|X12_150|X12_151|X12_152|X12_153|X12_154|X12_155|X12_157|X12_158|X12_159|X12_160|X12_161|X12_163|X12_170|X12_175|X12_176|X12_179|X12_180|X12_185|X12_186|X12_187|X12_188|X12_189|X12_190|X12_191|X12_194|X12_195|X12_196|X12_197|X12_198|X12_199|X12_200|X12_201|X12_202|X12_203|X12_204|X12_205|X12_206|X12_210|X12_211|X12_212|X12_213|X12_214|X12_215|X12_216|X12_217|X12_218|X12_219|X12_220|X12_222|X12_223|X12_224|X12_225|X12_227|X12_228|X12_240|X12_242|X12_244|X12_245|X12_248|X12_249|X12_250|X12_251|X12_252|X12_255|X12_256|X12_259|X12_260|X12_261|X12_262|X12_263|X12_264|X12_265|X12_266|X12_267|X12_268|X12_269|X12_270|X12_271|X12_272|X12_273|X12_274|X12_275|X12_276|X12_277|X12_278|X12_280|X12_283|X12_284|X12_285|X12_286|X12_288|X12_290|X12_300|X12_301|X12_303|X12_304|X12_309|X12_310|X12_311|X12_312|X12_313|X12_315|X12_317|X12_319|X12_322|X12_323|X12_324|X12_325|X12_326|X12_350|X12_352|X12_353|X12_354|X12_355|X12_356|X12_357|X12_358|X12_361|X12_362|X12_404|X12_410|X12_412|X12_414|X12_417|X12_418|X12_419|X12_420|X12_421|X12_422|X12_423|X12_424|X12_425|X12_426|X12_429|X12_431|X12_432|X12_433|X12_434|X12_435|X12_436|X12_437|X12_440|X12_451|X12_452|X12_453|X12_455|X12_456|X12_460|X12_463|X12_466|X12_468|X12_470|X12_475|X12_485|X12_486|X12_490|X12_492|X12_494|X12_500|X12_501|X12_503|X12_504|X12_511|X12_517|X12_521|X12_527|X12_536|X12_540|X12_561|X12_567|X12_568|X12_601|X12_602|X12_620|X12_625|X12_650|X12_715|X12_753|X12_754|X12_805|X12_806|X12_810|X12_811|X12_812|X12_813|X12_814|X12_815|X12_816|X12_818|X12_819|X12_820|X12_821|X12_822|X12_823|X12_824|X12_826|X12_827|X12_828|X12_829|X12_830|X12_831|X12_832|X12_833|X12_834|X12_835|X12_836|X12_837|X12_838|X12_839|X12_840|X12_841|X12_842|X12_843|X12_844|X12_845|X12_846|X12_847|X12_848|X12_849|X12_850|X12_851|X12_852|X12_853|X12_854|X12_855|X12_856|X12_857|X12_858|X12_859|X12_860|X12_861|X12_862|X12_863|X12_864|X12_865|X12_866|X12_867|X12_868|X12_869|X12_870|X12_871|X12_872|X12_873|X12_874|X12_875|X12_876|X12_877|X12_878|X12_879|X12_880|X12_881|X12_882|X12_883|X12_884|X12_885|X12_886|X12_887|X12_888|X12_889|X12_891|X12_893|X12_894|X12_895|X12_896|X12_920|X12_924|X12_925|X12_926|X12_928|X12_940|X12_943|X12_944|X12_945|X12_947|X12_980|X12_990|X12_993|X12_996|X12_997|X12_998|X12_999|X12_270_X279|X12_271_X279|X12_275_X210|X12_275_X211|X12_276_X212|X12_277_X212|X12_277_X214|X12_277_X364|X12_278_X217|X12_820_X218|X12_820_X306|X12_824_X186|X12_834_X220|X12_834_X307|X12_834_X318|X12_835_X221|X12_837_X222|X12_837_X223|X12_837_X224|X12_837_X291|X12_837_X292|X12_837_X298|X12_999_X231', 'version' => 'VERSION_4010|VERSION_4030|VERSION_4050|VERSION_4060|VERSION_5010|VERSION_5010_HIPAA', ], ], 'fileFormat' => 'XML|JSON|NOT_USED', 'inputConversion' => [ 'formatOptions' => [ 'x12' => [ 'transactionSet' => 'X12_100|X12_101|X12_102|X12_103|X12_104|X12_105|X12_106|X12_107|X12_108|X12_109|X12_110|X12_111|X12_112|X12_113|X12_120|X12_121|X12_124|X12_125|X12_126|X12_127|X12_128|X12_129|X12_130|X12_131|X12_132|X12_133|X12_135|X12_138|X12_139|X12_140|X12_141|X12_142|X12_143|X12_144|X12_146|X12_147|X12_148|X12_149|X12_150|X12_151|X12_152|X12_153|X12_154|X12_155|X12_157|X12_158|X12_159|X12_160|X12_161|X12_163|X12_170|X12_175|X12_176|X12_179|X12_180|X12_185|X12_186|X12_187|X12_188|X12_189|X12_190|X12_191|X12_194|X12_195|X12_196|X12_197|X12_198|X12_199|X12_200|X12_201|X12_202|X12_203|X12_204|X12_205|X12_206|X12_210|X12_211|X12_212|X12_213|X12_214|X12_215|X12_216|X12_217|X12_218|X12_219|X12_220|X12_222|X12_223|X12_224|X12_225|X12_227|X12_228|X12_240|X12_242|X12_244|X12_245|X12_248|X12_249|X12_250|X12_251|X12_252|X12_255|X12_256|X12_259|X12_260|X12_261|X12_262|X12_263|X12_264|X12_265|X12_266|X12_267|X12_268|X12_269|X12_270|X12_271|X12_272|X12_273|X12_274|X12_275|X12_276|X12_277|X12_278|X12_280|X12_283|X12_284|X12_285|X12_286|X12_288|X12_290|X12_300|X12_301|X12_303|X12_304|X12_309|X12_310|X12_311|X12_312|X12_313|X12_315|X12_317|X12_319|X12_322|X12_323|X12_324|X12_325|X12_326|X12_350|X12_352|X12_353|X12_354|X12_355|X12_356|X12_357|X12_358|X12_361|X12_362|X12_404|X12_410|X12_412|X12_414|X12_417|X12_418|X12_419|X12_420|X12_421|X12_422|X12_423|X12_424|X12_425|X12_426|X12_429|X12_431|X12_432|X12_433|X12_434|X12_435|X12_436|X12_437|X12_440|X12_451|X12_452|X12_453|X12_455|X12_456|X12_460|X12_463|X12_466|X12_468|X12_470|X12_475|X12_485|X12_486|X12_490|X12_492|X12_494|X12_500|X12_501|X12_503|X12_504|X12_511|X12_517|X12_521|X12_527|X12_536|X12_540|X12_561|X12_567|X12_568|X12_601|X12_602|X12_620|X12_625|X12_650|X12_715|X12_753|X12_754|X12_805|X12_806|X12_810|X12_811|X12_812|X12_813|X12_814|X12_815|X12_816|X12_818|X12_819|X12_820|X12_821|X12_822|X12_823|X12_824|X12_826|X12_827|X12_828|X12_829|X12_830|X12_831|X12_832|X12_833|X12_834|X12_835|X12_836|X12_837|X12_838|X12_839|X12_840|X12_841|X12_842|X12_843|X12_844|X12_845|X12_846|X12_847|X12_848|X12_849|X12_850|X12_851|X12_852|X12_853|X12_854|X12_855|X12_856|X12_857|X12_858|X12_859|X12_860|X12_861|X12_862|X12_863|X12_864|X12_865|X12_866|X12_867|X12_868|X12_869|X12_870|X12_871|X12_872|X12_873|X12_874|X12_875|X12_876|X12_877|X12_878|X12_879|X12_880|X12_881|X12_882|X12_883|X12_884|X12_885|X12_886|X12_887|X12_888|X12_889|X12_891|X12_893|X12_894|X12_895|X12_896|X12_920|X12_924|X12_925|X12_926|X12_928|X12_940|X12_943|X12_944|X12_945|X12_947|X12_980|X12_990|X12_993|X12_996|X12_997|X12_998|X12_999|X12_270_X279|X12_271_X279|X12_275_X210|X12_275_X211|X12_276_X212|X12_277_X212|X12_277_X214|X12_277_X364|X12_278_X217|X12_820_X218|X12_820_X306|X12_824_X186|X12_834_X220|X12_834_X307|X12_834_X318|X12_835_X221|X12_837_X222|X12_837_X223|X12_837_X224|X12_837_X291|X12_837_X292|X12_837_X298|X12_999_X231', 'version' => 'VERSION_4010|VERSION_4030|VERSION_4050|VERSION_4060|VERSION_5010|VERSION_5010_HIPAA', ], ], 'fromFormat' => 'X12', ], 'mapping' => [ 'template' => '', 'templateLanguage' => 'XSLT|JSONATA', ], 'mappingTemplate' => '', 'modifiedAt' => , 'name' => '', 'outputConversion' => [ 'formatOptions' => [ 'x12' => [ 'transactionSet' => 'X12_100|X12_101|X12_102|X12_103|X12_104|X12_105|X12_106|X12_107|X12_108|X12_109|X12_110|X12_111|X12_112|X12_113|X12_120|X12_121|X12_124|X12_125|X12_126|X12_127|X12_128|X12_129|X12_130|X12_131|X12_132|X12_133|X12_135|X12_138|X12_139|X12_140|X12_141|X12_142|X12_143|X12_144|X12_146|X12_147|X12_148|X12_149|X12_150|X12_151|X12_152|X12_153|X12_154|X12_155|X12_157|X12_158|X12_159|X12_160|X12_161|X12_163|X12_170|X12_175|X12_176|X12_179|X12_180|X12_185|X12_186|X12_187|X12_188|X12_189|X12_190|X12_191|X12_194|X12_195|X12_196|X12_197|X12_198|X12_199|X12_200|X12_201|X12_202|X12_203|X12_204|X12_205|X12_206|X12_210|X12_211|X12_212|X12_213|X12_214|X12_215|X12_216|X12_217|X12_218|X12_219|X12_220|X12_222|X12_223|X12_224|X12_225|X12_227|X12_228|X12_240|X12_242|X12_244|X12_245|X12_248|X12_249|X12_250|X12_251|X12_252|X12_255|X12_256|X12_259|X12_260|X12_261|X12_262|X12_263|X12_264|X12_265|X12_266|X12_267|X12_268|X12_269|X12_270|X12_271|X12_272|X12_273|X12_274|X12_275|X12_276|X12_277|X12_278|X12_280|X12_283|X12_284|X12_285|X12_286|X12_288|X12_290|X12_300|X12_301|X12_303|X12_304|X12_309|X12_310|X12_311|X12_312|X12_313|X12_315|X12_317|X12_319|X12_322|X12_323|X12_324|X12_325|X12_326|X12_350|X12_352|X12_353|X12_354|X12_355|X12_356|X12_357|X12_358|X12_361|X12_362|X12_404|X12_410|X12_412|X12_414|X12_417|X12_418|X12_419|X12_420|X12_421|X12_422|X12_423|X12_424|X12_425|X12_426|X12_429|X12_431|X12_432|X12_433|X12_434|X12_435|X12_436|X12_437|X12_440|X12_451|X12_452|X12_453|X12_455|X12_456|X12_460|X12_463|X12_466|X12_468|X12_470|X12_475|X12_485|X12_486|X12_490|X12_492|X12_494|X12_500|X12_501|X12_503|X12_504|X12_511|X12_517|X12_521|X12_527|X12_536|X12_540|X12_561|X12_567|X12_568|X12_601|X12_602|X12_620|X12_625|X12_650|X12_715|X12_753|X12_754|X12_805|X12_806|X12_810|X12_811|X12_812|X12_813|X12_814|X12_815|X12_816|X12_818|X12_819|X12_820|X12_821|X12_822|X12_823|X12_824|X12_826|X12_827|X12_828|X12_829|X12_830|X12_831|X12_832|X12_833|X12_834|X12_835|X12_836|X12_837|X12_838|X12_839|X12_840|X12_841|X12_842|X12_843|X12_844|X12_845|X12_846|X12_847|X12_848|X12_849|X12_850|X12_851|X12_852|X12_853|X12_854|X12_855|X12_856|X12_857|X12_858|X12_859|X12_860|X12_861|X12_862|X12_863|X12_864|X12_865|X12_866|X12_867|X12_868|X12_869|X12_870|X12_871|X12_872|X12_873|X12_874|X12_875|X12_876|X12_877|X12_878|X12_879|X12_880|X12_881|X12_882|X12_883|X12_884|X12_885|X12_886|X12_887|X12_888|X12_889|X12_891|X12_893|X12_894|X12_895|X12_896|X12_920|X12_924|X12_925|X12_926|X12_928|X12_940|X12_943|X12_944|X12_945|X12_947|X12_980|X12_990|X12_993|X12_996|X12_997|X12_998|X12_999|X12_270_X279|X12_271_X279|X12_275_X210|X12_275_X211|X12_276_X212|X12_277_X212|X12_277_X214|X12_277_X364|X12_278_X217|X12_820_X218|X12_820_X306|X12_824_X186|X12_834_X220|X12_834_X307|X12_834_X318|X12_835_X221|X12_837_X222|X12_837_X223|X12_837_X224|X12_837_X291|X12_837_X292|X12_837_X298|X12_999_X231', 'version' => 'VERSION_4010|VERSION_4030|VERSION_4050|VERSION_4060|VERSION_5010|VERSION_5010_HIPAA', ], ], 'toFormat' => 'X12', ], 'sampleDocument' => '', 'sampleDocuments' => [ 'bucketName' => '', 'keys' => [ [ 'input' => '', 'output' => '', ], // ... ], ], 'status' => 'active|inactive', 'transformerId' => '', ], // ... ], ]

Result Details

Members

nextToken

transformers

Required: Yes

Type: Array of TransformerSummary structures

Returns an array of one or more transformer objects.

For each transformer, a TransformerSummary object is returned. The TransformerSummary contains all the details for a specific transformer.

Errors

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample ListTransformers call

result=result = result=client->listTransformers([ 'maxResults' => 50, 'nextToken' => 'foo', ]);

Result syntax:

[ 'nextToken' => 'foo', 'transformers' => [ [ 'name' => 'transformJSON', 'createdAt' => , 'ediType' => [ 'x12Details' => [ 'version' => 'VERSION_4010', 'transactionSet' => 'X12_110', ], ], 'fileFormat' => 'JSON', 'mappingTemplate' => '$', 'modifiedAt' => , 'sampleDocument' => 's3://test-bucket/sampleDoc.txt', 'status' => 'inactive', 'transformerId' => 'tr-974c129999f84d8c9', ], ], ]

StartTransformerJob

result=result = result=client->startTransformerJob([/* ... /]); promise=promise = promise=client->startTransformerJobAsync([/ ... */]);

Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2B Data Interchange.

If you only want to transform EDI (electronic data interchange) documents, you don't need to create profiles, partnerships or capabilities. Just create and configure a transformer, and then run the StartTransformerJob API to process your files.

Parameter Syntax

result=result = result=client->startTransformerJob([ 'clientToken' => '', 'inputFile' => [ // REQUIRED 'bucketName' => '', 'key' => '', ], 'outputLocation' => [ // REQUIRED 'bucketName' => '', 'key' => '', ], 'transformerId' => '', // REQUIRED ]);

Parameter Details

Members

clientToken

Reserved for future use.

inputFile

Required: Yes

Type: S3Location structure

Specifies the location of the input file for the transformation. The location consists of an Amazon S3 bucket and prefix.

outputLocation

Required: Yes

Type: S3Location structure

Specifies the location of the output file for the transformation. The location consists of an Amazon S3 bucket and prefix.

transformerId

Required: Yes

Type: string

Specifies the system-assigned unique identifier for the transformer.

Result Syntax

[ 'transformerJobId' => '', ]

Result Details

Members

transformerJobId

Required: Yes

Type: string

Returns the unique, system-generated identifier for a transformer run.

Errors

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.

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample StartTransformerJob call

result=result = result=client->startTransformerJob([ 'clientToken' => 'foo', 'inputFile' => [ 'key' => 'input/inputFile.txt', 'bucketName' => 'test-bucket', ], 'outputLocation' => [ 'key' => 'output/', 'bucketName' => 'test-bucket', ], 'transformerId' => 'tr-974c129999f84d8c9', ]);

Result syntax:

[ 'transformerJobId' => 'tj-vpYxfV7yQOqjMSYllEslLw', ]

TagResource

result=result = result=client->tagResource([/* ... /]); promise=promise = promise=client->tagResourceAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->tagResource([ 'ResourceARN' => '', // REQUIRED 'Tags' => [ // REQUIRED [ 'Key' => '', // REQUIRED 'Value' => '', // REQUIRED ], // ... ], ]);

Parameter Details

Members

ResourceARN

Required: Yes

Type: string

Specifies an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

Tags

Required: Yes

Type: Array of Tag structures

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample TagResource call

result=result = result=client->tagResource([ 'ResourceARN' => 'arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9', 'Tags' => [ [ 'Key' => 'sampleKey', 'Value' => 'SampleValue', ], ], ]);

TestConversion

result=result = result=client->testConversion([/* ... /]); promise=promise = promise=client->testConversionAsync([/ ... */]);

This operation mimics the latter half of a typical Outbound EDI request. It takes an input JSON/XML in the B2Bi shape as input, converts it to an X12 EDI string, and return that string.

Parameter Syntax

result=result = result=client->testConversion([ 'source' => [ // REQUIRED 'fileFormat' => 'JSON|XML', // REQUIRED 'inputFile' => [ // REQUIRED 'fileContent' => '', ], ], 'target' => [ // REQUIRED 'fileFormat' => 'X12', // REQUIRED 'formatDetails' => [ 'x12' => [ 'transactionSet' => 'X12_100|X12_101|X12_102|X12_103|X12_104|X12_105|X12_106|X12_107|X12_108|X12_109|X12_110|X12_111|X12_112|X12_113|X12_120|X12_121|X12_124|X12_125|X12_126|X12_127|X12_128|X12_129|X12_130|X12_131|X12_132|X12_133|X12_135|X12_138|X12_139|X12_140|X12_141|X12_142|X12_143|X12_144|X12_146|X12_147|X12_148|X12_149|X12_150|X12_151|X12_152|X12_153|X12_154|X12_155|X12_157|X12_158|X12_159|X12_160|X12_161|X12_163|X12_170|X12_175|X12_176|X12_179|X12_180|X12_185|X12_186|X12_187|X12_188|X12_189|X12_190|X12_191|X12_194|X12_195|X12_196|X12_197|X12_198|X12_199|X12_200|X12_201|X12_202|X12_203|X12_204|X12_205|X12_206|X12_210|X12_211|X12_212|X12_213|X12_214|X12_215|X12_216|X12_217|X12_218|X12_219|X12_220|X12_222|X12_223|X12_224|X12_225|X12_227|X12_228|X12_240|X12_242|X12_244|X12_245|X12_248|X12_249|X12_250|X12_251|X12_252|X12_255|X12_256|X12_259|X12_260|X12_261|X12_262|X12_263|X12_264|X12_265|X12_266|X12_267|X12_268|X12_269|X12_270|X12_271|X12_272|X12_273|X12_274|X12_275|X12_276|X12_277|X12_278|X12_280|X12_283|X12_284|X12_285|X12_286|X12_288|X12_290|X12_300|X12_301|X12_303|X12_304|X12_309|X12_310|X12_311|X12_312|X12_313|X12_315|X12_317|X12_319|X12_322|X12_323|X12_324|X12_325|X12_326|X12_350|X12_352|X12_353|X12_354|X12_355|X12_356|X12_357|X12_358|X12_361|X12_362|X12_404|X12_410|X12_412|X12_414|X12_417|X12_418|X12_419|X12_420|X12_421|X12_422|X12_423|X12_424|X12_425|X12_426|X12_429|X12_431|X12_432|X12_433|X12_434|X12_435|X12_436|X12_437|X12_440|X12_451|X12_452|X12_453|X12_455|X12_456|X12_460|X12_463|X12_466|X12_468|X12_470|X12_475|X12_485|X12_486|X12_490|X12_492|X12_494|X12_500|X12_501|X12_503|X12_504|X12_511|X12_517|X12_521|X12_527|X12_536|X12_540|X12_561|X12_567|X12_568|X12_601|X12_602|X12_620|X12_625|X12_650|X12_715|X12_753|X12_754|X12_805|X12_806|X12_810|X12_811|X12_812|X12_813|X12_814|X12_815|X12_816|X12_818|X12_819|X12_820|X12_821|X12_822|X12_823|X12_824|X12_826|X12_827|X12_828|X12_829|X12_830|X12_831|X12_832|X12_833|X12_834|X12_835|X12_836|X12_837|X12_838|X12_839|X12_840|X12_841|X12_842|X12_843|X12_844|X12_845|X12_846|X12_847|X12_848|X12_849|X12_850|X12_851|X12_852|X12_853|X12_854|X12_855|X12_856|X12_857|X12_858|X12_859|X12_860|X12_861|X12_862|X12_863|X12_864|X12_865|X12_866|X12_867|X12_868|X12_869|X12_870|X12_871|X12_872|X12_873|X12_874|X12_875|X12_876|X12_877|X12_878|X12_879|X12_880|X12_881|X12_882|X12_883|X12_884|X12_885|X12_886|X12_887|X12_888|X12_889|X12_891|X12_893|X12_894|X12_895|X12_896|X12_920|X12_924|X12_925|X12_926|X12_928|X12_940|X12_943|X12_944|X12_945|X12_947|X12_980|X12_990|X12_993|X12_996|X12_997|X12_998|X12_999|X12_270_X279|X12_271_X279|X12_275_X210|X12_275_X211|X12_276_X212|X12_277_X212|X12_277_X214|X12_277_X364|X12_278_X217|X12_820_X218|X12_820_X306|X12_824_X186|X12_834_X220|X12_834_X307|X12_834_X318|X12_835_X221|X12_837_X222|X12_837_X223|X12_837_X224|X12_837_X291|X12_837_X292|X12_837_X298|X12_999_X231', 'version' => 'VERSION_4010|VERSION_4030|VERSION_4050|VERSION_4060|VERSION_5010|VERSION_5010_HIPAA', ], ], 'outputSampleFile' => [ 'fileLocation' => [ 'bucketName' => '', 'key' => '', ], ], ], ]);

Parameter Details

Members

source

Required: Yes

Type: ConversionSource structure

Specify the source file for an outbound EDI request.

target

Required: Yes

Type: ConversionTarget structure

Specify the format (X12 is the only currently supported format), and other details for the conversion target.

Result Syntax

[ 'convertedFileContent' => '', 'validationMessages' => ['', ...], ]

Result Details

Members

convertedFileContent

Required: Yes

Type: string

Returns the converted file content.

validationMessages

Returns an array of strings, each containing a message that Amazon Web Services B2B Data Interchange generates during the conversion.

Errors

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample TestConversion call

result=result = result=client->testConversion([ 'source' => [ 'fileFormat' => 'JSON', 'inputFile' => [ 'fileContent' => 'Sample file content', ], ], 'target' => [ 'fileFormat' => 'X12', 'formatDetails' => [ 'x12' => [ 'version' => 'VERSION_4010', 'transactionSet' => 'X12_110', ], ], ], ]);

Result syntax:

[ 'convertedFileContent' => 'Sample converted file content', 'validationMessages' => [ ], ]

TestMapping

result=result = result=client->testMapping([/* ... /]); promise=promise = promise=client->testMappingAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->testMapping([ 'fileFormat' => 'XML|JSON|NOT_USED', // REQUIRED 'inputFileContent' => '', // REQUIRED 'mappingTemplate' => '', // REQUIRED ]);

Parameter Details

Members

fileFormat

Required: Yes

Type: string

Specifies that the currently supported file formats for EDI transformations are JSON and XML.

inputFileContent

Required: Yes

Type: string

Specify the contents of the EDI (electronic data interchange) XML or JSON file that is used as input for the transform.

mappingTemplate

Required: Yes

Type: string

Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

This parameter is available for backwards compatibility. Use the Mapping data type instead.

Result Syntax

[ 'mappedFileContent' => '', ]

Result Details

Members

mappedFileContent

Required: Yes

Type: string

Returns a string for the mapping that can be used to identify the mapping. Similar to a fingerprint

Errors

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample TestMapping call

result=result = result=client->testMapping([ 'fileFormat' => 'JSON', 'inputFileContent' => 'Sample file content', 'mappingTemplate' => '$', ]);

Result syntax:

[ 'mappedFileContent' => 'Sample file content', ]

TestParsing

result=result = result=client->testParsing([/* ... /]); promise=promise = promise=client->testParsingAsync([/ ... */]);

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

Parameter Syntax

result=result = result=client->testParsing([ 'ediType' => [ // REQUIRED 'x12Details' => [ 'transactionSet' => 'X12_100|X12_101|X12_102|X12_103|X12_104|X12_105|X12_106|X12_107|X12_108|X12_109|X12_110|X12_111|X12_112|X12_113|X12_120|X12_121|X12_124|X12_125|X12_126|X12_127|X12_128|X12_129|X12_130|X12_131|X12_132|X12_133|X12_135|X12_138|X12_139|X12_140|X12_141|X12_142|X12_143|X12_144|X12_146|X12_147|X12_148|X12_149|X12_150|X12_151|X12_152|X12_153|X12_154|X12_155|X12_157|X12_158|X12_159|X12_160|X12_161|X12_163|X12_170|X12_175|X12_176|X12_179|X12_180|X12_185|X12_186|X12_187|X12_188|X12_189|X12_190|X12_191|X12_194|X12_195|X12_196|X12_197|X12_198|X12_199|X12_200|X12_201|X12_202|X12_203|X12_204|X12_205|X12_206|X12_210|X12_211|X12_212|X12_213|X12_214|X12_215|X12_216|X12_217|X12_218|X12_219|X12_220|X12_222|X12_223|X12_224|X12_225|X12_227|X12_228|X12_240|X12_242|X12_244|X12_245|X12_248|X12_249|X12_250|X12_251|X12_252|X12_255|X12_256|X12_259|X12_260|X12_261|X12_262|X12_263|X12_264|X12_265|X12_266|X12_267|X12_268|X12_269|X12_270|X12_271|X12_272|X12_273|X12_274|X12_275|X12_276|X12_277|X12_278|X12_280|X12_283|X12_284|X12_285|X12_286|X12_288|X12_290|X12_300|X12_301|X12_303|X12_304|X12_309|X12_310|X12_311|X12_312|X12_313|X12_315|X12_317|X12_319|X12_322|X12_323|X12_324|X12_325|X12_326|X12_350|X12_352|X12_353|X12_354|X12_355|X12_356|X12_357|X12_358|X12_361|X12_362|X12_404|X12_410|X12_412|X12_414|X12_417|X12_418|X12_419|X12_420|X12_421|X12_422|X12_423|X12_424|X12_425|X12_426|X12_429|X12_431|X12_432|X12_433|X12_434|X12_435|X12_436|X12_437|X12_440|X12_451|X12_452|X12_453|X12_455|X12_456|X12_460|X12_463|X12_466|X12_468|X12_470|X12_475|X12_485|X12_486|X12_490|X12_492|X12_494|X12_500|X12_501|X12_503|X12_504|X12_511|X12_517|X12_521|X12_527|X12_536|X12_540|X12_561|X12_567|X12_568|X12_601|X12_602|X12_620|X12_625|X12_650|X12_715|X12_753|X12_754|X12_805|X12_806|X12_810|X12_811|X12_812|X12_813|X12_814|X12_815|X12_816|X12_818|X12_819|X12_820|X12_821|X12_822|X12_823|X12_824|X12_826|X12_827|X12_828|X12_829|X12_830|X12_831|X12_832|X12_833|X12_834|X12_835|X12_836|X12_837|X12_838|X12_839|X12_840|X12_841|X12_842|X12_843|X12_844|X12_845|X12_846|X12_847|X12_848|X12_849|X12_850|X12_851|X12_852|X12_853|X12_854|X12_855|X12_856|X12_857|X12_858|X12_859|X12_860|X12_861|X12_862|X12_863|X12_864|X12_865|X12_866|X12_867|X12_868|X12_869|X12_870|X12_871|X12_872|X12_873|X12_874|X12_875|X12_876|X12_877|X12_878|X12_879|X12_880|X12_881|X12_882|X12_883|X12_884|X12_885|X12_886|X12_887|X12_888|X12_889|X12_891|X12_893|X12_894|X12_895|X12_896|X12_920|X12_924|X12_925|X12_926|X12_928|X12_940|X12_943|X12_944|X12_945|X12_947|X12_980|X12_990|X12_993|X12_996|X12_997|X12_998|X12_999|X12_270_X279|X12_271_X279|X12_275_X210|X12_275_X211|X12_276_X212|X12_277_X212|X12_277_X214|X12_277_X364|X12_278_X217|X12_820_X218|X12_820_X306|X12_824_X186|X12_834_X220|X12_834_X307|X12_834_X318|X12_835_X221|X12_837_X222|X12_837_X223|X12_837_X224|X12_837_X291|X12_837_X292|X12_837_X298|X12_999_X231', 'version' => 'VERSION_4010|VERSION_4030|VERSION_4050|VERSION_4060|VERSION_5010|VERSION_5010_HIPAA', ], ], 'fileFormat' => 'XML|JSON|NOT_USED', // REQUIRED 'inputFile' => [ // REQUIRED 'bucketName' => '', 'key' => '', ], ]);

Parameter Details

Members

ediType

Required: Yes

Type: EdiType structure

fileFormat

Required: Yes

Type: string

Specifies that the currently supported file formats for EDI transformations are JSON and XML.

inputFile

Required: Yes

Type: S3Location structure

Specifies an S3Location object, which contains the Amazon S3 bucket and prefix for the location of the input file.

Result Syntax

[ 'parsedFileContent' => '', ]

Result Details

Members

parsedFileContent

Required: Yes

Type: string

Returns the contents of the input file being tested, parsed according to the specified EDI (electronic data interchange) type.

Errors

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample TestParsing call

result=result = result=client->testParsing([ 'ediType' => [ 'x12Details' => [ 'version' => 'VERSION_4010', 'transactionSet' => 'X12_110', ], ], 'fileFormat' => 'JSON', 'inputFile' => [ 'key' => 'sampleFile.txt', 'bucketName' => 'test-bucket', ], ]);

Result syntax:

[ 'parsedFileContent' => 'Sample parsed file content', ]

UntagResource

result=result = result=client->untagResource([/* ... /]); promise=promise = promise=client->untagResourceAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->untagResource([ 'ResourceARN' => '', // REQUIRED 'TagKeys' => ['', ...], // REQUIRED ]);

Parameter Details

Members

ResourceARN

Required: Yes

Type: string

Specifies an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

TagKeys

Required: Yes

Type: Array of strings

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

Occurs when a B2BI object cannot be validated against a request from another object.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample UntagResource call

result=result = result=client->untagResource([ 'ResourceARN' => 'arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9', 'TagKeys' => [ 'sampleKey', ], ]);

UpdateCapability

result=result = result=client->updateCapability([/* ... /]); promise=promise = promise=client->updateCapabilityAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->updateCapability([ 'capabilityId' => '', // REQUIRED 'configuration' => [ 'edi' => [ 'capabilityDirection' => 'INBOUND|OUTBOUND', 'inputLocation' => [ // REQUIRED 'bucketName' => '', 'key' => '', ], 'outputLocation' => [ // REQUIRED 'bucketName' => '', 'key' => '', ], 'transformerId' => '', // REQUIRED 'type' => [ // REQUIRED 'x12Details' => [ 'transactionSet' => 'X12_100|X12_101|X12_102|X12_103|X12_104|X12_105|X12_106|X12_107|X12_108|X12_109|X12_110|X12_111|X12_112|X12_113|X12_120|X12_121|X12_124|X12_125|X12_126|X12_127|X12_128|X12_129|X12_130|X12_131|X12_132|X12_133|X12_135|X12_138|X12_139|X12_140|X12_141|X12_142|X12_143|X12_144|X12_146|X12_147|X12_148|X12_149|X12_150|X12_151|X12_152|X12_153|X12_154|X12_155|X12_157|X12_158|X12_159|X12_160|X12_161|X12_163|X12_170|X12_175|X12_176|X12_179|X12_180|X12_185|X12_186|X12_187|X12_188|X12_189|X12_190|X12_191|X12_194|X12_195|X12_196|X12_197|X12_198|X12_199|X12_200|X12_201|X12_202|X12_203|X12_204|X12_205|X12_206|X12_210|X12_211|X12_212|X12_213|X12_214|X12_215|X12_216|X12_217|X12_218|X12_219|X12_220|X12_222|X12_223|X12_224|X12_225|X12_227|X12_228|X12_240|X12_242|X12_244|X12_245|X12_248|X12_249|X12_250|X12_251|X12_252|X12_255|X12_256|X12_259|X12_260|X12_261|X12_262|X12_263|X12_264|X12_265|X12_266|X12_267|X12_268|X12_269|X12_270|X12_271|X12_272|X12_273|X12_274|X12_275|X12_276|X12_277|X12_278|X12_280|X12_283|X12_284|X12_285|X12_286|X12_288|X12_290|X12_300|X12_301|X12_303|X12_304|X12_309|X12_310|X12_311|X12_312|X12_313|X12_315|X12_317|X12_319|X12_322|X12_323|X12_324|X12_325|X12_326|X12_350|X12_352|X12_353|X12_354|X12_355|X12_356|X12_357|X12_358|X12_361|X12_362|X12_404|X12_410|X12_412|X12_414|X12_417|X12_418|X12_419|X12_420|X12_421|X12_422|X12_423|X12_424|X12_425|X12_426|X12_429|X12_431|X12_432|X12_433|X12_434|X12_435|X12_436|X12_437|X12_440|X12_451|X12_452|X12_453|X12_455|X12_456|X12_460|X12_463|X12_466|X12_468|X12_470|X12_475|X12_485|X12_486|X12_490|X12_492|X12_494|X12_500|X12_501|X12_503|X12_504|X12_511|X12_517|X12_521|X12_527|X12_536|X12_540|X12_561|X12_567|X12_568|X12_601|X12_602|X12_620|X12_625|X12_650|X12_715|X12_753|X12_754|X12_805|X12_806|X12_810|X12_811|X12_812|X12_813|X12_814|X12_815|X12_816|X12_818|X12_819|X12_820|X12_821|X12_822|X12_823|X12_824|X12_826|X12_827|X12_828|X12_829|X12_830|X12_831|X12_832|X12_833|X12_834|X12_835|X12_836|X12_837|X12_838|X12_839|X12_840|X12_841|X12_842|X12_843|X12_844|X12_845|X12_846|X12_847|X12_848|X12_849|X12_850|X12_851|X12_852|X12_853|X12_854|X12_855|X12_856|X12_857|X12_858|X12_859|X12_860|X12_861|X12_862|X12_863|X12_864|X12_865|X12_866|X12_867|X12_868|X12_869|X12_870|X12_871|X12_872|X12_873|X12_874|X12_875|X12_876|X12_877|X12_878|X12_879|X12_880|X12_881|X12_882|X12_883|X12_884|X12_885|X12_886|X12_887|X12_888|X12_889|X12_891|X12_893|X12_894|X12_895|X12_896|X12_920|X12_924|X12_925|X12_926|X12_928|X12_940|X12_943|X12_944|X12_945|X12_947|X12_980|X12_990|X12_993|X12_996|X12_997|X12_998|X12_999|X12_270_X279|X12_271_X279|X12_275_X210|X12_275_X211|X12_276_X212|X12_277_X212|X12_277_X214|X12_277_X364|X12_278_X217|X12_820_X218|X12_820_X306|X12_824_X186|X12_834_X220|X12_834_X307|X12_834_X318|X12_835_X221|X12_837_X222|X12_837_X223|X12_837_X224|X12_837_X291|X12_837_X292|X12_837_X298|X12_999_X231', 'version' => 'VERSION_4010|VERSION_4030|VERSION_4050|VERSION_4060|VERSION_5010|VERSION_5010_HIPAA', ], ], ], ], 'instructionsDocuments' => [ [ 'bucketName' => '', 'key' => '', ], // ... ], 'name' => '', ]);

Parameter Details

Members

capabilityId

Required: Yes

Type: string

Specifies a system-assigned unique identifier for the capability.

configuration

Type: CapabilityConfiguration structure

Specifies a structure that contains the details for a capability.

instructionsDocuments

Type: Array of S3Location structures

name

Specifies a new name for the capability, to replace the existing name.

Result Syntax

Result Details

Members

capabilityArn

Required: Yes

Type: string

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

capabilityId

Required: Yes

Type: string

Returns a system-assigned unique identifier for the capability.

configuration

Required: Yes

Type: CapabilityConfiguration structure

Returns a structure that contains the details for a capability.

createdAt

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns a timestamp for creation date and time of the capability.

instructionsDocuments

Type: Array of S3Location structures

modifiedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns a timestamp for last time the capability was modified.

name

Required: Yes

Type: string

Returns the name of the capability, used to identify it.

type

Required: Yes

Type: string

Returns the type of the capability. Currently, only edi is supported.

Errors

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.

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample UpdateCapability call

result=result = result=client->updateCapability([ 'name' => 'b2biexample', 'capabilityId' => 'ca-963a8121e4fc4e348', 'configuration' => [ 'edi' => [ 'type' => [ 'x12Details' => [ 'version' => 'VERSION_4010', 'transactionSet' => 'X12_110', ], ], 'inputLocation' => [ 'key' => 'input/', 'bucketName' => 'test-bucket', ], 'outputLocation' => [ 'key' => 'output/', 'bucketName' => 'test-bucket', ], 'transformerId' => 'tr-9a893cf536df4658b', ], ], 'instructionsDocuments' => [ [ 'key' => 'instructiondoc.txt', 'bucketName' => 'test-bucket', ], ], ]);

Result syntax:

UpdatePartnership

result=result = result=client->updatePartnership([/* ... /]); promise=promise = promise=client->updatePartnershipAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->updatePartnership([ 'capabilities' => ['', ...], 'capabilityOptions' => [ 'outboundEdi' => [ 'x12' => [ 'common' => [ 'delimiters' => [ 'componentSeparator' => '', 'dataElementSeparator' => '', 'segmentTerminator' => '', ], 'functionalGroupHeaders' => [ 'applicationReceiverCode' => '', 'applicationSenderCode' => '', 'responsibleAgencyCode' => '', ], 'interchangeControlHeaders' => [ 'acknowledgmentRequestedCode' => '', 'receiverId' => '', 'receiverIdQualifier' => '', 'repetitionSeparator' => '', 'senderId' => '', 'senderIdQualifier' => '', 'usageIndicatorCode' => '', ], 'validateEdi' => true || false, ], ], ], ], 'name' => '', 'partnershipId' => '', // REQUIRED ]);

Parameter Details

Members

capabilities

List of the capabilities associated with this partnership.

capabilityOptions

Type: CapabilityOptions structure

To update, specify the structure that contains the details for the associated capabilities.

name

The name of the partnership, used to identify it.

partnershipId

Required: Yes

Type: string

Specifies the unique, system-generated identifier for a partnership.

Result Syntax

[ 'capabilities' => ['', ...], 'capabilityOptions' => [ 'outboundEdi' => [ 'x12' => [ 'common' => [ 'delimiters' => [ 'componentSeparator' => '', 'dataElementSeparator' => '', 'segmentTerminator' => '', ], 'functionalGroupHeaders' => [ 'applicationReceiverCode' => '', 'applicationSenderCode' => '', 'responsibleAgencyCode' => '', ], 'interchangeControlHeaders' => [ 'acknowledgmentRequestedCode' => '', 'receiverId' => '', 'receiverIdQualifier' => '', 'repetitionSeparator' => '', 'senderId' => '', 'senderIdQualifier' => '', 'usageIndicatorCode' => '', ], 'validateEdi' => true || false, ], ], ], ], 'createdAt' => , 'email' => '', 'modifiedAt' => , 'name' => '', 'partnershipArn' => '', 'partnershipId' => '', 'phone' => '', 'profileId' => '', 'tradingPartnerId' => '', ]

Result Details

Members

capabilities

Returns one or more capabilities associated with this partnership.

capabilityOptions

Type: CapabilityOptions structure

Returns the structure that contains the details for the associated capabilities.

createdAt

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns a timestamp that identifies the most recent date and time that the partnership was modified.

email

Returns the email address associated with this trading partner.

modifiedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns a timestamp that identifies the most recent date and time that the partnership was modified.

name

The name of the partnership, used to identify it.

partnershipArn

Required: Yes

Type: string

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

partnershipId

Required: Yes

Type: string

Returns the unique, system-generated identifier for a partnership.

phone

Returns the phone number associated with the partnership.

profileId

Required: Yes

Type: string

Returns the unique, system-generated identifier for the profile connected to this partnership.

tradingPartnerId

Returns the unique, system-generated identifier for a trading partner.

Errors

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.

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample UpdatePartnership call

result=result = result=client->updatePartnership([ 'name' => 'b2bipartner', 'capabilities' => [ 'ca-963a8121e4fc4e348', ], 'partnershipId' => 'ps-219fa02f5b4242af8', ]);

Result syntax:

[ 'name' => 'b2bipartner', 'capabilities' => [ 'ca-963a8121e4fc4e348', ], 'createdAt' => , 'email' => 'john@example.com', 'modifiedAt' => , 'partnershipArn' => 'arn:aws:b2bi:us-west-2:123456789012:partnership/ps-60fbc37c87f04fce9', 'partnershipId' => 'ps-219fa02f5b4242af8', 'phone' => '5555555555', 'profileId' => 'p-60fbc37c87f04fce9', 'tradingPartnerId' => 'tp-2a17ca447f6f4a8a8', ]

UpdateProfile

result=result = result=client->updateProfile([/* ... /]); promise=promise = promise=client->updateProfileAsync([/ ... */]);

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

Parameter Syntax

result=result = result=client->updateProfile([ 'businessName' => '', 'email' => '', 'name' => '', 'phone' => '', 'profileId' => '', // REQUIRED ]);

Parameter Details

Members

businessName

Specifies the name for the business associated with this profile.

email

Specifies the email address associated with this customer profile.

name

The name of the profile, used to identify it.

phone

Specifies the phone number associated with the profile.

profileId

Required: Yes

Type: string

Specifies the unique, system-generated identifier for the profile.

Result Syntax

[ 'businessName' => '', 'createdAt' => , 'email' => '', 'logGroupName' => '', 'logging' => 'ENABLED|DISABLED', 'modifiedAt' => , 'name' => '', 'phone' => '', 'profileArn' => '', 'profileId' => '', ]

Result Details

Members

businessName

Required: Yes

Type: string

Returns the name for the business associated with this profile.

createdAt

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns a timestamp for creation date and time of the profile.

email

Returns the email address associated with this customer profile.

logGroupName

Returns the name of the logging group.

logging

Specifies whether or not logging is enabled for this profile.

modifiedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns a timestamp for last time the profile was modified.

name

Required: Yes

Type: string

Returns the name of the profile.

phone

Required: Yes

Type: string

Returns the phone number associated with the profile.

profileArn

Required: Yes

Type: string

Returns an Amazon Resource Name (ARN) for the profile.

profileId

Required: Yes

Type: string

Returns the unique, system-generated identifier for the profile.

Errors

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.

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

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.

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

Examples

Example 1: Sample UpdateProfile call

result=result = result=client->updateProfile([ 'name' => 'Shipping Profile', 'businessName' => 'John's Shipping', 'email' => 'john@example.com', 'phone' => '5555555555', 'profileId' => 'p-60fbc37c87f04fce9', ]);

Result syntax:

[ 'name' => 'Shipping Profile', 'businessName' => 'John's Trucking', 'createdAt' => , 'email' => 'john@example.com', 'logGroupName' => 'b2bi/p-60fbc37c87f04fce9-Logs', 'logging' => 'ENABLED', 'modifiedAt' => , 'phone' => '5555555555', 'profileArn' => 'arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9', 'profileId' => 'p-60fbc37c87f04fce9', ]

UpdateTransformer

result=result = result=client->updateTransformer([/* ... /]); promise=promise = promise=client->updateTransformerAsync([/ ... */]);

Updates the specified parameters for a transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.

Parameter Syntax

result=result = result=client->updateTransformer([ 'ediType' => [ 'x12Details' => [ 'transactionSet' => 'X12_100|X12_101|X12_102|X12_103|X12_104|X12_105|X12_106|X12_107|X12_108|X12_109|X12_110|X12_111|X12_112|X12_113|X12_120|X12_121|X12_124|X12_125|X12_126|X12_127|X12_128|X12_129|X12_130|X12_131|X12_132|X12_133|X12_135|X12_138|X12_139|X12_140|X12_141|X12_142|X12_143|X12_144|X12_146|X12_147|X12_148|X12_149|X12_150|X12_151|X12_152|X12_153|X12_154|X12_155|X12_157|X12_158|X12_159|X12_160|X12_161|X12_163|X12_170|X12_175|X12_176|X12_179|X12_180|X12_185|X12_186|X12_187|X12_188|X12_189|X12_190|X12_191|X12_194|X12_195|X12_196|X12_197|X12_198|X12_199|X12_200|X12_201|X12_202|X12_203|X12_204|X12_205|X12_206|X12_210|X12_211|X12_212|X12_213|X12_214|X12_215|X12_216|X12_217|X12_218|X12_219|X12_220|X12_222|X12_223|X12_224|X12_225|X12_227|X12_228|X12_240|X12_242|X12_244|X12_245|X12_248|X12_249|X12_250|X12_251|X12_252|X12_255|X12_256|X12_259|X12_260|X12_261|X12_262|X12_263|X12_264|X12_265|X12_266|X12_267|X12_268|X12_269|X12_270|X12_271|X12_272|X12_273|X12_274|X12_275|X12_276|X12_277|X12_278|X12_280|X12_283|X12_284|X12_285|X12_286|X12_288|X12_290|X12_300|X12_301|X12_303|X12_304|X12_309|X12_310|X12_311|X12_312|X12_313|X12_315|X12_317|X12_319|X12_322|X12_323|X12_324|X12_325|X12_326|X12_350|X12_352|X12_353|X12_354|X12_355|X12_356|X12_357|X12_358|X12_361|X12_362|X12_404|X12_410|X12_412|X12_414|X12_417|X12_418|X12_419|X12_420|X12_421|X12_422|X12_423|X12_424|X12_425|X12_426|X12_429|X12_431|X12_432|X12_433|X12_434|X12_435|X12_436|X12_437|X12_440|X12_451|X12_452|X12_453|X12_455|X12_456|X12_460|X12_463|X12_466|X12_468|X12_470|X12_475|X12_485|X12_486|X12_490|X12_492|X12_494|X12_500|X12_501|X12_503|X12_504|X12_511|X12_517|X12_521|X12_527|X12_536|X12_540|X12_561|X12_567|X12_568|X12_601|X12_602|X12_620|X12_625|X12_650|X12_715|X12_753|X12_754|X12_805|X12_806|X12_810|X12_811|X12_812|X12_813|X12_814|X12_815|X12_816|X12_818|X12_819|X12_820|X12_821|X12_822|X12_823|X12_824|X12_826|X12_827|X12_828|X12_829|X12_830|X12_831|X12_832|X12_833|X12_834|X12_835|X12_836|X12_837|X12_838|X12_839|X12_840|X12_841|X12_842|X12_843|X12_844|X12_845|X12_846|X12_847|X12_848|X12_849|X12_850|X12_851|X12_852|X12_853|X12_854|X12_855|X12_856|X12_857|X12_858|X12_859|X12_860|X12_861|X12_862|X12_863|X12_864|X12_865|X12_866|X12_867|X12_868|X12_869|X12_870|X12_871|X12_872|X12_873|X12_874|X12_875|X12_876|X12_877|X12_878|X12_879|X12_880|X12_881|X12_882|X12_883|X12_884|X12_885|X12_886|X12_887|X12_888|X12_889|X12_891|X12_893|X12_894|X12_895|X12_896|X12_920|X12_924|X12_925|X12_926|X12_928|X12_940|X12_943|X12_944|X12_945|X12_947|X12_980|X12_990|X12_993|X12_996|X12_997|X12_998|X12_999|X12_270_X279|X12_271_X279|X12_275_X210|X12_275_X211|X12_276_X212|X12_277_X212|X12_277_X214|X12_277_X364|X12_278_X217|X12_820_X218|X12_820_X306|X12_824_X186|X12_834_X220|X12_834_X307|X12_834_X318|X12_835_X221|X12_837_X222|X12_837_X223|X12_837_X224|X12_837_X291|X12_837_X292|X12_837_X298|X12_999_X231', 'version' => 'VERSION_4010|VERSION_4030|VERSION_4050|VERSION_4060|VERSION_5010|VERSION_5010_HIPAA', ], ], 'fileFormat' => 'XML|JSON|NOT_USED', 'inputConversion' => [ 'formatOptions' => [ 'x12' => [ 'transactionSet' => 'X12_100|X12_101|X12_102|X12_103|X12_104|X12_105|X12_106|X12_107|X12_108|X12_109|X12_110|X12_111|X12_112|X12_113|X12_120|X12_121|X12_124|X12_125|X12_126|X12_127|X12_128|X12_129|X12_130|X12_131|X12_132|X12_133|X12_135|X12_138|X12_139|X12_140|X12_141|X12_142|X12_143|X12_144|X12_146|X12_147|X12_148|X12_149|X12_150|X12_151|X12_152|X12_153|X12_154|X12_155|X12_157|X12_158|X12_159|X12_160|X12_161|X12_163|X12_170|X12_175|X12_176|X12_179|X12_180|X12_185|X12_186|X12_187|X12_188|X12_189|X12_190|X12_191|X12_194|X12_195|X12_196|X12_197|X12_198|X12_199|X12_200|X12_201|X12_202|X12_203|X12_204|X12_205|X12_206|X12_210|X12_211|X12_212|X12_213|X12_214|X12_215|X12_216|X12_217|X12_218|X12_219|X12_220|X12_222|X12_223|X12_224|X12_225|X12_227|X12_228|X12_240|X12_242|X12_244|X12_245|X12_248|X12_249|X12_250|X12_251|X12_252|X12_255|X12_256|X12_259|X12_260|X12_261|X12_262|X12_263|X12_264|X12_265|X12_266|X12_267|X12_268|X12_269|X12_270|X12_271|X12_272|X12_273|X12_274|X12_275|X12_276|X12_277|X12_278|X12_280|X12_283|X12_284|X12_285|X12_286|X12_288|X12_290|X12_300|X12_301|X12_303|X12_304|X12_309|X12_310|X12_311|X12_312|X12_313|X12_315|X12_317|X12_319|X12_322|X12_323|X12_324|X12_325|X12_326|X12_350|X12_352|X12_353|X12_354|X12_355|X12_356|X12_357|X12_358|X12_361|X12_362|X12_404|X12_410|X12_412|X12_414|X12_417|X12_418|X12_419|X12_420|X12_421|X12_422|X12_423|X12_424|X12_425|X12_426|X12_429|X12_431|X12_432|X12_433|X12_434|X12_435|X12_436|X12_437|X12_440|X12_451|X12_452|X12_453|X12_455|X12_456|X12_460|X12_463|X12_466|X12_468|X12_470|X12_475|X12_485|X12_486|X12_490|X12_492|X12_494|X12_500|X12_501|X12_503|X12_504|X12_511|X12_517|X12_521|X12_527|X12_536|X12_540|X12_561|X12_567|X12_568|X12_601|X12_602|X12_620|X12_625|X12_650|X12_715|X12_753|X12_754|X12_805|X12_806|X12_810|X12_811|X12_812|X12_813|X12_814|X12_815|X12_816|X12_818|X12_819|X12_820|X12_821|X12_822|X12_823|X12_824|X12_826|X12_827|X12_828|X12_829|X12_830|X12_831|X12_832|X12_833|X12_834|X12_835|X12_836|X12_837|X12_838|X12_839|X12_840|X12_841|X12_842|X12_843|X12_844|X12_845|X12_846|X12_847|X12_848|X12_849|X12_850|X12_851|X12_852|X12_853|X12_854|X12_855|X12_856|X12_857|X12_858|X12_859|X12_860|X12_861|X12_862|X12_863|X12_864|X12_865|X12_866|X12_867|X12_868|X12_869|X12_870|X12_871|X12_872|X12_873|X12_874|X12_875|X12_876|X12_877|X12_878|X12_879|X12_880|X12_881|X12_882|X12_883|X12_884|X12_885|X12_886|X12_887|X12_888|X12_889|X12_891|X12_893|X12_894|X12_895|X12_896|X12_920|X12_924|X12_925|X12_926|X12_928|X12_940|X12_943|X12_944|X12_945|X12_947|X12_980|X12_990|X12_993|X12_996|X12_997|X12_998|X12_999|X12_270_X279|X12_271_X279|X12_275_X210|X12_275_X211|X12_276_X212|X12_277_X212|X12_277_X214|X12_277_X364|X12_278_X217|X12_820_X218|X12_820_X306|X12_824_X186|X12_834_X220|X12_834_X307|X12_834_X318|X12_835_X221|X12_837_X222|X12_837_X223|X12_837_X224|X12_837_X291|X12_837_X292|X12_837_X298|X12_999_X231', 'version' => 'VERSION_4010|VERSION_4030|VERSION_4050|VERSION_4060|VERSION_5010|VERSION_5010_HIPAA', ], ], 'fromFormat' => 'X12', // REQUIRED ], 'mapping' => [ 'template' => '', 'templateLanguage' => 'XSLT|JSONATA', // REQUIRED ], 'mappingTemplate' => '', 'name' => '', 'outputConversion' => [ 'formatOptions' => [ 'x12' => [ 'transactionSet' => 'X12_100|X12_101|X12_102|X12_103|X12_104|X12_105|X12_106|X12_107|X12_108|X12_109|X12_110|X12_111|X12_112|X12_113|X12_120|X12_121|X12_124|X12_125|X12_126|X12_127|X12_128|X12_129|X12_130|X12_131|X12_132|X12_133|X12_135|X12_138|X12_139|X12_140|X12_141|X12_142|X12_143|X12_144|X12_146|X12_147|X12_148|X12_149|X12_150|X12_151|X12_152|X12_153|X12_154|X12_155|X12_157|X12_158|X12_159|X12_160|X12_161|X12_163|X12_170|X12_175|X12_176|X12_179|X12_180|X12_185|X12_186|X12_187|X12_188|X12_189|X12_190|X12_191|X12_194|X12_195|X12_196|X12_197|X12_198|X12_199|X12_200|X12_201|X12_202|X12_203|X12_204|X12_205|X12_206|X12_210|X12_211|X12_212|X12_213|X12_214|X12_215|X12_216|X12_217|X12_218|X12_219|X12_220|X12_222|X12_223|X12_224|X12_225|X12_227|X12_228|X12_240|X12_242|X12_244|X12_245|X12_248|X12_249|X12_250|X12_251|X12_252|X12_255|X12_256|X12_259|X12_260|X12_261|X12_262|X12_263|X12_264|X12_265|X12_266|X12_267|X12_268|X12_269|X12_270|X12_271|X12_272|X12_273|X12_274|X12_275|X12_276|X12_277|X12_278|X12_280|X12_283|X12_284|X12_285|X12_286|X12_288|X12_290|X12_300|X12_301|X12_303|X12_304|X12_309|X12_310|X12_311|X12_312|X12_313|X12_315|X12_317|X12_319|X12_322|X12_323|X12_324|X12_325|X12_326|X12_350|X12_352|X12_353|X12_354|X12_355|X12_356|X12_357|X12_358|X12_361|X12_362|X12_404|X12_410|X12_412|X12_414|X12_417|X12_418|X12_419|X12_420|X12_421|X12_422|X12_423|X12_424|X12_425|X12_426|X12_429|X12_431|X12_432|X12_433|X12_434|X12_435|X12_436|X12_437|X12_440|X12_451|X12_452|X12_453|X12_455|X12_456|X12_460|X12_463|X12_466|X12_468|X12_470|X12_475|X12_485|X12_486|X12_490|X12_492|X12_494|X12_500|X12_501|X12_503|X12_504|X12_511|X12_517|X12_521|X12_527|X12_536|X12_540|X12_561|X12_567|X12_568|X12_601|X12_602|X12_620|X12_625|X12_650|X12_715|X12_753|X12_754|X12_805|X12_806|X12_810|X12_811|X12_812|X12_813|X12_814|X12_815|X12_816|X12_818|X12_819|X12_820|X12_821|X12_822|X12_823|X12_824|X12_826|X12_827|X12_828|X12_829|X12_830|X12_831|X12_832|X12_833|X12_834|X12_835|X12_836|X12_837|X12_838|X12_839|X12_840|X12_841|X12_842|X12_843|X12_844|X12_845|X12_846|X12_847|X12_848|X12_849|X12_850|X12_851|X12_852|X12_853|X12_854|X12_855|X12_856|X12_857|X12_858|X12_859|X12_860|X12_861|X12_862|X12_863|X12_864|X12_865|X12_866|X12_867|X12_868|X12_869|X12_870|X12_871|X12_872|X12_873|X12_874|X12_875|X12_876|X12_877|X12_878|X12_879|X12_880|X12_881|X12_882|X12_883|X12_884|X12_885|X12_886|X12_887|X12_888|X12_889|X12_891|X12_893|X12_894|X12_895|X12_896|X12_920|X12_924|X12_925|X12_926|X12_928|X12_940|X12_943|X12_944|X12_945|X12_947|X12_980|X12_990|X12_993|X12_996|X12_997|X12_998|X12_999|X12_270_X279|X12_271_X279|X12_275_X210|X12_275_X211|X12_276_X212|X12_277_X212|X12_277_X214|X12_277_X364|X12_278_X217|X12_820_X218|X12_820_X306|X12_824_X186|X12_834_X220|X12_834_X307|X12_834_X318|X12_835_X221|X12_837_X222|X12_837_X223|X12_837_X224|X12_837_X291|X12_837_X292|X12_837_X298|X12_999_X231', 'version' => 'VERSION_4010|VERSION_4030|VERSION_4050|VERSION_4060|VERSION_5010|VERSION_5010_HIPAA', ], ], 'toFormat' => 'X12', // REQUIRED ], 'sampleDocument' => '', 'sampleDocuments' => [ 'bucketName' => '', // REQUIRED 'keys' => [ // REQUIRED [ 'input' => '', 'output' => '', ], // ... ], ], 'status' => 'active|inactive', 'transformerId' => '', // REQUIRED ]);

Parameter Details

Members

ediType

fileFormat

Specifies that the currently supported file formats for EDI transformations are JSON and XML.

inputConversion

Type: InputConversion structure

To update, specify the InputConversion object, which contains the format options for the inbound transformation.

mapping

Specify the structure that contains the mapping template and its language (either XSLT or JSONATA).

mappingTemplate

Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

This parameter is available for backwards compatibility. Use the Mapping data type instead.

name

Specify a new name for the transformer, if you want to update it.

outputConversion

Type: OutputConversion structure

To update, specify the OutputConversion object, which contains the format options for the outbound transformation.

sampleDocument

Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.

sampleDocuments

Type: SampleDocuments structure

Specify a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

status

Specifies the transformer's status. You can update the state of the transformer from inactive to active.

transformerId

Required: Yes

Type: string

Specifies the system-assigned unique identifier for the transformer.

Result Syntax

[ 'createdAt' => , 'ediType' => [ 'x12Details' => [ 'transactionSet' => 'X12_100|X12_101|X12_102|X12_103|X12_104|X12_105|X12_106|X12_107|X12_108|X12_109|X12_110|X12_111|X12_112|X12_113|X12_120|X12_121|X12_124|X12_125|X12_126|X12_127|X12_128|X12_129|X12_130|X12_131|X12_132|X12_133|X12_135|X12_138|X12_139|X12_140|X12_141|X12_142|X12_143|X12_144|X12_146|X12_147|X12_148|X12_149|X12_150|X12_151|X12_152|X12_153|X12_154|X12_155|X12_157|X12_158|X12_159|X12_160|X12_161|X12_163|X12_170|X12_175|X12_176|X12_179|X12_180|X12_185|X12_186|X12_187|X12_188|X12_189|X12_190|X12_191|X12_194|X12_195|X12_196|X12_197|X12_198|X12_199|X12_200|X12_201|X12_202|X12_203|X12_204|X12_205|X12_206|X12_210|X12_211|X12_212|X12_213|X12_214|X12_215|X12_216|X12_217|X12_218|X12_219|X12_220|X12_222|X12_223|X12_224|X12_225|X12_227|X12_228|X12_240|X12_242|X12_244|X12_245|X12_248|X12_249|X12_250|X12_251|X12_252|X12_255|X12_256|X12_259|X12_260|X12_261|X12_262|X12_263|X12_264|X12_265|X12_266|X12_267|X12_268|X12_269|X12_270|X12_271|X12_272|X12_273|X12_274|X12_275|X12_276|X12_277|X12_278|X12_280|X12_283|X12_284|X12_285|X12_286|X12_288|X12_290|X12_300|X12_301|X12_303|X12_304|X12_309|X12_310|X12_311|X12_312|X12_313|X12_315|X12_317|X12_319|X12_322|X12_323|X12_324|X12_325|X12_326|X12_350|X12_352|X12_353|X12_354|X12_355|X12_356|X12_357|X12_358|X12_361|X12_362|X12_404|X12_410|X12_412|X12_414|X12_417|X12_418|X12_419|X12_420|X12_421|X12_422|X12_423|X12_424|X12_425|X12_426|X12_429|X12_431|X12_432|X12_433|X12_434|X12_435|X12_436|X12_437|X12_440|X12_451|X12_452|X12_453|X12_455|X12_456|X12_460|X12_463|X12_466|X12_468|X12_470|X12_475|X12_485|X12_486|X12_490|X12_492|X12_494|X12_500|X12_501|X12_503|X12_504|X12_511|X12_517|X12_521|X12_527|X12_536|X12_540|X12_561|X12_567|X12_568|X12_601|X12_602|X12_620|X12_625|X12_650|X12_715|X12_753|X12_754|X12_805|X12_806|X12_810|X12_811|X12_812|X12_813|X12_814|X12_815|X12_816|X12_818|X12_819|X12_820|X12_821|X12_822|X12_823|X12_824|X12_826|X12_827|X12_828|X12_829|X12_830|X12_831|X12_832|X12_833|X12_834|X12_835|X12_836|X12_837|X12_838|X12_839|X12_840|X12_841|X12_842|X12_843|X12_844|X12_845|X12_846|X12_847|X12_848|X12_849|X12_850|X12_851|X12_852|X12_853|X12_854|X12_855|X12_856|X12_857|X12_858|X12_859|X12_860|X12_861|X12_862|X12_863|X12_864|X12_865|X12_866|X12_867|X12_868|X12_869|X12_870|X12_871|X12_872|X12_873|X12_874|X12_875|X12_876|X12_877|X12_878|X12_879|X12_880|X12_881|X12_882|X12_883|X12_884|X12_885|X12_886|X12_887|X12_888|X12_889|X12_891|X12_893|X12_894|X12_895|X12_896|X12_920|X12_924|X12_925|X12_926|X12_928|X12_940|X12_943|X12_944|X12_945|X12_947|X12_980|X12_990|X12_993|X12_996|X12_997|X12_998|X12_999|X12_270_X279|X12_271_X279|X12_275_X210|X12_275_X211|X12_276_X212|X12_277_X212|X12_277_X214|X12_277_X364|X12_278_X217|X12_820_X218|X12_820_X306|X12_824_X186|X12_834_X220|X12_834_X307|X12_834_X318|X12_835_X221|X12_837_X222|X12_837_X223|X12_837_X224|X12_837_X291|X12_837_X292|X12_837_X298|X12_999_X231', 'version' => 'VERSION_4010|VERSION_4030|VERSION_4050|VERSION_4060|VERSION_5010|VERSION_5010_HIPAA', ], ], 'fileFormat' => 'XML|JSON|NOT_USED', 'inputConversion' => [ 'formatOptions' => [ 'x12' => [ 'transactionSet' => 'X12_100|X12_101|X12_102|X12_103|X12_104|X12_105|X12_106|X12_107|X12_108|X12_109|X12_110|X12_111|X12_112|X12_113|X12_120|X12_121|X12_124|X12_125|X12_126|X12_127|X12_128|X12_129|X12_130|X12_131|X12_132|X12_133|X12_135|X12_138|X12_139|X12_140|X12_141|X12_142|X12_143|X12_144|X12_146|X12_147|X12_148|X12_149|X12_150|X12_151|X12_152|X12_153|X12_154|X12_155|X12_157|X12_158|X12_159|X12_160|X12_161|X12_163|X12_170|X12_175|X12_176|X12_179|X12_180|X12_185|X12_186|X12_187|X12_188|X12_189|X12_190|X12_191|X12_194|X12_195|X12_196|X12_197|X12_198|X12_199|X12_200|X12_201|X12_202|X12_203|X12_204|X12_205|X12_206|X12_210|X12_211|X12_212|X12_213|X12_214|X12_215|X12_216|X12_217|X12_218|X12_219|X12_220|X12_222|X12_223|X12_224|X12_225|X12_227|X12_228|X12_240|X12_242|X12_244|X12_245|X12_248|X12_249|X12_250|X12_251|X12_252|X12_255|X12_256|X12_259|X12_260|X12_261|X12_262|X12_263|X12_264|X12_265|X12_266|X12_267|X12_268|X12_269|X12_270|X12_271|X12_272|X12_273|X12_274|X12_275|X12_276|X12_277|X12_278|X12_280|X12_283|X12_284|X12_285|X12_286|X12_288|X12_290|X12_300|X12_301|X12_303|X12_304|X12_309|X12_310|X12_311|X12_312|X12_313|X12_315|X12_317|X12_319|X12_322|X12_323|X12_324|X12_325|X12_326|X12_350|X12_352|X12_353|X12_354|X12_355|X12_356|X12_357|X12_358|X12_361|X12_362|X12_404|X12_410|X12_412|X12_414|X12_417|X12_418|X12_419|X12_420|X12_421|X12_422|X12_423|X12_424|X12_425|X12_426|X12_429|X12_431|X12_432|X12_433|X12_434|X12_435|X12_436|X12_437|X12_440|X12_451|X12_452|X12_453|X12_455|X12_456|X12_460|X12_463|X12_466|X12_468|X12_470|X12_475|X12_485|X12_486|X12_490|X12_492|X12_494|X12_500|X12_501|X12_503|X12_504|X12_511|X12_517|X12_521|X12_527|X12_536|X12_540|X12_561|X12_567|X12_568|X12_601|X12_602|X12_620|X12_625|X12_650|X12_715|X12_753|X12_754|X12_805|X12_806|X12_810|X12_811|X12_812|X12_813|X12_814|X12_815|X12_816|X12_818|X12_819|X12_820|X12_821|X12_822|X12_823|X12_824|X12_826|X12_827|X12_828|X12_829|X12_830|X12_831|X12_832|X12_833|X12_834|X12_835|X12_836|X12_837|X12_838|X12_839|X12_840|X12_841|X12_842|X12_843|X12_844|X12_845|X12_846|X12_847|X12_848|X12_849|X12_850|X12_851|X12_852|X12_853|X12_854|X12_855|X12_856|X12_857|X12_858|X12_859|X12_860|X12_861|X12_862|X12_863|X12_864|X12_865|X12_866|X12_867|X12_868|X12_869|X12_870|X12_871|X12_872|X12_873|X12_874|X12_875|X12_876|X12_877|X12_878|X12_879|X12_880|X12_881|X12_882|X12_883|X12_884|X12_885|X12_886|X12_887|X12_888|X12_889|X12_891|X12_893|X12_894|X12_895|X12_896|X12_920|X12_924|X12_925|X12_926|X12_928|X12_940|X12_943|X12_944|X12_945|X12_947|X12_980|X12_990|X12_993|X12_996|X12_997|X12_998|X12_999|X12_270_X279|X12_271_X279|X12_275_X210|X12_275_X211|X12_276_X212|X12_277_X212|X12_277_X214|X12_277_X364|X12_278_X217|X12_820_X218|X12_820_X306|X12_824_X186|X12_834_X220|X12_834_X307|X12_834_X318|X12_835_X221|X12_837_X222|X12_837_X223|X12_837_X224|X12_837_X291|X12_837_X292|X12_837_X298|X12_999_X231', 'version' => 'VERSION_4010|VERSION_4030|VERSION_4050|VERSION_4060|VERSION_5010|VERSION_5010_HIPAA', ], ], 'fromFormat' => 'X12', ], 'mapping' => [ 'template' => '', 'templateLanguage' => 'XSLT|JSONATA', ], 'mappingTemplate' => '', 'modifiedAt' => , 'name' => '', 'outputConversion' => [ 'formatOptions' => [ 'x12' => [ 'transactionSet' => 'X12_100|X12_101|X12_102|X12_103|X12_104|X12_105|X12_106|X12_107|X12_108|X12_109|X12_110|X12_111|X12_112|X12_113|X12_120|X12_121|X12_124|X12_125|X12_126|X12_127|X12_128|X12_129|X12_130|X12_131|X12_132|X12_133|X12_135|X12_138|X12_139|X12_140|X12_141|X12_142|X12_143|X12_144|X12_146|X12_147|X12_148|X12_149|X12_150|X12_151|X12_152|X12_153|X12_154|X12_155|X12_157|X12_158|X12_159|X12_160|X12_161|X12_163|X12_170|X12_175|X12_176|X12_179|X12_180|X12_185|X12_186|X12_187|X12_188|X12_189|X12_190|X12_191|X12_194|X12_195|X12_196|X12_197|X12_198|X12_199|X12_200|X12_201|X12_202|X12_203|X12_204|X12_205|X12_206|X12_210|X12_211|X12_212|X12_213|X12_214|X12_215|X12_216|X12_217|X12_218|X12_219|X12_220|X12_222|X12_223|X12_224|X12_225|X12_227|X12_228|X12_240|X12_242|X12_244|X12_245|X12_248|X12_249|X12_250|X12_251|X12_252|X12_255|X12_256|X12_259|X12_260|X12_261|X12_262|X12_263|X12_264|X12_265|X12_266|X12_267|X12_268|X12_269|X12_270|X12_271|X12_272|X12_273|X12_274|X12_275|X12_276|X12_277|X12_278|X12_280|X12_283|X12_284|X12_285|X12_286|X12_288|X12_290|X12_300|X12_301|X12_303|X12_304|X12_309|X12_310|X12_311|X12_312|X12_313|X12_315|X12_317|X12_319|X12_322|X12_323|X12_324|X12_325|X12_326|X12_350|X12_352|X12_353|X12_354|X12_355|X12_356|X12_357|X12_358|X12_361|X12_362|X12_404|X12_410|X12_412|X12_414|X12_417|X12_418|X12_419|X12_420|X12_421|X12_422|X12_423|X12_424|X12_425|X12_426|X12_429|X12_431|X12_432|X12_433|X12_434|X12_435|X12_436|X12_437|X12_440|X12_451|X12_452|X12_453|X12_455|X12_456|X12_460|X12_463|X12_466|X12_468|X12_470|X12_475|X12_485|X12_486|X12_490|X12_492|X12_494|X12_500|X12_501|X12_503|X12_504|X12_511|X12_517|X12_521|X12_527|X12_536|X12_540|X12_561|X12_567|X12_568|X12_601|X12_602|X12_620|X12_625|X12_650|X12_715|X12_753|X12_754|X12_805|X12_806|X12_810|X12_811|X12_812|X12_813|X12_814|X12_815|X12_816|X12_818|X12_819|X12_820|X12_821|X12_822|X12_823|X12_824|X12_826|X12_827|X12_828|X12_829|X12_830|X12_831|X12_832|X12_833|X12_834|X12_835|X12_836|X12_837|X12_838|X12_839|X12_840|X12_841|X12_842|X12_843|X12_844|X12_845|X12_846|X12_847|X12_848|X12_849|X12_850|X12_851|X12_852|X12_853|X12_854|X12_855|X12_856|X12_857|X12_858|X12_859|X12_860|X12_861|X12_862|X12_863|X12_864|X12_865|X12_866|X12_867|X12_868|X12_869|X12_870|X12_871|X12_872|X12_873|X12_874|X12_875|X12_876|X12_877|X12_878|X12_879|X12_880|X12_881|X12_882|X12_883|X12_884|X12_885|X12_886|X12_887|X12_888|X12_889|X12_891|X12_893|X12_894|X12_895|X12_896|X12_920|X12_924|X12_925|X12_926|X12_928|X12_940|X12_943|X12_944|X12_945|X12_947|X12_980|X12_990|X12_993|X12_996|X12_997|X12_998|X12_999|X12_270_X279|X12_271_X279|X12_275_X210|X12_275_X211|X12_276_X212|X12_277_X212|X12_277_X214|X12_277_X364|X12_278_X217|X12_820_X218|X12_820_X306|X12_824_X186|X12_834_X220|X12_834_X307|X12_834_X318|X12_835_X221|X12_837_X222|X12_837_X223|X12_837_X224|X12_837_X291|X12_837_X292|X12_837_X298|X12_999_X231', 'version' => 'VERSION_4010|VERSION_4030|VERSION_4050|VERSION_4060|VERSION_5010|VERSION_5010_HIPAA', ], ], 'toFormat' => 'X12', ], 'sampleDocument' => '', 'sampleDocuments' => [ 'bucketName' => '', 'keys' => [ [ 'input' => '', 'output' => '', ], // ... ], ], 'status' => 'active|inactive', 'transformerArn' => '', 'transformerId' => '', ]

Result Details

Members

createdAt

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns a timestamp for creation date and time of the transformer.

ediType

fileFormat

Returns that the currently supported file formats for EDI transformations are JSON and XML.

inputConversion

Type: InputConversion structure

Returns the InputConversion object, which contains the format options for the inbound transformation.

mapping

Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).

mappingTemplate

Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

modifiedAt

Required: Yes

Type: timestamp (string|DateTime or anything parsable by strtotime)

Returns a timestamp for last time the transformer was modified.

name

Required: Yes

Type: string

Returns the name of the transformer.

outputConversion

Type: OutputConversion structure

Returns the OutputConversion object, which contains the format options for the outbound transformation.

sampleDocument

Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

sampleDocuments

Type: SampleDocuments structure

Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

status

Required: Yes

Type: string

Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.

transformerArn

Required: Yes

Type: string

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

transformerId

Required: Yes

Type: string

Returns the system-assigned unique identifier for the transformer.

Errors

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.

You do not have sufficient access to perform this action.

Occurs when a B2BI object cannot be validated against a request from another object.

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

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.

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.