AWS B2B Data Interchange 2022-06-23
- Client: Aws\B2bi\B2biClient
- Service ID: b2bi
- Version: 2022-06-23
This page describes the parameters and results for the operations of the AWS B2B Data Interchange (2022-06-23), and shows how to use the Aws\B2bi\B2biClient object to call the described operations. This documentation is specific to the 2022-06-23 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- CreateCapability ( array $params = [] )
- Instantiates a capability based on the specified parameters.
- CreatePartnership ( array $params = [] )
- Creates a partnership between a customer and a trading partner, based on the supplied parameters.
- CreateProfile ( array $params = [] )
- Creates a customer profile.
- CreateTransformer ( array $params = [] )
- Creates a transformer.
- DeleteCapability ( array $params = [] )
- Deletes the specified capability.
- DeletePartnership ( array $params = [] )
- Deletes the specified partnership.
- DeleteProfile ( array $params = [] )
- Deletes the specified profile.
- DeleteTransformer ( array $params = [] )
- Deletes the specified transformer.
- GetCapability ( array $params = [] )
- Retrieves the details for the specified capability.
- GetPartnership ( array $params = [] )
- Retrieves the details for a partnership, based on the partner and profile IDs specified.
- GetProfile ( array $params = [] )
- Retrieves the details for the profile specified by the profile ID.
- GetTransformer ( array $params = [] )
- Retrieves the details for the transformer specified by the transformer ID.
- GetTransformerJob ( array $params = [] )
- Returns the details of the transformer run, based on the Transformer job ID.
- ListCapabilities ( array $params = [] )
- Lists the capabilities associated with your Amazon Web Services account for your current or specified region.
- ListPartnerships ( array $params = [] )
- Lists the partnerships associated with your Amazon Web Services account for your current or specified region.
- ListProfiles ( array $params = [] )
- Lists the profiles associated with your Amazon Web Services account for your current or specified region.
- ListTagsForResource ( array $params = [] )
- Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
- ListTransformers ( array $params = [] )
- Lists the available transformers.
- StartTransformerJob ( array $params = [] )
- Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2BI Data Interchange.
- TagResource ( array $params = [] )
- Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
- TestMapping ( array $params = [] )
- Maps the input file according to the provided template file.
- TestParsing ( array $params = [] )
- Parses the input EDI (electronic data interchange) file.
- UntagResource ( array $params = [] )
- Detaches a key-value pair from the specified resource, as identified by its Amazon Resource Name (ARN).
- UpdateCapability ( array $params = [] )
- Updates some of the parameters for a capability, based on the specified parameters.
- UpdatePartnership ( array $params = [] )
- Updates some of the parameters for a partnership between a customer and trading partner.
- UpdateProfile ( array $params = [] )
- Updates the specified parameters for a profile.
- UpdateTransformer ( array $params = [] )
- Updates the specified parameters for a transformer.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateCapability
$result = $client->createCapability
([/* ... */]); $promise = $client->createCapabilityAsync
([/* ... */]);
Instantiates a capability based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
Parameter Syntax
$result = $client->createCapability([ 'clientToken' => '<string>', 'configuration' => [ // REQUIRED 'edi' => [ 'inputLocation' => [ // REQUIRED 'bucketName' => '<string>', 'key' => '<string>', ], 'outputLocation' => [ // REQUIRED 'bucketName' => '<string>', 'key' => '<string>', ], 'transformerId' => '<string>', // REQUIRED 'type' => [ // REQUIRED 'x12Details' => [ 'transactionSet' => 'X12_110|X12_180|X12_204|X12_210|X12_211|X12_214|X12_215|X12_259|X12_260|X12_266|X12_269|X12_270|X12_271|X12_274|X12_275|X12_276|X12_277|X12_278|X12_310|X12_315|X12_322|X12_404|X12_410|X12_417|X12_421|X12_426|X12_810|X12_820|X12_824|X12_830|X12_832|X12_834|X12_835|X12_837|X12_844|X12_846|X12_849|X12_850|X12_852|X12_855|X12_856|X12_860|X12_861|X12_864|X12_865|X12_869|X12_870|X12_940|X12_945|X12_990|X12_997|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_5010|VERSION_5010_HIPAA', ], ], ], ], 'instructionsDocuments' => [ [ 'bucketName' => '<string>', 'key' => '<string>', ], // ... ], 'name' => '<string>', // REQUIRED 'tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], 'type' => 'edi', // REQUIRED ]);
Parameter Details
Members
- clientToken
-
- Type: string
Reserved for future use.
- configuration
-
- Required: Yes
- Type: CapabilityConfiguration structure
Specifies a structure that contains the details for a capability.
- instructionsDocuments
-
- Type: Array of S3Location structures
Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.
- name
-
- Required: Yes
- Type: string
Specifies the name of the capability, used to identify it.
- tags
-
- Type: Array of Tag structures
Specifies 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.
- type
-
- Required: Yes
- Type: string
Specifies the type of the capability. Currently, only
edi
is supported.
Result Syntax
[ 'capabilityArn' => '<string>', 'capabilityId' => '<string>', 'configuration' => [ 'edi' => [ 'inputLocation' => [ 'bucketName' => '<string>', 'key' => '<string>', ], 'outputLocation' => [ 'bucketName' => '<string>', 'key' => '<string>', ], 'transformerId' => '<string>', 'type' => [ 'x12Details' => [ 'transactionSet' => 'X12_110|X12_180|X12_204|X12_210|X12_211|X12_214|X12_215|X12_259|X12_260|X12_266|X12_269|X12_270|X12_271|X12_274|X12_275|X12_276|X12_277|X12_278|X12_310|X12_315|X12_322|X12_404|X12_410|X12_417|X12_421|X12_426|X12_810|X12_820|X12_824|X12_830|X12_832|X12_834|X12_835|X12_837|X12_844|X12_846|X12_849|X12_850|X12_852|X12_855|X12_856|X12_860|X12_861|X12_864|X12_865|X12_869|X12_870|X12_940|X12_945|X12_990|X12_997|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_5010|VERSION_5010_HIPAA', ], ], ], ], 'createdAt' => <DateTime>, 'instructionsDocuments' => [ [ 'bucketName' => '<string>', 'key' => '<string>', ], // ... ], 'name' => '<string>', 'type' => 'edi', ]
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
Returns one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.
- 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
- ConflictException:
A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ServiceQuotaExceededException:
Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample CreateCapability call
$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 = $client->createPartnership
([/* ... */]); $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 = $client->createPartnership([ 'capabilities' => ['<string>', ...], // REQUIRED 'clientToken' => '<string>', 'email' => '<string>', // REQUIRED 'name' => '<string>', // REQUIRED 'phone' => '<string>', 'profileId' => '<string>', // REQUIRED 'tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- capabilities
-
- Required: Yes
- Type: Array of strings
Specifies a list of the capabilities associated with this partnership.
- clientToken
-
- Type: string
Reserved for future use.
-
- 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
-
- Type: string
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
Specifies 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.
Result Syntax
[ 'capabilities' => ['<string>', ...], 'createdAt' => <DateTime>, 'email' => '<string>', 'name' => '<string>', 'partnershipArn' => '<string>', 'partnershipId' => '<string>', 'phone' => '<string>', 'profileId' => '<string>', 'tradingPartnerId' => '<string>', ]
Result Details
Members
- capabilities
-
- Type: Array of strings
Returns one or more capabilities associated with this partnership.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Returns a timestamp for creation date and time of the partnership.
-
- Type: string
Returns the email address associated with this trading partner.
- name
-
- Type: string
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
-
- Type: string
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
-
- Type: string
Returns the unique, system-generated identifier for a trading partner.
Errors
- ConflictException:
A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ServiceQuotaExceededException:
Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample CreatePartnership call
$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 = $client->createProfile
([/* ... */]); $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 = $client->createProfile([ 'businessName' => '<string>', // REQUIRED 'clientToken' => '<string>', 'email' => '<string>', 'logging' => 'ENABLED|DISABLED', // REQUIRED 'name' => '<string>', // REQUIRED 'phone' => '<string>', // REQUIRED 'tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- businessName
-
- Required: Yes
- Type: string
Specifies the name for the business associated with this profile.
- clientToken
-
- Type: string
Reserved for future use.
-
- Type: string
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
Specifies 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.
Result Syntax
[ 'businessName' => '<string>', 'createdAt' => <DateTime>, 'email' => '<string>', 'logGroupName' => '<string>', 'logging' => 'ENABLED|DISABLED', 'name' => '<string>', 'phone' => '<string>', 'profileArn' => '<string>', 'profileId' => '<string>', ]
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.
-
- Type: string
Returns the email address associated with this customer profile.
- logGroupName
-
- Type: string
Returns the name of the logging group.
- logging
-
- Type: string
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
- ConflictException:
A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ServiceQuotaExceededException:
Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample CreateProfile call
$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', ]
CreateTransformer
$result = $client->createTransformer
([/* ... */]); $promise = $client->createTransformerAsync
([/* ... */]);
Creates a transformer. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
Parameter Syntax
$result = $client->createTransformer([ 'clientToken' => '<string>', 'ediType' => [ // REQUIRED 'x12Details' => [ 'transactionSet' => 'X12_110|X12_180|X12_204|X12_210|X12_211|X12_214|X12_215|X12_259|X12_260|X12_266|X12_269|X12_270|X12_271|X12_274|X12_275|X12_276|X12_277|X12_278|X12_310|X12_315|X12_322|X12_404|X12_410|X12_417|X12_421|X12_426|X12_810|X12_820|X12_824|X12_830|X12_832|X12_834|X12_835|X12_837|X12_844|X12_846|X12_849|X12_850|X12_852|X12_855|X12_856|X12_860|X12_861|X12_864|X12_865|X12_869|X12_870|X12_940|X12_945|X12_990|X12_997|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_5010|VERSION_5010_HIPAA', ], ], 'fileFormat' => 'XML|JSON', // REQUIRED 'mappingTemplate' => '<string>', // REQUIRED 'name' => '<string>', // REQUIRED 'sampleDocument' => '<string>', 'tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- clientToken
-
- Type: string
Reserved for future use.
- ediType
-
- Required: Yes
- Type: EdiType structure
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
-
- Required: Yes
- Type: string
Specifies that the currently supported file formats for EDI transformations are
JSON
andXML
. - 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.
- name
-
- Required: Yes
- Type: string
Specifies the name of the transformer, used to identify it.
- sampleDocument
-
- Type: string
Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
- tags
-
- Type: Array of Tag structures
Specifies 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.
Result Syntax
[ 'createdAt' => <DateTime>, 'ediType' => [ 'x12Details' => [ 'transactionSet' => 'X12_110|X12_180|X12_204|X12_210|X12_211|X12_214|X12_215|X12_259|X12_260|X12_266|X12_269|X12_270|X12_271|X12_274|X12_275|X12_276|X12_277|X12_278|X12_310|X12_315|X12_322|X12_404|X12_410|X12_417|X12_421|X12_426|X12_810|X12_820|X12_824|X12_830|X12_832|X12_834|X12_835|X12_837|X12_844|X12_846|X12_849|X12_850|X12_852|X12_855|X12_856|X12_860|X12_861|X12_864|X12_865|X12_869|X12_870|X12_940|X12_945|X12_990|X12_997|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_5010|VERSION_5010_HIPAA', ], ], 'fileFormat' => 'XML|JSON', 'mappingTemplate' => '<string>', 'name' => '<string>', 'sampleDocument' => '<string>', 'status' => 'active|inactive', 'transformerArn' => '<string>', 'transformerId' => '<string>', ]
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
-
- Required: Yes
- Type: EdiType structure
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
-
- Required: Yes
- Type: string
Returns that the currently supported file formats for EDI transformations are
JSON
andXML
. - mappingTemplate
-
- Required: Yes
- Type: string
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.
- sampleDocument
-
- Type: string
Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
- status
-
- Required: Yes
- Type: string
Returns the state of the newly created transformer. The transformer can be either
active
orinactive
. For the transformer to be used in a capability, its status mustactive
. - 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
- ConflictException:
A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ServiceQuotaExceededException:
Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample CreateTransformer call
$result = $client->createTransformer([ 'name' => 'transformJSON', 'clientToken' => 'foo', 'ediType' => [ 'x12Details' => [ 'version' => 'VERSION_4010', 'transactionSet' => 'X12_110', ], ], 'fileFormat' => 'JSON', 'mappingTemplate' => '{}', 'sampleDocument' => 's3://test-bucket/sampleDoc.txt', 'tags' => [ [ 'Key' => 'sampleKey', 'Value' => 'sampleValue', ], ], ]);
Result syntax:
[ 'name' => 'transformJSON', 'createdAt' =>, 'ediType' => [ 'x12Details' => [ 'version' => 'VERSION_4010', 'transactionSet' => 'X12_110', ], ], 'fileFormat' => 'JSON', 'mappingTemplate' => '$', 'sampleDocument' => 's3://test-bucket/sampleDoc.txt', 'status' => 'inactive', 'transformerArn' => 'arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9', 'transformerId' => 'tr-974c129999f84d8c9', ]
DeleteCapability
$result = $client->deleteCapability
([/* ... */]); $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 = $client->deleteCapability([ 'capabilityId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- capabilityId
-
- Required: Yes
- Type: string
Specifies a system-assigned unique identifier for the capability.
Result Syntax
[]
Result Details
Errors
- ConflictException:
A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample DeleteCapabilty call
$result = $client->deleteCapability([ 'capabilityId' => 'ca-963a8121e4fc4e348', ]);
DeletePartnership
$result = $client->deletePartnership
([/* ... */]); $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 = $client->deletePartnership([ 'partnershipId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- partnershipId
-
- Required: Yes
- Type: string
Specifies the unique, system-generated identifier for a partnership.
Result Syntax
[]
Result Details
Errors
- ConflictException:
A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample DeletePartnership call
$result = $client->deletePartnership([ 'partnershipId' => 'ps-219fa02f5b4242af8', ]);
DeleteProfile
$result = $client->deleteProfile
([/* ... */]); $promise = $client->deleteProfileAsync
([/* ... */]);
Deletes the specified profile. A profile is the mechanism used to create the concept of a private network.
Parameter Syntax
$result = $client->deleteProfile([ 'profileId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- profileId
-
- Required: Yes
- Type: string
Specifies the unique, system-generated identifier for the profile.
Result Syntax
[]
Result Details
Errors
- ConflictException:
A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample DeleteProfile call
$result = $client->deleteProfile([ 'profileId' => 'p-60fbc37c87f04fce9', ]);
DeleteTransformer
$result = $client->deleteTransformer
([/* ... */]); $promise = $client->deleteTransformerAsync
([/* ... */]);
Deletes the specified transformer. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
Parameter Syntax
$result = $client->deleteTransformer([ 'transformerId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- transformerId
-
- Required: Yes
- Type: string
Specifies the system-assigned unique identifier for the transformer.
Result Syntax
[]
Result Details
Errors
- ConflictException:
A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample DeleteTransformer call
$result = $client->deleteTransformer([ 'transformerId' => 'tr-974c129999f84d8c9', ]);
GetCapability
$result = $client->getCapability
([/* ... */]); $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 = $client->getCapability([ 'capabilityId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- capabilityId
-
- Required: Yes
- Type: string
Specifies a system-assigned unique identifier for the capability.
Result Syntax
[ 'capabilityArn' => '<string>', 'capabilityId' => '<string>', 'configuration' => [ 'edi' => [ 'inputLocation' => [ 'bucketName' => '<string>', 'key' => '<string>', ], 'outputLocation' => [ 'bucketName' => '<string>', 'key' => '<string>', ], 'transformerId' => '<string>', 'type' => [ 'x12Details' => [ 'transactionSet' => 'X12_110|X12_180|X12_204|X12_210|X12_211|X12_214|X12_215|X12_259|X12_260|X12_266|X12_269|X12_270|X12_271|X12_274|X12_275|X12_276|X12_277|X12_278|X12_310|X12_315|X12_322|X12_404|X12_410|X12_417|X12_421|X12_426|X12_810|X12_820|X12_824|X12_830|X12_832|X12_834|X12_835|X12_837|X12_844|X12_846|X12_849|X12_850|X12_852|X12_855|X12_856|X12_860|X12_861|X12_864|X12_865|X12_869|X12_870|X12_940|X12_945|X12_990|X12_997|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_5010|VERSION_5010_HIPAA', ], ], ], ], 'createdAt' => <DateTime>, 'instructionsDocuments' => [ [ 'bucketName' => '<string>', 'key' => '<string>', ], // ... ], 'modifiedAt' => <DateTime>, 'name' => '<string>', 'type' => 'edi', ]
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
Returns one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.
- 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
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample GetCapabilty call
$result = $client->getCapability([ 'capabilityId' => 'ca-963a8121e4fc4e348', ]);
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', ], ], 'modifiedAt' => , ]
GetPartnership
$result = $client->getPartnership
([/* ... */]); $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 = $client->getPartnership([ 'partnershipId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- partnershipId
-
- Required: Yes
- Type: string
Specifies the unique, system-generated identifier for a partnership.
Result Syntax
[ 'capabilities' => ['<string>', ...], 'createdAt' => <DateTime>, 'email' => '<string>', 'modifiedAt' => <DateTime>, 'name' => '<string>', 'partnershipArn' => '<string>', 'partnershipId' => '<string>', 'phone' => '<string>', 'profileId' => '<string>', 'tradingPartnerId' => '<string>', ]
Result Details
Members
- capabilities
-
- Type: Array of strings
Returns one or more capabilities associated with this partnership.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Returns a timestamp for creation date and time of the partnership.
-
- Type: string
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
-
- Type: string
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
-
- Type: string
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
-
- Type: string
Returns the unique identifier for the partner for this partnership.
Errors
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample GetPartnership call
$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 = $client->getProfile
([/* ... */]); $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 = $client->getProfile([ 'profileId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- profileId
-
- Required: Yes
- Type: string
Specifies the unique, system-generated identifier for the profile.
Result Syntax
[ 'businessName' => '<string>', 'createdAt' => <DateTime>, 'email' => '<string>', 'logGroupName' => '<string>', 'logging' => 'ENABLED|DISABLED', 'modifiedAt' => <DateTime>, 'name' => '<string>', 'phone' => '<string>', 'profileArn' => '<string>', 'profileId' => '<string>', ]
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.
-
- Type: string
Returns the email address associated with this customer profile.
- logGroupName
-
- Type: string
Returns the name of the logging group.
- logging
-
- Type: string
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
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample GetProfile call
$result = $client->getProfile([ 'profileId' => 'p-60fbc37c87f04fce9', ]);
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', ]
GetTransformer
$result = $client->getTransformer
([/* ... */]); $promise = $client->getTransformerAsync
([/* ... */]);
Retrieves the details for the transformer specified by the transformer ID. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
Parameter Syntax
$result = $client->getTransformer([ 'transformerId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- transformerId
-
- Required: Yes
- Type: string
Specifies the system-assigned unique identifier for the transformer.
Result Syntax
[ 'createdAt' => <DateTime>, 'ediType' => [ 'x12Details' => [ 'transactionSet' => 'X12_110|X12_180|X12_204|X12_210|X12_211|X12_214|X12_215|X12_259|X12_260|X12_266|X12_269|X12_270|X12_271|X12_274|X12_275|X12_276|X12_277|X12_278|X12_310|X12_315|X12_322|X12_404|X12_410|X12_417|X12_421|X12_426|X12_810|X12_820|X12_824|X12_830|X12_832|X12_834|X12_835|X12_837|X12_844|X12_846|X12_849|X12_850|X12_852|X12_855|X12_856|X12_860|X12_861|X12_864|X12_865|X12_869|X12_870|X12_940|X12_945|X12_990|X12_997|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_5010|VERSION_5010_HIPAA', ], ], 'fileFormat' => 'XML|JSON', 'mappingTemplate' => '<string>', 'modifiedAt' => <DateTime>, 'name' => '<string>', 'sampleDocument' => '<string>', 'status' => 'active|inactive', 'transformerArn' => '<string>', 'transformerId' => '<string>', ]
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
-
- Required: Yes
- Type: EdiType structure
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
-
- Required: Yes
- Type: string
Returns that the currently supported file formats for EDI transformations are
JSON
andXML
. - mappingTemplate
-
- Required: Yes
- Type: string
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.
- sampleDocument
-
- Type: string
Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
- status
-
- Required: Yes
- Type: string
Returns the state of the newly created transformer. The transformer can be either
active
orinactive
. For the transformer to be used in a capability, its status mustactive
. - 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
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample GetTransformer call
$result = $client->getTransformer([ 'transformerId' => 'tr-974c129999f84d8c9', ]);
Result syntax:
[ 'name' => 'transformJSON', 'createdAt' =>, 'ediType' => [ 'x12Details' => [ 'version' => 'VERSION_4010', 'transactionSet' => 'X12_110', ], ], 'fileFormat' => 'JSON', 'mappingTemplate' => '$', 'modifiedAt' => , 'sampleDocument' => 's3://test-bucket/sampleDoc.txt', 'status' => 'inactive', 'transformerArn' => 'arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9', 'transformerId' => 'tr-974c129999f84d8c9', ]
GetTransformerJob
$result = $client->getTransformerJob
([/* ... */]); $promise = $client->getTransformerJobAsync
([/* ... */]);
Returns the details of the transformer run, based on the Transformer job ID.
Parameter Syntax
$result = $client->getTransformerJob([ 'transformerId' => '<string>', // REQUIRED 'transformerJobId' => '<string>', // 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' => '<string>', 'outputFiles' => [ [ 'bucketName' => '<string>', 'key' => '<string>', ], // ... ], 'status' => 'running|succeeded|failed', ]
Result Details
Members
- message
-
- Type: string
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
, orfailed
.
Errors
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample GetTransformerJob call
$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 = $client->listCapabilities
([/* ... */]); $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 = $client->listCapabilities([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
Specifies the maximum number of capabilities to return.
- nextToken
-
- Type: string
When additional results are obtained from the command, a
NextToken
parameter is returned in the output. You can then pass theNextToken
parameter in a subsequent command to continue listing additional resources.
Result Syntax
[ 'capabilities' => [ [ 'capabilityId' => '<string>', 'createdAt' => <DateTime>, 'modifiedAt' => <DateTime>, 'name' => '<string>', 'type' => 'edi', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- capabilities
-
- Required: Yes
- Type: Array of CapabilitySummary structures
Returns one or more capabilities associated with this partnership.
- nextToken
-
- Type: string
When additional results are obtained from the command, a
NextToken
parameter is returned in the output. You can then pass theNextToken
parameter in a subsequent command to continue listing additional resources.
Errors
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample ListCapabilities call
$result = $client->listCapabilities([ 'maxResults' => 50, 'nextToken' => 'foo', ]);
Result syntax:
[ 'capabilities' => [ [ 'name' => 'b2biexample', 'type' => 'edi', 'capabilityId' => 'ca-963a8121e4fc4e348', 'createdAt' =>, 'modifiedAt' => , ], ], 'nextToken' => 'foo', ]
ListPartnerships
$result = $client->listPartnerships
([/* ... */]); $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 = $client->listPartnerships([ 'maxResults' => <integer>, 'nextToken' => '<string>', 'profileId' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
Specifies the maximum number of capabilities to return.
- nextToken
-
- Type: string
When additional results are obtained from the command, a
NextToken
parameter is returned in the output. You can then pass theNextToken
parameter in a subsequent command to continue listing additional resources. - profileId
-
- Type: string
Specifies the unique, system-generated identifier for the profile connected to this partnership.
Result Syntax
[ 'nextToken' => '<string>', 'partnerships' => [ [ 'capabilities' => ['<string>', ...], 'createdAt' => <DateTime>, 'modifiedAt' => <DateTime>, 'name' => '<string>', 'partnershipId' => '<string>', 'profileId' => '<string>', 'tradingPartnerId' => '<string>', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
When additional results are obtained from the command, a
NextToken
parameter is returned in the output. You can then pass theNextToken
parameter in a subsequent command to continue listing additional resources. - partnerships
-
- Required: Yes
- Type: Array of PartnershipSummary structures
Specifies a list of your partnerships.
Errors
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample ListPartnerships call
$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 = $client->listProfiles
([/* ... */]); $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 = $client->listProfiles([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
Specifies the maximum number of profiles to return.
- nextToken
-
- Type: string
When additional results are obtained from the command, a
NextToken
parameter is returned in the output. You can then pass theNextToken
parameter in a subsequent command to continue listing additional resources.
Result Syntax
[ 'nextToken' => '<string>', 'profiles' => [ [ 'businessName' => '<string>', 'createdAt' => <DateTime>, 'logGroupName' => '<string>', 'logging' => 'ENABLED|DISABLED', 'modifiedAt' => <DateTime>, 'name' => '<string>', 'profileId' => '<string>', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
When additional results are obtained from the command, a
NextToken
parameter is returned in the output. You can then pass theNextToken
parameter in a subsequent command to continue listing additional resources. - profiles
-
- Required: Yes
- Type: Array of ProfileSummary structures
Returns an array of
ProfileSummary
objects.
Errors
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample ListProfiles call
$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 = $client->listTagsForResource
([/* ... */]); $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 = $client->listTagsForResource([ 'ResourceARN' => '<string>', // 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' => '<string>', 'Value' => '<string>', ], // ... ], ]
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
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample ListTagsForResources call
$result = $client->listTagsForResource([ 'ResourceARN' => 'arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9', ]);
Result syntax:
[ 'Tags' => [ [ 'Key' => 'sampleKey', 'Value' => 'SampleValue', ], ], ]
ListTransformers
$result = $client->listTransformers
([/* ... */]); $promise = $client->listTransformersAsync
([/* ... */]);
Lists the available transformers. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
Parameter Syntax
$result = $client->listTransformers([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
Specifies the number of items to return for the API response.
- nextToken
-
- Type: string
When additional results are obtained from the command, a
NextToken
parameter is returned in the output. You can then pass theNextToken
parameter in a subsequent command to continue listing additional resources.
Result Syntax
[ 'nextToken' => '<string>', 'transformers' => [ [ 'createdAt' => <DateTime>, 'ediType' => [ 'x12Details' => [ 'transactionSet' => 'X12_110|X12_180|X12_204|X12_210|X12_211|X12_214|X12_215|X12_259|X12_260|X12_266|X12_269|X12_270|X12_271|X12_274|X12_275|X12_276|X12_277|X12_278|X12_310|X12_315|X12_322|X12_404|X12_410|X12_417|X12_421|X12_426|X12_810|X12_820|X12_824|X12_830|X12_832|X12_834|X12_835|X12_837|X12_844|X12_846|X12_849|X12_850|X12_852|X12_855|X12_856|X12_860|X12_861|X12_864|X12_865|X12_869|X12_870|X12_940|X12_945|X12_990|X12_997|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_5010|VERSION_5010_HIPAA', ], ], 'fileFormat' => 'XML|JSON', 'mappingTemplate' => '<string>', 'modifiedAt' => <DateTime>, 'name' => '<string>', 'sampleDocument' => '<string>', 'status' => 'active|inactive', 'transformerId' => '<string>', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
When additional results are obtained from the command, a
NextToken
parameter is returned in the output. You can then pass theNextToken
parameter in a subsequent command to continue listing additional resources. - 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. TheTransformerSummary
contains all the details for a specific transformer.
Errors
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample ListTransformers call
$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 = $client->startTransformerJob
([/* ... */]); $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 B2BI Data Interchange.
If you only want to transform EDI (electronic data interchange) documents, you don't need to create profiles, partnerships or capabilities. Just create and configure a transformer, and then run the StartTransformerJob
API to process your files.
Parameter Syntax
$result = $client->startTransformerJob([ 'clientToken' => '<string>', 'inputFile' => [ // REQUIRED 'bucketName' => '<string>', 'key' => '<string>', ], 'outputLocation' => [ // REQUIRED 'bucketName' => '<string>', 'key' => '<string>', ], 'transformerId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- clientToken
-
- Type: string
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' => '<string>', ]
Result Details
Members
- transformerJobId
-
- Required: Yes
- Type: string
Returns the unique, system-generated identifier for a transformer run.
Errors
- ConflictException:
A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample StartTransformerJob call
$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 = $client->tagResource
([/* ... */]); $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 = $client->tagResource([ 'ResourceARN' => '<string>', // REQUIRED 'Tags' => [ // REQUIRED [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // 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
Specifies 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.
Result Syntax
[]
Result Details
Errors
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample TagResource call
$result = $client->tagResource([ 'ResourceARN' => 'arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9', 'Tags' => [ [ 'Key' => 'sampleKey', 'Value' => 'SampleValue', ], ], ]);
TestMapping
$result = $client->testMapping
([/* ... */]); $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 = $client->testMapping([ 'fileFormat' => 'XML|JSON', // REQUIRED 'inputFileContent' => '<string>', // REQUIRED 'mappingTemplate' => '<string>', // REQUIRED ]);
Parameter Details
Members
- fileFormat
-
- Required: Yes
- Type: string
Specifies that the currently supported file formats for EDI transformations are
JSON
andXML
. - 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.
Result Syntax
[ 'mappedFileContent' => '<string>', ]
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
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample TestMapping call
$result = $client->testMapping([ 'fileFormat' => 'JSON', 'inputFileContent' => 'Sample file content', 'mappingTemplate' => '$', ]);
Result syntax:
[ 'mappedFileContent' => 'Sample file content', ]
TestParsing
$result = $client->testParsing
([/* ... */]); $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 = $client->testParsing([ 'ediType' => [ // REQUIRED 'x12Details' => [ 'transactionSet' => 'X12_110|X12_180|X12_204|X12_210|X12_211|X12_214|X12_215|X12_259|X12_260|X12_266|X12_269|X12_270|X12_271|X12_274|X12_275|X12_276|X12_277|X12_278|X12_310|X12_315|X12_322|X12_404|X12_410|X12_417|X12_421|X12_426|X12_810|X12_820|X12_824|X12_830|X12_832|X12_834|X12_835|X12_837|X12_844|X12_846|X12_849|X12_850|X12_852|X12_855|X12_856|X12_860|X12_861|X12_864|X12_865|X12_869|X12_870|X12_940|X12_945|X12_990|X12_997|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_5010|VERSION_5010_HIPAA', ], ], 'fileFormat' => 'XML|JSON', // REQUIRED 'inputFile' => [ // REQUIRED 'bucketName' => '<string>', 'key' => '<string>', ], ]);
Parameter Details
Members
- ediType
-
- Required: Yes
- Type: EdiType structure
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
-
- Required: Yes
- Type: string
Specifies that the currently supported file formats for EDI transformations are
JSON
andXML
. - 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' => '<string>', ]
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
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample TestParsing call
$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 = $client->untagResource
([/* ... */]); $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 = $client->untagResource([ 'ResourceARN' => '<string>', // REQUIRED 'TagKeys' => ['<string>', ...], // 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
Specifies 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.
Result Syntax
[]
Result Details
Errors
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample UntagResource call
$result = $client->untagResource([ 'ResourceARN' => 'arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9', 'TagKeys' => [ 'sampleKey', ], ]);
UpdateCapability
$result = $client->updateCapability
([/* ... */]); $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 = $client->updateCapability([ 'capabilityId' => '<string>', // REQUIRED 'configuration' => [ 'edi' => [ 'inputLocation' => [ // REQUIRED 'bucketName' => '<string>', 'key' => '<string>', ], 'outputLocation' => [ // REQUIRED 'bucketName' => '<string>', 'key' => '<string>', ], 'transformerId' => '<string>', // REQUIRED 'type' => [ // REQUIRED 'x12Details' => [ 'transactionSet' => 'X12_110|X12_180|X12_204|X12_210|X12_211|X12_214|X12_215|X12_259|X12_260|X12_266|X12_269|X12_270|X12_271|X12_274|X12_275|X12_276|X12_277|X12_278|X12_310|X12_315|X12_322|X12_404|X12_410|X12_417|X12_421|X12_426|X12_810|X12_820|X12_824|X12_830|X12_832|X12_834|X12_835|X12_837|X12_844|X12_846|X12_849|X12_850|X12_852|X12_855|X12_856|X12_860|X12_861|X12_864|X12_865|X12_869|X12_870|X12_940|X12_945|X12_990|X12_997|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_5010|VERSION_5010_HIPAA', ], ], ], ], 'instructionsDocuments' => [ [ 'bucketName' => '<string>', 'key' => '<string>', ], // ... ], 'name' => '<string>', ]);
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
Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.
- name
-
- Type: string
Specifies a new name for the capability, to replace the existing name.
Result Syntax
[ 'capabilityArn' => '<string>', 'capabilityId' => '<string>', 'configuration' => [ 'edi' => [ 'inputLocation' => [ 'bucketName' => '<string>', 'key' => '<string>', ], 'outputLocation' => [ 'bucketName' => '<string>', 'key' => '<string>', ], 'transformerId' => '<string>', 'type' => [ 'x12Details' => [ 'transactionSet' => 'X12_110|X12_180|X12_204|X12_210|X12_211|X12_214|X12_215|X12_259|X12_260|X12_266|X12_269|X12_270|X12_271|X12_274|X12_275|X12_276|X12_277|X12_278|X12_310|X12_315|X12_322|X12_404|X12_410|X12_417|X12_421|X12_426|X12_810|X12_820|X12_824|X12_830|X12_832|X12_834|X12_835|X12_837|X12_844|X12_846|X12_849|X12_850|X12_852|X12_855|X12_856|X12_860|X12_861|X12_864|X12_865|X12_869|X12_870|X12_940|X12_945|X12_990|X12_997|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_5010|VERSION_5010_HIPAA', ], ], ], ], 'createdAt' => <DateTime>, 'instructionsDocuments' => [ [ 'bucketName' => '<string>', 'key' => '<string>', ], // ... ], 'modifiedAt' => <DateTime>, 'name' => '<string>', 'type' => 'edi', ]
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
Returns one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.
- 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
- ConflictException:
A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ServiceQuotaExceededException:
Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample UpdateCapability call
$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:
[ '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', ], ], 'modifiedAt' => , ]
UpdatePartnership
$result = $client->updatePartnership
([/* ... */]); $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 = $client->updatePartnership([ 'capabilities' => ['<string>', ...], 'name' => '<string>', 'partnershipId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- capabilities
-
- Type: Array of strings
List of the capabilities associated with this partnership.
- name
-
- Type: string
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' => ['<string>', ...], 'createdAt' => <DateTime>, 'email' => '<string>', 'modifiedAt' => <DateTime>, 'name' => '<string>', 'partnershipArn' => '<string>', 'partnershipId' => '<string>', 'phone' => '<string>', 'profileId' => '<string>', 'tradingPartnerId' => '<string>', ]
Result Details
Members
- capabilities
-
- Type: Array of strings
Returns one or more capabilities associated with this partnership.
- 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.
-
- Type: string
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
-
- Type: string
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
-
- Type: string
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
-
- Type: string
Returns the unique, system-generated identifier for a trading partner.
Errors
- ConflictException:
A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ServiceQuotaExceededException:
Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample UpdatePartnership call
$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 = $client->updateProfile
([/* ... */]); $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 = $client->updateProfile([ 'businessName' => '<string>', 'email' => '<string>', 'name' => '<string>', 'phone' => '<string>', 'profileId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- businessName
-
- Type: string
Specifies the name for the business associated with this profile.
-
- Type: string
Specifies the email address associated with this customer profile.
- name
-
- Type: string
The name of the profile, used to identify it.
- phone
-
- Type: string
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' => '<string>', 'createdAt' => <DateTime>, 'email' => '<string>', 'logGroupName' => '<string>', 'logging' => 'ENABLED|DISABLED', 'modifiedAt' => <DateTime>, 'name' => '<string>', 'phone' => '<string>', 'profileArn' => '<string>', 'profileId' => '<string>', ]
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.
-
- Type: string
Returns the email address associated with this customer profile.
- logGroupName
-
- Type: string
Returns the name of the logging group.
- logging
-
- Type: string
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
- ConflictException:
A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ServiceQuotaExceededException:
Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample UpdateProfile call
$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 = $client->updateTransformer
([/* ... */]); $promise = $client->updateTransformerAsync
([/* ... */]);
Updates the specified parameters for a transformer. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
Parameter Syntax
$result = $client->updateTransformer([ 'ediType' => [ 'x12Details' => [ 'transactionSet' => 'X12_110|X12_180|X12_204|X12_210|X12_211|X12_214|X12_215|X12_259|X12_260|X12_266|X12_269|X12_270|X12_271|X12_274|X12_275|X12_276|X12_277|X12_278|X12_310|X12_315|X12_322|X12_404|X12_410|X12_417|X12_421|X12_426|X12_810|X12_820|X12_824|X12_830|X12_832|X12_834|X12_835|X12_837|X12_844|X12_846|X12_849|X12_850|X12_852|X12_855|X12_856|X12_860|X12_861|X12_864|X12_865|X12_869|X12_870|X12_940|X12_945|X12_990|X12_997|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_5010|VERSION_5010_HIPAA', ], ], 'fileFormat' => 'XML|JSON', 'mappingTemplate' => '<string>', 'name' => '<string>', 'sampleDocument' => '<string>', 'status' => 'active|inactive', 'transformerId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ediType
-
- Type: EdiType structure
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
-
- Type: string
Specifies that the currently supported file formats for EDI transformations are
JSON
andXML
. - mappingTemplate
-
- Type: string
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
- name
-
- Type: string
Specify a new name for the transformer, if you want to update it.
- sampleDocument
-
- Type: string
Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
- status
-
- Type: string
Specifies the transformer's status. You can update the state of the transformer, from
active
toinactive
, orinactive
toactive
. - transformerId
-
- Required: Yes
- Type: string
Specifies the system-assigned unique identifier for the transformer.
Result Syntax
[ 'createdAt' => <DateTime>, 'ediType' => [ 'x12Details' => [ 'transactionSet' => 'X12_110|X12_180|X12_204|X12_210|X12_211|X12_214|X12_215|X12_259|X12_260|X12_266|X12_269|X12_270|X12_271|X12_274|X12_275|X12_276|X12_277|X12_278|X12_310|X12_315|X12_322|X12_404|X12_410|X12_417|X12_421|X12_426|X12_810|X12_820|X12_824|X12_830|X12_832|X12_834|X12_835|X12_837|X12_844|X12_846|X12_849|X12_850|X12_852|X12_855|X12_856|X12_860|X12_861|X12_864|X12_865|X12_869|X12_870|X12_940|X12_945|X12_990|X12_997|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_5010|VERSION_5010_HIPAA', ], ], 'fileFormat' => 'XML|JSON', 'mappingTemplate' => '<string>', 'modifiedAt' => <DateTime>, 'name' => '<string>', 'sampleDocument' => '<string>', 'status' => 'active|inactive', 'transformerArn' => '<string>', 'transformerId' => '<string>', ]
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
-
- Required: Yes
- Type: EdiType structure
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
-
- Required: Yes
- Type: string
Returns that the currently supported file formats for EDI transformations are
JSON
andXML
. - mappingTemplate
-
- Required: Yes
- Type: string
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.
- sampleDocument
-
- Type: string
Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
- status
-
- Required: Yes
- Type: string
Returns the state of the newly created transformer. The transformer can be either
active
orinactive
. For the transformer to be used in a capability, its status mustactive
. - 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
- ConflictException:
A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ValidationException:
Occurs when a B2BI object cannot be validated against a request from another object.
- ThrottlingException:
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
- ResourceNotFoundException:
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
- ServiceQuotaExceededException:
Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
- InternalServerException:
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Examples
Example 1: Sample UpdateTransformer call
$result = $client->updateTransformer([ 'name' => 'transformJSON', 'ediType' => [ 'x12Details' => [ 'version' => 'VERSION_4010', 'transactionSet' => 'X12_110', ], ], 'fileFormat' => 'JSON', 'mappingTemplate' => '{}', 'sampleDocument' => 's3://test-bucket/sampleDoc.txt', 'status' => 'inactive', 'transformerId' => 'tr-974c129999f84d8c9', ]);
Result syntax:
[ 'name' => 'transformJSON', 'createdAt' =>, 'ediType' => [ 'x12Details' => [ 'version' => 'VERSION_4010', 'transactionSet' => 'X12_110', ], ], 'fileFormat' => 'JSON', 'mappingTemplate' => '$', 'modifiedAt' => , 'sampleDocument' => 's3://test-bucket/sampleDoc.txt', 'status' => 'inactive', 'transformerArn' => 'arn:aws:b2bi:us-west-2:607686414464:transformer/tr-974c129999f84d8c9', 'transformerId' => 'tr-974c129999f84d8c9', ]
Shapes
AccessDeniedException
Description
You do not have sufficient access to perform this action.
Members
- message
-
- Required: Yes
- Type: string
CapabilityConfiguration
Description
A capability object. Currently, only EDI (electronic data interchange) capabilities are supported. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
Members
- edi
-
- Type: EdiConfiguration structure
An EDI (electronic data interchange) configuration object.
CapabilitySummary
Description
Returns the capability summary details. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
Members
- capabilityId
-
- Required: Yes
- Type: string
Returns a system-assigned unique identifier for the capability.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Returns a timestamp for creation date and time of the capability.
- modifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Returns a timestamp that identifies the most recent date and time that the capability was modified.
- name
-
- Required: Yes
- Type: string
The display name of the capability.
- type
-
- Required: Yes
- Type: string
Returns the type of the capability. Currently, only
edi
is supported.
ConflictException
Description
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.
Members
- message
-
- Required: Yes
- Type: string
EdiConfiguration
Description
Specifies the details for the EDI (electronic data interchange) transformation.
Members
- inputLocation
-
- Required: Yes
- Type: S3Location structure
Contains the Amazon S3 bucket and prefix for the location of the input file, which is contained in an
S3Location
object. - outputLocation
-
- Required: Yes
- Type: S3Location structure
Contains the Amazon S3 bucket and prefix for the location of the output file, which is contained in an
S3Location
object. - transformerId
-
- Required: Yes
- Type: string
Returns the system-assigned unique identifier for the transformer.
- type
-
- Required: Yes
- Type: EdiType structure
Returns the type of the capability. Currently, only
edi
is supported.
EdiType
Description
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.
Members
- x12Details
-
- Type: X12Details structure
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.
InternalServerException
Description
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
Members
- message
-
- Required: Yes
- Type: string
- retryAfterSeconds
-
- Type: int
The server attempts to retry a failed command.
PartnershipSummary
Description
A structure that contains the details for a partnership. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
Members
- capabilities
-
- Type: Array of strings
Returns one or more capabilities associated with this partnership.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Returns a timestamp for creation date and time of the partnership.
- 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
-
- Type: string
Returns the name of the partnership.
- partnershipId
-
- Required: Yes
- Type: string
Returns the unique, system-generated identifier for a partnership.
- profileId
-
- Required: Yes
- Type: string
Returns the unique, system-generated identifier for the profile connected to this partnership.
- tradingPartnerId
-
- Type: string
Returns the unique, system-generated identifier for a trading partner.
ProfileSummary
Description
Contains the details for a profile. A profile is the mechanism used to create the concept of a private network.
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 the timestamp for creation date and time of the profile.
- logGroupName
-
- Type: string
Returns the name of the logging group.
- logging
-
- Type: string
Specifies whether or not logging is enabled for this profile.
- modifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Returns the timestamp that identifies the most recent date and time that the profile was modified.
- name
-
- Required: Yes
- Type: string
Returns the display name for profile.
- profileId
-
- Required: Yes
- Type: string
Returns the unique, system-generated identifier for the profile.
ResourceNotFoundException
Description
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.
Members
- message
-
- Required: Yes
- Type: string
S3Location
Description
Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2BI Data Interchange. File locations in Amazon S3 are identified using a combination of the bucket and key.
Members
- bucketName
-
- Type: string
Specifies the name of the Amazon S3 bucket.
- key
-
- Type: string
Specifies the Amazon S3 key for the file location.
ServiceQuotaExceededException
Description
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.
Members
- message
-
- Required: Yes
- Type: string
- quotaCode
-
- Required: Yes
- Type: string
The quota that was exceeded, which caused the exception.
- resourceId
-
- Required: Yes
- Type: string
The ID for the resource that exceeded the quota, which caused the exception.
- resourceType
-
- Required: Yes
- Type: string
The resource type (profile, partnership, transformer, or capability) that exceeded the quota, which caused the exception.
- serviceCode
-
- Required: Yes
- Type: string
The code responsible for exceeding the quota, which caused the exception.
Tag
Description
Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to capabilities, partnerships, profiles and transformers. A tag key can take more than one value. For example, to group capabilities for accounting purposes, you might create a tag called Group
and assign the values Research
and Accounting
to that group.
Members
- Key
-
- Required: Yes
- Type: string
Specifies the name assigned to the tag that you create.
- Value
-
- Required: Yes
- Type: string
Contains one or more values that you assigned to the key name that you create.
ThrottlingException
Description
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
Members
- message
-
- Required: Yes
- Type: string
- retryAfterSeconds
-
- Type: int
The server attempts to retry a command that was throttled.
TransformerSummary
Description
Contains the details for a transformer object. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
Members
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Returns a timestamp indicating when the transformer was created. For example,
2023-07-20T19:58:44.624Z
. - ediType
-
- Required: Yes
- Type: EdiType structure
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
-
- Required: Yes
- Type: string
Returns that the currently supported file formats for EDI transformations are
JSON
andXML
. - mappingTemplate
-
- Required: Yes
- Type: string
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 representing the date and time for the most recent change for the transformer object.
- name
-
- Required: Yes
- Type: string
Returns the descriptive name for the transformer.
- sampleDocument
-
- Type: string
Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
- status
-
- Required: Yes
- Type: string
Returns the state of the newly created transformer. The transformer can be either
active
orinactive
. For the transformer to be used in a capability, its status mustactive
. - transformerId
-
- Required: Yes
- Type: string
Returns the system-assigned unique identifier for the transformer.
ValidationException
Description
Occurs when a B2BI object cannot be validated against a request from another object.
Members
- Message
-
- Required: Yes
- Type: string
X12Details
Description
A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file.
Members
- transactionSet
-
- Type: string
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
- version
-
- Type: string
Returns the version to use for the specified X12 transaction set.
</p>