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

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

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

Result Syntax

[
    'capabilities' => ['<string>', ...],
    'createdAt' => <DateTime>,
    'email' => '<string>',
    'name' => '<string>',
    'partnershipArn' => '<string>',
    'partnershipId' => '<string>',
    'phone' => '<string>',
    'profileId' => '<string>',
    'tradingPartnerId' => '<string>',
]

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.

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

Result Syntax

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

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.

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

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

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

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

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

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

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

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

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

Result Syntax

[
    'capabilities' => ['<string>', ...],
    'createdAt' => <DateTime>,
    'email' => '<string>',
    'modifiedAt' => <DateTime>,
    'name' => '<string>',
    'partnershipArn' => '<string>',
    'partnershipId' => '<string>',
    'phone' => '<string>',
    'profileId' => '<string>',
    'tradingPartnerId' => '<string>',
]

Result Details

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

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

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[
    'nextToken' => '<string>',
    'partnerships' => [
        [
            'capabilities' => ['<string>', ...],
            'createdAt' => <DateTime>,
            'modifiedAt' => <DateTime>,
            'name' => '<string>',
            'partnershipId' => '<string>',
            'profileId' => '<string>',
            'tradingPartnerId' => '<string>',
        ],
        // ...
    ],
]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

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 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

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

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

Result Syntax

[
    'transformerJobId' => '<string>',
]

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 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

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

Result Syntax

[
    'mappedFileContent' => '<string>',
]

Result Details

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

Result Syntax

[
    'parsedFileContent' => '<string>',
]

Result Details

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

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

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

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

Result Syntax

[
    'capabilities' => ['<string>', ...],
    'createdAt' => <DateTime>,
    'email' => '<string>',
    'modifiedAt' => <DateTime>,
    'name' => '<string>',
    'partnershipArn' => '<string>',
    'partnershipId' => '<string>',
    'phone' => '<string>',
    'profileId' => '<string>',
    'tradingPartnerId' => '<string>',
]

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.

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

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

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

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

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',
]