This is the Amazon Web Services B2B Data Interchange API Reference. It provides descriptions, API request parameters, and the XML response for each of the B2BI API actions.
B2BI enables automated exchange of EDI (electronic data interchange) based business-critical transactions at cloud scale, with elasticity and pay-as-you-go pricing. Businesses use EDI documents to exchange transactional data with trading partners, such as suppliers and end customers, using standardized formats such as X12.
Rather than actually running a command, you can use the --generate-cli-skeleton parameter with any API call to generate and display a parameter template. You can then use the generated template to customize and use as input on a later command. For details, see Generate and use a parameter skeleton file.
Instantiates a capability based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
", "CreatePartnership": "Creates a partnership between a customer and a trading partner, based on the supplied parameters. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
", "CreateProfile": "Creates a customer profile. You can have up to five customer profiles, each representing a distinct private network. A profile is the mechanism used to create the concept of a private network.
", "CreateTransformer": "Creates a transformer. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
", "DeleteCapability": "Deletes the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
", "DeletePartnership": "Deletes the specified partnership. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
", "DeleteProfile": "Deletes the specified profile. A profile is the mechanism used to create the concept of a private network.
", "DeleteTransformer": "Deletes the specified transformer. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
", "GetCapability": "Retrieves the details for the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
", "GetPartnership": "Retrieves the details for a partnership, based on the partner and profile IDs specified. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
", "GetProfile": "Retrieves the details for the profile specified by the profile ID. A profile is the mechanism used to create the concept of a private network.
", "GetTransformer": "Retrieves the details for the transformer specified by the transformer ID. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
", "GetTransformerJob": "Returns the details of the transformer run, based on the Transformer job ID.
", "ListCapabilities": "Lists the capabilities associated with your Amazon Web Services account for your current or specified region. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
", "ListPartnerships": "Lists the partnerships associated with your Amazon Web Services account for your current or specified region. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
", "ListProfiles": "Lists the profiles associated with your Amazon Web Services account for your current or specified region. A profile is the mechanism used to create the concept of a private network.
", "ListTagsForResource": "Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a capability, partnership, profile, or transformer.
", "ListTransformers": "Lists the available transformers. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
", "StartTransformerJob": "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.
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.
", "TestMapping": "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.
Parses the input EDI (electronic data interchange) file. The input file has a file size limit of 250 KB.
", "UntagResource": "Detaches a key-value pair from the specified resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and other entities.
", "UpdateCapability": "Updates some of the parameters for a capability, based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
", "UpdatePartnership": "Updates some of the parameters for a partnership between a customer and trading partner. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
", "UpdateProfile": "Updates the specified parameters for a profile. A profile is the mechanism used to create the concept of a private network.
", "UpdateTransformer": "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.
" }, "shapes": { "AccessDeniedException": { "base": "You do not have sufficient access to perform this action.
", "refs": { } }, "AmazonResourceName": { "base": null, "refs": { "ListTagsForResourceRequest$ResourceARN": "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.
", "TagResourceRequest$ResourceARN": "Specifies an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
", "UntagResourceRequest$ResourceARN": "Specifies an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
" } }, "BucketName": { "base": null, "refs": { "S3Location$bucketName": "Specifies the name of the Amazon S3 bucket.
" } }, "BusinessName": { "base": null, "refs": { "CreateProfileRequest$businessName": "Specifies the name for the business associated with this profile.
", "CreateProfileResponse$businessName": "Returns the name for the business associated with this profile.
", "GetProfileResponse$businessName": "Returns the name for the business associated with this profile.
", "ProfileSummary$businessName": "Returns the name for the business associated with this profile.
", "UpdateProfileRequest$businessName": "Specifies the name for the business associated with this profile.
", "UpdateProfileResponse$businessName": "Returns the name for the business associated with this profile.
" } }, "CapabilityConfiguration": { "base": "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.
", "refs": { "CreateCapabilityRequest$configuration": "Specifies a structure that contains the details for a capability.
", "CreateCapabilityResponse$configuration": "Returns a structure that contains the details for a capability.
", "GetCapabilityResponse$configuration": "Returns a structure that contains the details for a capability.
", "UpdateCapabilityRequest$configuration": "Specifies a structure that contains the details for a capability.
", "UpdateCapabilityResponse$configuration": "Returns a structure that contains the details for a capability.
" } }, "CapabilityId": { "base": null, "refs": { "CapabilitySummary$capabilityId": "Returns a system-assigned unique identifier for the capability.
", "CreateCapabilityResponse$capabilityId": "Returns a system-assigned unique identifier for the capability.
", "DeleteCapabilityRequest$capabilityId": "Specifies a system-assigned unique identifier for the capability.
", "GetCapabilityRequest$capabilityId": "Specifies a system-assigned unique identifier for the capability.
", "GetCapabilityResponse$capabilityId": "Returns a system-assigned unique identifier for the capability.
", "PartnershipCapabilities$member": null, "UpdateCapabilityRequest$capabilityId": "Specifies a system-assigned unique identifier for the capability.
", "UpdateCapabilityResponse$capabilityId": "Returns a system-assigned unique identifier for the capability.
" } }, "CapabilityList": { "base": null, "refs": { "ListCapabilitiesResponse$capabilities": "Returns one or more capabilities associated with this partnership.
" } }, "CapabilityName": { "base": null, "refs": { "CapabilitySummary$name": "The display name of the capability.
", "CreateCapabilityRequest$name": "Specifies the name of the capability, used to identify it.
", "CreateCapabilityResponse$name": "Returns the name of the capability used to identify it.
", "GetCapabilityResponse$name": "Returns the name of the capability, used to identify it.
", "UpdateCapabilityRequest$name": "Specifies a new name for the capability, to replace the existing name.
", "UpdateCapabilityResponse$name": "Returns the name of the capability, used to identify it.
" } }, "CapabilitySummary": { "base": "Returns the capability summary details. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
", "refs": { "CapabilityList$member": null } }, "CapabilityType": { "base": null, "refs": { "CapabilitySummary$type": "Returns the type of the capability. Currently, only edi is supported.
Specifies the type of the capability. Currently, only edi is supported.
Returns the type of the capability. Currently, only edi is supported.
Returns the type of the capability. Currently, only edi is supported.
Returns the type of the capability. Currently, only edi is supported.
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.
", "refs": { } }, "CreateCapabilityRequest": { "base": null, "refs": { } }, "CreateCapabilityResponse": { "base": null, "refs": { } }, "CreatePartnershipRequest": { "base": null, "refs": { } }, "CreatePartnershipResponse": { "base": null, "refs": { } }, "CreateProfileRequest": { "base": null, "refs": { } }, "CreateProfileResponse": { "base": null, "refs": { } }, "CreateTransformerRequest": { "base": null, "refs": { } }, "CreateTransformerResponse": { "base": null, "refs": { } }, "CreatedDate": { "base": null, "refs": { "CapabilitySummary$createdAt": "Returns a timestamp for creation date and time of the capability.
", "CreateCapabilityResponse$createdAt": "Returns a timestamp for creation date and time of the capability.
", "CreatePartnershipResponse$createdAt": "Returns a timestamp for creation date and time of the partnership.
", "CreateProfileResponse$createdAt": "Returns a timestamp representing the time the profile was created.
", "CreateTransformerResponse$createdAt": "Returns a timestamp for creation date and time of the transformer.
", "GetCapabilityResponse$createdAt": "Returns a timestamp for creation date and time of the capability.
", "GetPartnershipResponse$createdAt": "Returns a timestamp for creation date and time of the partnership.
", "GetProfileResponse$createdAt": "Returns a timestamp for creation date and time of the transformer.
", "GetTransformerResponse$createdAt": "Returns a timestamp for creation date and time of the transformer.
", "PartnershipSummary$createdAt": "Returns a timestamp for creation date and time of the partnership.
", "ProfileSummary$createdAt": "Returns the timestamp for creation date and time of the profile.
", "TransformerSummary$createdAt": "Returns a timestamp indicating when the transformer was created. For example, 2023-07-20T19:58:44.624Z.
Returns a timestamp for creation date and time of the capability.
", "UpdatePartnershipResponse$createdAt": "Returns a timestamp that identifies the most recent date and time that the partnership was modified.
", "UpdateProfileResponse$createdAt": "Returns a timestamp for creation date and time of the profile.
", "UpdateTransformerResponse$createdAt": "Returns a timestamp for creation date and time of the transformer.
" } }, "DeleteCapabilityRequest": { "base": null, "refs": { } }, "DeletePartnershipRequest": { "base": null, "refs": { } }, "DeleteProfileRequest": { "base": null, "refs": { } }, "DeleteTransformerRequest": { "base": null, "refs": { } }, "EdiConfiguration": { "base": "Specifies the details for the EDI (electronic data interchange) transformation.
", "refs": { "CapabilityConfiguration$edi": "An EDI (electronic data interchange) configuration object.
" } }, "EdiType": { "base": "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.
", "refs": { "CreateTransformerRequest$ediType": "Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", "CreateTransformerResponse$ediType": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", "EdiConfiguration$type": "Returns the type of the capability. Currently, only edi is supported.
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.
", "TestParsingRequest$ediType": "Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", "TransformerSummary$ediType": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", "UpdateTransformerRequest$ediType": "Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", "UpdateTransformerResponse$ediType": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
" } }, "Email": { "base": null, "refs": { "CreatePartnershipRequest$email": "Specifies the email address associated with this trading partner.
", "CreatePartnershipResponse$email": "Returns the email address associated with this trading partner.
", "CreateProfileRequest$email": "Specifies the email address associated with this customer profile.
", "CreateProfileResponse$email": "Returns the email address associated with this customer profile.
", "GetPartnershipResponse$email": "Returns the email address associated with this trading partner.
", "GetProfileResponse$email": "Returns the email address associated with this customer profile.
", "UpdatePartnershipResponse$email": "Returns the email address associated with this trading partner.
", "UpdateProfileRequest$email": "Specifies the email address associated with this customer profile.
", "UpdateProfileResponse$email": "Returns the email address associated with this customer profile.
" } }, "ErrorMessage": { "base": null, "refs": { "AccessDeniedException$message": null, "ConflictException$message": null, "InternalServerException$message": null, "ResourceNotFoundException$message": null, "ServiceQuotaExceededException$message": null, "ThrottlingException$message": null, "ValidationException$Message": null } }, "FileFormat": { "base": null, "refs": { "CreateTransformerRequest$fileFormat": "Specifies that the currently supported file formats for EDI transformations are JSON and XML.
Returns that the currently supported file formats for EDI transformations are JSON and XML.
Returns that the currently supported file formats for EDI transformations are JSON and XML.
Specifies that the currently supported file formats for EDI transformations are JSON and XML.
Specifies that the currently supported file formats for EDI transformations are JSON and XML.
Returns that the currently supported file formats for EDI transformations are JSON and XML.
Specifies that the currently supported file formats for EDI transformations are JSON and XML.
Returns that the currently supported file formats for EDI transformations are JSON and XML.
Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
", "CreateTransformerResponse$sampleDocument": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
", "GetTransformerResponse$sampleDocument": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
", "TransformerSummary$sampleDocument": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
", "UpdateTransformerRequest$sampleDocument": "Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
", "UpdateTransformerResponse$sampleDocument": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
" } }, "GetCapabilityRequest": { "base": null, "refs": { } }, "GetCapabilityResponse": { "base": null, "refs": { } }, "GetPartnershipRequest": { "base": null, "refs": { } }, "GetPartnershipResponse": { "base": null, "refs": { } }, "GetProfileRequest": { "base": null, "refs": { } }, "GetProfileResponse": { "base": null, "refs": { } }, "GetTransformerJobRequest": { "base": null, "refs": { } }, "GetTransformerJobResponse": { "base": null, "refs": { } }, "GetTransformerRequest": { "base": null, "refs": { } }, "GetTransformerResponse": { "base": null, "refs": { } }, "InstructionsDocuments": { "base": null, "refs": { "CreateCapabilityRequest$instructionsDocuments": "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.
", "CreateCapabilityResponse$instructionsDocuments": "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.
", "GetCapabilityResponse$instructionsDocuments": "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.
", "UpdateCapabilityRequest$instructionsDocuments": "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.
", "UpdateCapabilityResponse$instructionsDocuments": "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.
" } }, "Integer": { "base": null, "refs": { "InternalServerException$retryAfterSeconds": "The server attempts to retry a failed command.
", "ThrottlingException$retryAfterSeconds": "The server attempts to retry a command that was throttled.
" } }, "InternalServerException": { "base": "This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
", "refs": { } }, "ListCapabilitiesRequest": { "base": null, "refs": { } }, "ListCapabilitiesResponse": { "base": null, "refs": { } }, "ListPartnershipsRequest": { "base": null, "refs": { } }, "ListPartnershipsResponse": { "base": null, "refs": { } }, "ListProfilesRequest": { "base": null, "refs": { } }, "ListProfilesResponse": { "base": null, "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "ListTransformersRequest": { "base": null, "refs": { } }, "ListTransformersResponse": { "base": null, "refs": { } }, "LogGroupName": { "base": null, "refs": { "CreateProfileResponse$logGroupName": "Returns the name of the logging group.
", "GetProfileResponse$logGroupName": "Returns the name of the logging group.
", "ProfileSummary$logGroupName": "Returns the name of the logging group.
", "UpdateProfileResponse$logGroupName": "Returns the name of the logging group.
" } }, "Logging": { "base": null, "refs": { "CreateProfileRequest$logging": "Specifies whether or not logging is enabled for this profile.
", "CreateProfileResponse$logging": "Returns whether or not logging is turned on for this profile.
", "GetProfileResponse$logging": "Returns whether or not logging is enabled for this profile.
", "ProfileSummary$logging": "Specifies whether or not logging is enabled for this profile.
", "UpdateProfileResponse$logging": "Specifies whether or not logging is enabled for this profile.
" } }, "MappingTemplate": { "base": null, "refs": { "CreateTransformerRequest$mappingTemplate": "Specifies the name of the mapping template for the transformer. This template is used to convert the input document into the correct set of objects.
", "CreateTransformerResponse$mappingTemplate": "Returns the name of the mapping template for the transformer. This template is used to convert the input document into the correct set of objects.
", "GetTransformerResponse$mappingTemplate": "Returns the name of the mapping template for the transformer. This template is used to convert the input document into the correct set of objects.
", "TestMappingRequest$mappingTemplate": "Specifies the name of the mapping template for the transformer. This template is used to convert the input document into the correct set of objects.
", "TransformerSummary$mappingTemplate": "Returns the name of the mapping template for the transformer. This template is used to convert the input document into the correct set of objects.
", "UpdateTransformerRequest$mappingTemplate": "Specifies the name of the mapping template for the transformer. This template is used to convert the input document into the correct set of objects.
", "UpdateTransformerResponse$mappingTemplate": "Returns the name of the mapping template for the transformer. This template is used to convert the input document into the correct set of objects.
" } }, "MaxResults": { "base": null, "refs": { "ListCapabilitiesRequest$maxResults": "Specifies the maximum number of capabilities to return.
", "ListPartnershipsRequest$maxResults": "Specifies the maximum number of capabilities to return.
", "ListProfilesRequest$maxResults": "Specifies the maximum number of profiles to return.
", "ListTransformersRequest$maxResults": "Specifies the number of items to return for the API response.
" } }, "ModifiedDate": { "base": null, "refs": { "CapabilitySummary$modifiedAt": "Returns a timestamp that identifies the most recent date and time that the capability was modified.
", "GetCapabilityResponse$modifiedAt": "Returns a timestamp for last time the capability was modified.
", "GetPartnershipResponse$modifiedAt": "Returns a timestamp that identifies the most recent date and time that the partnership was modified.
", "GetProfileResponse$modifiedAt": "Returns a timestamp for last time the profile was modified.
", "GetTransformerResponse$modifiedAt": "Returns a timestamp for last time the transformer was modified.
", "PartnershipSummary$modifiedAt": "Returns a timestamp that identifies the most recent date and time that the partnership was modified.
", "ProfileSummary$modifiedAt": "Returns the timestamp that identifies the most recent date and time that the profile was modified.
", "TransformerSummary$modifiedAt": "Returns a timestamp representing the date and time for the most recent change for the transformer object.
", "UpdateCapabilityResponse$modifiedAt": "Returns a timestamp for last time the capability was modified.
", "UpdatePartnershipResponse$modifiedAt": "Returns a timestamp that identifies the most recent date and time that the partnership was modified.
", "UpdateProfileResponse$modifiedAt": "Returns a timestamp for last time the profile was modified.
", "UpdateTransformerResponse$modifiedAt": "Returns a timestamp for last time the transformer was modified.
" } }, "PageToken": { "base": null, "refs": { "ListCapabilitiesRequest$nextToken": "When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.
When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.
When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.
When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.
When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.
When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.
When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.
When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.
Specifies a descriptive name for the partnership.
", "CreatePartnershipResponse$name": "Returns a descriptive name for the partnership.
", "GetPartnershipResponse$name": "Returns the display name of the partnership
", "PartnershipSummary$name": "Returns the name of the partnership.
", "UpdatePartnershipRequest$name": "The name of the partnership, used to identify it.
", "UpdatePartnershipResponse$name": "The name of the partnership, used to identify it.
" } }, "PartnershipCapabilities": { "base": null, "refs": { "CreatePartnershipRequest$capabilities": "Specifies a list of the capabilities associated with this partnership.
", "CreatePartnershipResponse$capabilities": "Returns one or more capabilities associated with this partnership.
", "GetPartnershipResponse$capabilities": "Returns one or more capabilities associated with this partnership.
", "PartnershipSummary$capabilities": "Returns one or more capabilities associated with this partnership.
", "UpdatePartnershipRequest$capabilities": "List of the capabilities associated with this partnership.
", "UpdatePartnershipResponse$capabilities": "Returns one or more capabilities associated with this partnership.
" } }, "PartnershipId": { "base": null, "refs": { "CreatePartnershipResponse$partnershipId": "Returns the unique, system-generated identifier for a partnership.
", "DeletePartnershipRequest$partnershipId": "Specifies the unique, system-generated identifier for a partnership.
", "GetPartnershipRequest$partnershipId": "Specifies the unique, system-generated identifier for a partnership.
", "GetPartnershipResponse$partnershipId": "Returns the unique, system-generated identifier for a partnership.
", "PartnershipSummary$partnershipId": "Returns the unique, system-generated identifier for a partnership.
", "UpdatePartnershipRequest$partnershipId": "Specifies the unique, system-generated identifier for a partnership.
", "UpdatePartnershipResponse$partnershipId": "Returns the unique, system-generated identifier for a partnership.
" } }, "PartnershipList": { "base": null, "refs": { "ListPartnershipsResponse$partnerships": "Specifies a list of your partnerships.
" } }, "PartnershipSummary": { "base": "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.
", "refs": { "PartnershipList$member": null } }, "Phone": { "base": null, "refs": { "CreatePartnershipRequest$phone": "Specifies the phone number associated with the partnership.
", "CreatePartnershipResponse$phone": "Returns the phone number associated with the partnership.
", "CreateProfileRequest$phone": "Specifies the phone number associated with the profile.
", "CreateProfileResponse$phone": "Returns the phone number associated with the profile.
", "GetPartnershipResponse$phone": "Returns the phone number associated with the partnership.
", "GetProfileResponse$phone": "Returns the phone number associated with the profile.
", "UpdatePartnershipResponse$phone": "Returns the phone number associated with the partnership.
", "UpdateProfileRequest$phone": "Specifies the phone number associated with the profile.
", "UpdateProfileResponse$phone": "Returns the phone number associated with the profile.
" } }, "ProfileId": { "base": null, "refs": { "CreatePartnershipRequest$profileId": "Specifies the unique, system-generated identifier for the profile connected to this partnership.
", "CreatePartnershipResponse$profileId": "Returns the unique, system-generated identifier for the profile connected to this partnership.
", "CreateProfileResponse$profileId": "Returns the unique, system-generated identifier for the profile.
", "DeleteProfileRequest$profileId": "Specifies the unique, system-generated identifier for the profile.
", "GetPartnershipResponse$profileId": "Returns the unique, system-generated identifier for the profile connected to this partnership.
", "GetProfileRequest$profileId": "Specifies the unique, system-generated identifier for the profile.
", "GetProfileResponse$profileId": "Returns the unique, system-generated identifier for the profile.
", "ListPartnershipsRequest$profileId": "Specifies the unique, system-generated identifier for the profile connected to this partnership.
", "PartnershipSummary$profileId": "Returns the unique, system-generated identifier for the profile connected to this partnership.
", "ProfileSummary$profileId": "Returns the unique, system-generated identifier for the profile.
", "UpdatePartnershipResponse$profileId": "Returns the unique, system-generated identifier for the profile connected to this partnership.
", "UpdateProfileRequest$profileId": "Specifies the unique, system-generated identifier for the profile.
", "UpdateProfileResponse$profileId": "Returns the unique, system-generated identifier for the profile.
" } }, "ProfileList": { "base": null, "refs": { "ListProfilesResponse$profiles": "Returns an array of ProfileSummary objects.
Specifies the name of the profile.
", "CreateProfileResponse$name": "Returns the name of the profile, used to identify it.
", "GetProfileResponse$name": "Returns the name of the profile, used to identify it.
", "ProfileSummary$name": "Returns the display name for profile.
", "UpdateProfileRequest$name": "The name of the profile, used to identify it.
", "UpdateProfileResponse$name": "Returns the name of the profile.
" } }, "ProfileSummary": { "base": "Contains the details for a profile. A profile is the mechanism used to create the concept of a private network.
", "refs": { "ProfileList$member": null } }, "ResourceArn": { "base": null, "refs": { "CreateCapabilityResponse$capabilityArn": "Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
", "CreatePartnershipResponse$partnershipArn": "Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
", "CreateProfileResponse$profileArn": "Returns an Amazon Resource Name (ARN) for the profile.
", "CreateTransformerResponse$transformerArn": "Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
", "GetCapabilityResponse$capabilityArn": "Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
", "GetPartnershipResponse$partnershipArn": "Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
", "GetProfileResponse$profileArn": "Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
", "GetTransformerResponse$transformerArn": "Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
", "UpdateCapabilityResponse$capabilityArn": "Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
", "UpdatePartnershipResponse$partnershipArn": "Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
", "UpdateProfileResponse$profileArn": "Returns an Amazon Resource Name (ARN) for the profile.
", "UpdateTransformerResponse$transformerArn": "Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
" } }, "ResourceNotFoundException": { "base": "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.
", "refs": { } }, "S3Key": { "base": null, "refs": { "S3Location$key": "Specifies the Amazon S3 key for the file location.
" } }, "S3Location": { "base": "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.
", "refs": { "EdiConfiguration$inputLocation": "Contains the Amazon S3 bucket and prefix for the location of the input file, which is contained in an S3Location object.
Contains the Amazon S3 bucket and prefix for the location of the output file, which is contained in an S3Location object.
Specifies the location of the input file for the transformation. The location consists of an Amazon S3 bucket and prefix.
", "StartTransformerJobRequest$outputLocation": "Specifies the location of the output file for the transformation. The location consists of an Amazon S3 bucket and prefix.
", "TestParsingRequest$inputFile": "Specifies an S3Location object, which contains the Amazon S3 bucket and prefix for the location of the input file.
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.
" } }, "ServiceQuotaExceededException": { "base": "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.
", "refs": { } }, "StartTransformerJobRequest": { "base": null, "refs": { } }, "StartTransformerJobResponse": { "base": null, "refs": { } }, "String": { "base": null, "refs": { "CreateCapabilityRequest$clientToken": "Reserved for future use.
", "CreatePartnershipRequest$clientToken": "Reserved for future use.
", "CreateProfileRequest$clientToken": "Reserved for future use.
", "CreateTransformerRequest$clientToken": "Reserved for future use.
", "GetTransformerJobResponse$message": "Returns an optional error message, which gets populated when the job is not run successfully.
", "ServiceQuotaExceededException$resourceId": "The ID for the resource that exceeded the quota, which caused the exception.
", "ServiceQuotaExceededException$resourceType": "The resource type (profile, partnership, transformer, or capability) that exceeded the quota, which caused the exception.
", "ServiceQuotaExceededException$serviceCode": "The code responsible for exceeding the quota, which caused the exception.
", "ServiceQuotaExceededException$quotaCode": "The quota that was exceeded, which caused the exception.
", "StartTransformerJobRequest$clientToken": "Reserved for future use.
", "TestMappingResponse$mappedFileContent": "Returns a string for the mapping that can be used to identify the mapping. Similar to a fingerprint
", "TestParsingResponse$parsedFileContent": "Returns the contents of the input file being tested, parsed according to the specified EDI (electronic data interchange) type.
" } }, "Tag": { "base": "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.
Specifies the name assigned to the tag that you create.
", "TagKeyList$member": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$TagKeys": "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.
" } }, "TagList": { "base": null, "refs": { "CreateCapabilityRequest$tags": "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.
", "CreatePartnershipRequest$tags": "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.
", "CreateProfileRequest$tags": "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.
", "CreateTransformerRequest$tags": "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.
", "ListTagsForResourceResponse$Tags": "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.
", "TagResourceRequest$Tags": "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.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "Tag$Value": "Contains one or more values that you assigned to the key name that you create.
" } }, "TestMappingInputFileContent": { "base": null, "refs": { "TestMappingRequest$inputFileContent": "Specify the contents of the EDI (electronic data interchange) XML or JSON file that is used as input for the transform.
" } }, "TestMappingRequest": { "base": null, "refs": { } }, "TestMappingResponse": { "base": null, "refs": { } }, "TestParsingRequest": { "base": null, "refs": { } }, "TestParsingResponse": { "base": null, "refs": { } }, "ThrottlingException": { "base": "The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
", "refs": { } }, "TradingPartnerId": { "base": null, "refs": { "CreatePartnershipResponse$tradingPartnerId": "Returns the unique, system-generated identifier for a trading partner.
", "GetPartnershipResponse$tradingPartnerId": "Returns the unique identifier for the partner for this partnership.
", "PartnershipSummary$tradingPartnerId": "Returns the unique, system-generated identifier for a trading partner.
", "UpdatePartnershipResponse$tradingPartnerId": "Returns the unique, system-generated identifier for a trading partner.
" } }, "TransformerId": { "base": null, "refs": { "CreateTransformerResponse$transformerId": "Returns the system-assigned unique identifier for the transformer.
", "DeleteTransformerRequest$transformerId": "Specifies the system-assigned unique identifier for the transformer.
", "EdiConfiguration$transformerId": "Returns the system-assigned unique identifier for the transformer.
", "GetTransformerJobRequest$transformerId": "Specifies the system-assigned unique identifier for the transformer.
", "GetTransformerRequest$transformerId": "Specifies the system-assigned unique identifier for the transformer.
", "GetTransformerResponse$transformerId": "Returns the system-assigned unique identifier for the transformer.
", "StartTransformerJobRequest$transformerId": "Specifies the system-assigned unique identifier for the transformer.
", "TransformerSummary$transformerId": "Returns the system-assigned unique identifier for the transformer.
", "UpdateTransformerRequest$transformerId": "Specifies the system-assigned unique identifier for the transformer.
", "UpdateTransformerResponse$transformerId": "Returns the system-assigned unique identifier for the transformer.
" } }, "TransformerJobId": { "base": null, "refs": { "GetTransformerJobRequest$transformerJobId": "Specifies the unique, system-generated identifier for a transformer run.
", "StartTransformerJobResponse$transformerJobId": "Returns the unique, system-generated identifier for a transformer run.
" } }, "TransformerJobStatus": { "base": null, "refs": { "GetTransformerJobResponse$status": "Returns the current state of the transformer job, either running, succeeded, or failed.
Returns an array of one or more transformer objects.
For each transformer, a TransformerSummary object is returned. The TransformerSummary contains all the details for a specific transformer.
Specifies the name of the transformer, used to identify it.
", "CreateTransformerResponse$name": "Returns the name of the transformer, used to identify it.
", "GetTransformerResponse$name": "Returns the name of the transformer, used to identify it.
", "TransformerSummary$name": "Returns the descriptive name for the transformer.
", "UpdateTransformerRequest$name": "Specify a new name for the transformer, if you want to update it.
", "UpdateTransformerResponse$name": "Returns the name of the transformer.
" } }, "TransformerStatus": { "base": null, "refs": { "CreateTransformerResponse$status": "Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.
Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.
Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.
Specifies the transformer's status. You can update the state of the transformer, from active to inactive, or inactive to active.
Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.
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.
", "refs": { "TransformerList$member": null } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UpdateCapabilityRequest": { "base": null, "refs": { } }, "UpdateCapabilityResponse": { "base": null, "refs": { } }, "UpdatePartnershipRequest": { "base": null, "refs": { } }, "UpdatePartnershipResponse": { "base": null, "refs": { } }, "UpdateProfileRequest": { "base": null, "refs": { } }, "UpdateProfileResponse": { "base": null, "refs": { } }, "UpdateTransformerRequest": { "base": null, "refs": { } }, "UpdateTransformerResponse": { "base": null, "refs": { } }, "ValidationException": { "base": "Occurs when a B2BI object cannot be validated against a request from another object.
", "refs": { } }, "X12Details": { "base": "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.
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.
" } }, "X12TransactionSet": { "base": null, "refs": { "X12Details$transactionSet": "Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
" } }, "X12Version": { "base": null, "refs": { "X12Details$version": "Returns the version to use for the specified X12 transaction set. Supported versions are 4010, 4030, and 5010.