{ "version":"2.0", "metadata":{ "apiVersion":"2022-06-23", "endpointPrefix":"b2bi", "jsonVersion":"1.0", "protocol":"json", "serviceAbbreviation":"AWS B2BI", "serviceFullName":"AWS B2B Data Interchange", "serviceId":"b2bi", "signatureVersion":"v4", "signingName":"b2bi", "targetPrefix":"B2BI", "uid":"b2bi-2022-06-23" }, "operations":{ "CreateCapability":{ "name":"CreateCapability", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCapabilityRequest"}, "output":{"shape":"CreateCapabilityResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"} ], "documentation":"

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.

", "idempotent":true }, "CreatePartnership":{ "name":"CreatePartnership", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePartnershipRequest"}, "output":{"shape":"CreatePartnershipResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"} ], "documentation":"

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.

", "idempotent":true }, "CreateProfile":{ "name":"CreateProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateProfileRequest"}, "output":{"shape":"CreateProfileResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"} ], "documentation":"

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.

", "idempotent":true }, "CreateTransformer":{ "name":"CreateTransformer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTransformerRequest"}, "output":{"shape":"CreateTransformerResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"} ], "documentation":"

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

", "idempotent":true }, "DeleteCapability":{ "name":"DeleteCapability", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCapabilityRequest"}, "errors":[ {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

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

", "idempotent":true }, "DeletePartnership":{ "name":"DeletePartnership", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePartnershipRequest"}, "errors":[ {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

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.

", "idempotent":true }, "DeleteProfile":{ "name":"DeleteProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteProfileRequest"}, "errors":[ {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

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

", "idempotent":true }, "DeleteTransformer":{ "name":"DeleteTransformer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTransformerRequest"}, "errors":[ {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

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

", "idempotent":true }, "GetCapability":{ "name":"GetCapability", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetCapabilityRequest"}, "output":{"shape":"GetCapabilityResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

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":{ "name":"GetPartnership", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPartnershipRequest"}, "output":{"shape":"GetPartnershipResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

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":{ "name":"GetProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetProfileRequest"}, "output":{"shape":"GetProfileResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

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":{ "name":"GetTransformer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetTransformerRequest"}, "output":{"shape":"GetTransformerResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

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":{ "name":"GetTransformerJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetTransformerJobRequest"}, "output":{"shape":"GetTransformerJobResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

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

" }, "ListCapabilities":{ "name":"ListCapabilities", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListCapabilitiesRequest"}, "output":{"shape":"ListCapabilitiesResponse"}, "documentation":"

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":{ "name":"ListPartnerships", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPartnershipsRequest"}, "output":{"shape":"ListPartnershipsResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

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":{ "name":"ListProfiles", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListProfilesRequest"}, "output":{"shape":"ListProfilesResponse"}, "documentation":"

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":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

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":{ "name":"ListTransformers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTransformersRequest"}, "output":{"shape":"ListTransformersResponse"}, "documentation":"

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

" }, "StartTransformerJob":{ "name":"StartTransformerJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartTransformerJobRequest"}, "output":{"shape":"StartTransformerJobResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

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.

", "idempotent":true }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

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":{ "name":"TestMapping", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TestMappingRequest"}, "output":{"shape":"TestMappingResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

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.

", "idempotent":true }, "TestParsing":{ "name":"TestParsing", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TestParsingRequest"}, "output":{"shape":"TestParsingResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

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

", "idempotent":true }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

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.

", "idempotent":true }, "UpdateCapability":{ "name":"UpdateCapability", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateCapabilityRequest"}, "output":{"shape":"UpdateCapabilityResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"} ], "documentation":"

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.

", "idempotent":true }, "UpdatePartnership":{ "name":"UpdatePartnership", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdatePartnershipRequest"}, "output":{"shape":"UpdatePartnershipResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"} ], "documentation":"

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.

", "idempotent":true }, "UpdateProfile":{ "name":"UpdateProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateProfileRequest"}, "output":{"shape":"UpdateProfileResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"} ], "documentation":"

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

", "idempotent":true }, "UpdateTransformer":{ "name":"UpdateTransformer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateTransformerRequest"}, "output":{"shape":"UpdateTransformerResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"} ], "documentation":"

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.

", "idempotent":true } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

You do not have sufficient access to perform this action.

", "exception":true }, "AmazonResourceName":{ "type":"string", "max":1011, "min":1 }, "BucketName":{ "type":"string", "max":63, "min":3 }, "BusinessName":{ "type":"string", "max":254, "min":1 }, "CapabilityConfiguration":{ "type":"structure", "members":{ "edi":{ "shape":"EdiConfiguration", "documentation":"

An EDI (electronic data interchange) configuration object.

" } }, "documentation":"

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.

", "union":true }, "CapabilityId":{ "type":"string", "max":64, "min":1, "pattern":"[a-zA-Z0-9_-]+" }, "CapabilityList":{ "type":"list", "member":{"shape":"CapabilitySummary"} }, "CapabilityName":{ "type":"string", "max":254, "min":1 }, "CapabilitySummary":{ "type":"structure", "required":[ "capabilityId", "name", "type", "createdAt" ], "members":{ "capabilityId":{ "shape":"CapabilityId", "documentation":"

Returns a system-assigned unique identifier for the capability.

" }, "name":{ "shape":"CapabilityName", "documentation":"

The display name of the capability.

" }, "type":{ "shape":"CapabilityType", "documentation":"

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

" }, "createdAt":{ "shape":"CreatedDate", "documentation":"

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

" }, "modifiedAt":{ "shape":"ModifiedDate", "documentation":"

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

" } }, "documentation":"

Returns the capability summary details. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

" }, "CapabilityType":{ "type":"string", "enum":["edi"] }, "ConflictException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

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.

", "exception":true }, "CreateCapabilityRequest":{ "type":"structure", "required":[ "name", "type", "configuration" ], "members":{ "name":{ "shape":"CapabilityName", "documentation":"

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

" }, "type":{ "shape":"CapabilityType", "documentation":"

Specifies the type of the capability. Currently, only `edi` is supported.

" }, "configuration":{ "shape":"CapabilityConfiguration", "documentation":"

Specifies a structure that contains the details for a capability.

" }, "instructionsDocuments":{ "shape":"InstructionsDocuments", "documentation":"

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.

" }, "clientToken":{ "shape":"String", "documentation":"

Reserved for future use.

", "idempotencyToken":true }, "tags":{ "shape":"TagList", "documentation":"

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.

" } } }, "CreateCapabilityResponse":{ "type":"structure", "required":[ "capabilityId", "capabilityArn", "name", "type", "configuration", "createdAt" ], "members":{ "capabilityId":{ "shape":"CapabilityId", "documentation":"

Returns a system-assigned unique identifier for the capability.

" }, "capabilityArn":{ "shape":"ResourceArn", "documentation":"

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

" }, "name":{ "shape":"CapabilityName", "documentation":"

Returns the name of the capability used to identify it.

" }, "type":{ "shape":"CapabilityType", "documentation":"

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

" }, "configuration":{ "shape":"CapabilityConfiguration", "documentation":"

Returns a structure that contains the details for a capability.

" }, "instructionsDocuments":{ "shape":"InstructionsDocuments", "documentation":"

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.

" }, "createdAt":{ "shape":"CreatedDate", "documentation":"

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

" } } }, "CreatePartnershipRequest":{ "type":"structure", "required":[ "profileId", "name", "email" ], "members":{ "profileId":{ "shape":"ProfileId", "documentation":"

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

" }, "name":{ "shape":"PartnerName", "documentation":"

Specifies a descriptive name for the partnership.

" }, "email":{ "shape":"Email", "documentation":"

Specifies the email address associated with this trading partner.

" }, "phone":{ "shape":"Phone", "documentation":"

Specifies the phone number associated with the partnership.

" }, "capabilities":{ "shape":"PartnershipCapabilities", "documentation":"

Specifies a list of the capabilities associated with this partnership.

" }, "clientToken":{ "shape":"String", "documentation":"

Reserved for future use.

", "idempotencyToken":true }, "tags":{ "shape":"TagList", "documentation":"

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.

" } } }, "CreatePartnershipResponse":{ "type":"structure", "required":[ "profileId", "partnershipId", "partnershipArn", "createdAt" ], "members":{ "profileId":{ "shape":"ProfileId", "documentation":"

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

" }, "partnershipId":{ "shape":"PartnershipId", "documentation":"

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

" }, "partnershipArn":{ "shape":"ResourceArn", "documentation":"

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

" }, "name":{ "shape":"PartnerName", "documentation":"

Returns a descriptive name for the partnership.

" }, "email":{ "shape":"Email", "documentation":"

Returns the email address associated with this trading partner.

" }, "phone":{ "shape":"Phone", "documentation":"

Returns the phone number associated with the partnership.

" }, "capabilities":{ "shape":"PartnershipCapabilities", "documentation":"

Returns one or more capabilities associated with this partnership.

" }, "tradingPartnerId":{ "shape":"TradingPartnerId", "documentation":"

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

" }, "createdAt":{ "shape":"CreatedDate", "documentation":"

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

" } } }, "CreateProfileRequest":{ "type":"structure", "required":[ "name", "phone", "businessName", "logging" ], "members":{ "name":{ "shape":"ProfileName", "documentation":"

Specifies the name of the profile.

" }, "email":{ "shape":"Email", "documentation":"

Specifies the email address associated with this customer profile.

" }, "phone":{ "shape":"Phone", "documentation":"

Specifies the phone number associated with the profile.

" }, "businessName":{ "shape":"BusinessName", "documentation":"

Specifies the name for the business associated with this profile.

" }, "logging":{ "shape":"Logging", "documentation":"

Specifies whether or not logging is enabled for this profile.

" }, "clientToken":{ "shape":"String", "documentation":"

Reserved for future use.

", "idempotencyToken":true }, "tags":{ "shape":"TagList", "documentation":"

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.

" } } }, "CreateProfileResponse":{ "type":"structure", "required":[ "profileId", "profileArn", "name", "businessName", "phone", "createdAt" ], "members":{ "profileId":{ "shape":"ProfileId", "documentation":"

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

" }, "profileArn":{ "shape":"ResourceArn", "documentation":"

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

" }, "name":{ "shape":"ProfileName", "documentation":"

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

" }, "businessName":{ "shape":"BusinessName", "documentation":"

Returns the name for the business associated with this profile.

" }, "phone":{ "shape":"Phone", "documentation":"

Returns the phone number associated with the profile.

" }, "email":{ "shape":"Email", "documentation":"

Returns the email address associated with this customer profile.

" }, "logging":{ "shape":"Logging", "documentation":"

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

" }, "logGroupName":{ "shape":"LogGroupName", "documentation":"

Returns the name of the logging group.

" }, "createdAt":{ "shape":"CreatedDate", "documentation":"

Returns a timestamp representing the time the profile was created.

" } } }, "CreateTransformerRequest":{ "type":"structure", "required":[ "name", "fileFormat", "mappingTemplate", "ediType" ], "members":{ "name":{ "shape":"TransformerName", "documentation":"

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

" }, "fileFormat":{ "shape":"FileFormat", "documentation":"

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

" }, "mappingTemplate":{ "shape":"MappingTemplate", "documentation":"

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.

" }, "ediType":{ "shape":"EdiType", "documentation":"

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.

" }, "sampleDocument":{ "shape":"FileLocation", "documentation":"

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

" }, "clientToken":{ "shape":"String", "documentation":"

Reserved for future use.

", "idempotencyToken":true }, "tags":{ "shape":"TagList", "documentation":"

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.

" } } }, "CreateTransformerResponse":{ "type":"structure", "required":[ "transformerId", "transformerArn", "name", "fileFormat", "mappingTemplate", "status", "ediType", "createdAt" ], "members":{ "transformerId":{ "shape":"TransformerId", "documentation":"

Returns the system-assigned unique identifier for the transformer.

" }, "transformerArn":{ "shape":"ResourceArn", "documentation":"

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

" }, "name":{ "shape":"TransformerName", "documentation":"

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

" }, "fileFormat":{ "shape":"FileFormat", "documentation":"

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

" }, "mappingTemplate":{ "shape":"MappingTemplate", "documentation":"

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.

" }, "status":{ "shape":"TransformerStatus", "documentation":"

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

" }, "ediType":{ "shape":"EdiType", "documentation":"

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.

" }, "sampleDocument":{ "shape":"FileLocation", "documentation":"

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

" }, "createdAt":{ "shape":"CreatedDate", "documentation":"

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

" } } }, "CreatedDate":{ "type":"timestamp", "timestampFormat":"iso8601" }, "DeleteCapabilityRequest":{ "type":"structure", "required":["capabilityId"], "members":{ "capabilityId":{ "shape":"CapabilityId", "documentation":"

Specifies a system-assigned unique identifier for the capability.

" } } }, "DeletePartnershipRequest":{ "type":"structure", "required":["partnershipId"], "members":{ "partnershipId":{ "shape":"PartnershipId", "documentation":"

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

" } } }, "DeleteProfileRequest":{ "type":"structure", "required":["profileId"], "members":{ "profileId":{ "shape":"ProfileId", "documentation":"

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

" } } }, "DeleteTransformerRequest":{ "type":"structure", "required":["transformerId"], "members":{ "transformerId":{ "shape":"TransformerId", "documentation":"

Specifies the system-assigned unique identifier for the transformer.

" } } }, "EdiConfiguration":{ "type":"structure", "required":[ "type", "inputLocation", "outputLocation", "transformerId" ], "members":{ "type":{ "shape":"EdiType", "documentation":"

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

" }, "inputLocation":{ "shape":"S3Location", "documentation":"

Contains the Amazon S3 bucket and prefix for the location of the input file, which is contained in an `S3Location` object.

" }, "outputLocation":{ "shape":"S3Location", "documentation":"

Contains the Amazon S3 bucket and prefix for the location of the output file, which is contained in an `S3Location` object.

" }, "transformerId":{ "shape":"TransformerId", "documentation":"

Returns the system-assigned unique identifier for the transformer.

" } }, "documentation":"

Specifies the details for the EDI (electronic data interchange) transformation.

" }, "EdiType":{ "type":"structure", "members":{ "x12Details":{ "shape":"X12Details", "documentation":"

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.

" } }, "documentation":"

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.

", "union":true }, "Email":{ "type":"string", "max":254, "min":5, "pattern":"[\\w\\.\\-]+@[\\w\\.\\-]+", "sensitive":true }, "ErrorMessage":{ "type":"string", "max":1024, "min":10 }, "FileFormat":{ "type":"string", "enum":[ "XML", "JSON" ] }, "FileLocation":{ "type":"string", "max":1024, "min":0 }, "GetCapabilityRequest":{ "type":"structure", "required":["capabilityId"], "members":{ "capabilityId":{ "shape":"CapabilityId", "documentation":"

Specifies a system-assigned unique identifier for the capability.

" } } }, "GetCapabilityResponse":{ "type":"structure", "required":[ "capabilityId", "capabilityArn", "name", "type", "configuration", "createdAt" ], "members":{ "capabilityId":{ "shape":"CapabilityId", "documentation":"

Returns a system-assigned unique identifier for the capability.

" }, "capabilityArn":{ "shape":"ResourceArn", "documentation":"

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

" }, "name":{ "shape":"CapabilityName", "documentation":"

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

" }, "type":{ "shape":"CapabilityType", "documentation":"

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

" }, "configuration":{ "shape":"CapabilityConfiguration", "documentation":"

Returns a structure that contains the details for a capability.

" }, "instructionsDocuments":{ "shape":"InstructionsDocuments", "documentation":"

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.

" }, "createdAt":{ "shape":"CreatedDate", "documentation":"

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

" }, "modifiedAt":{ "shape":"ModifiedDate", "documentation":"

Returns a timestamp for last time the capability was modified.

" } } }, "GetPartnershipRequest":{ "type":"structure", "required":["partnershipId"], "members":{ "partnershipId":{ "shape":"PartnershipId", "documentation":"

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

" } } }, "GetPartnershipResponse":{ "type":"structure", "required":[ "profileId", "partnershipId", "partnershipArn", "createdAt" ], "members":{ "profileId":{ "shape":"ProfileId", "documentation":"

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

" }, "partnershipId":{ "shape":"PartnershipId", "documentation":"

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

" }, "partnershipArn":{ "shape":"ResourceArn", "documentation":"

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

" }, "name":{ "shape":"PartnerName", "documentation":"

Returns the display name of the partnership

" }, "email":{ "shape":"Email", "documentation":"

Returns the email address associated with this trading partner.

" }, "phone":{ "shape":"Phone", "documentation":"

Returns the phone number associated with the partnership.

" }, "capabilities":{ "shape":"PartnershipCapabilities", "documentation":"

Returns one or more capabilities associated with this partnership.

" }, "tradingPartnerId":{ "shape":"TradingPartnerId", "documentation":"

Returns the unique identifier for the partner for this partnership.

" }, "createdAt":{ "shape":"CreatedDate", "documentation":"

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

" }, "modifiedAt":{ "shape":"ModifiedDate", "documentation":"

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

" } } }, "GetProfileRequest":{ "type":"structure", "required":["profileId"], "members":{ "profileId":{ "shape":"ProfileId", "documentation":"

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

" } } }, "GetProfileResponse":{ "type":"structure", "required":[ "profileId", "profileArn", "name", "phone", "businessName", "createdAt" ], "members":{ "profileId":{ "shape":"ProfileId", "documentation":"

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

" }, "profileArn":{ "shape":"ResourceArn", "documentation":"

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

" }, "name":{ "shape":"ProfileName", "documentation":"

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

" }, "email":{ "shape":"Email", "documentation":"

Returns the email address associated with this customer profile.

" }, "phone":{ "shape":"Phone", "documentation":"

Returns the phone number associated with the profile.

" }, "businessName":{ "shape":"BusinessName", "documentation":"

Returns the name for the business associated with this profile.

" }, "logging":{ "shape":"Logging", "documentation":"

Returns whether or not logging is enabled for this profile.

" }, "logGroupName":{ "shape":"LogGroupName", "documentation":"

Returns the name of the logging group.

" }, "createdAt":{ "shape":"CreatedDate", "documentation":"

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

" }, "modifiedAt":{ "shape":"ModifiedDate", "documentation":"

Returns a timestamp for last time the profile was modified.

" } } }, "GetTransformerJobRequest":{ "type":"structure", "required":[ "transformerJobId", "transformerId" ], "members":{ "transformerJobId":{ "shape":"TransformerJobId", "documentation":"

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

" }, "transformerId":{ "shape":"TransformerId", "documentation":"

Specifies the system-assigned unique identifier for the transformer.

" } } }, "GetTransformerJobResponse":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"TransformerJobStatus", "documentation":"

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

" }, "outputFiles":{ "shape":"S3LocationList", "documentation":"

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.

" }, "message":{ "shape":"String", "documentation":"

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

" } } }, "GetTransformerRequest":{ "type":"structure", "required":["transformerId"], "members":{ "transformerId":{ "shape":"TransformerId", "documentation":"

Specifies the system-assigned unique identifier for the transformer.

" } } }, "GetTransformerResponse":{ "type":"structure", "required":[ "transformerId", "transformerArn", "name", "fileFormat", "mappingTemplate", "status", "ediType", "createdAt" ], "members":{ "transformerId":{ "shape":"TransformerId", "documentation":"

Returns the system-assigned unique identifier for the transformer.

" }, "transformerArn":{ "shape":"ResourceArn", "documentation":"

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

" }, "name":{ "shape":"TransformerName", "documentation":"

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

" }, "fileFormat":{ "shape":"FileFormat", "documentation":"

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

" }, "mappingTemplate":{ "shape":"MappingTemplate", "documentation":"

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.

" }, "status":{ "shape":"TransformerStatus", "documentation":"

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

" }, "ediType":{ "shape":"EdiType", "documentation":"

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.

" }, "sampleDocument":{ "shape":"FileLocation", "documentation":"

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

" }, "createdAt":{ "shape":"CreatedDate", "documentation":"

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

" }, "modifiedAt":{ "shape":"ModifiedDate", "documentation":"

Returns a timestamp for last time the transformer was modified.

" } } }, "InstructionsDocuments":{ "type":"list", "member":{"shape":"S3Location"}, "max":5, "min":0 }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"ErrorMessage"}, "retryAfterSeconds":{ "shape":"Integer", "documentation":"

The server attempts to retry a failed command.

" } }, "documentation":"

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

", "exception":true, "fault":true, "retryable":{"throttling":false} }, "ListCapabilitiesRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"PageToken", "documentation":"

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.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Specifies the maximum number of capabilities to return.

" } } }, "ListCapabilitiesResponse":{ "type":"structure", "required":["capabilities"], "members":{ "capabilities":{ "shape":"CapabilityList", "documentation":"

Returns one or more capabilities associated with this partnership.

" }, "nextToken":{ "shape":"PageToken", "documentation":"

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.

" } } }, "ListPartnershipsRequest":{ "type":"structure", "members":{ "profileId":{ "shape":"ProfileId", "documentation":"

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

" }, "nextToken":{ "shape":"PageToken", "documentation":"

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.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Specifies the maximum number of capabilities to return.

" } } }, "ListPartnershipsResponse":{ "type":"structure", "required":["partnerships"], "members":{ "partnerships":{ "shape":"PartnershipList", "documentation":"

Specifies a list of your partnerships.

" }, "nextToken":{ "shape":"PageToken", "documentation":"

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.

" } } }, "ListProfilesRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"PageToken", "documentation":"

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.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Specifies the maximum number of profiles to return.

" } } }, "ListProfilesResponse":{ "type":"structure", "required":["profiles"], "members":{ "profiles":{ "shape":"ProfileList", "documentation":"

Returns an array of `ProfileSummary` objects.

" }, "nextToken":{ "shape":"PageToken", "documentation":"

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.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceARN"], "members":{ "ResourceARN":{ "shape":"AmazonResourceName", "documentation":"

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.

" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"TagList", "documentation":"

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.

" } } }, "ListTransformersRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"PageToken", "documentation":"

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.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

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

" } } }, "ListTransformersResponse":{ "type":"structure", "required":["transformers"], "members":{ "transformers":{ "shape":"TransformerList", "documentation":"

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.

" }, "nextToken":{ "shape":"PageToken", "documentation":"

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.

" } } }, "LogGroupName":{ "type":"string", "max":512, "min":1 }, "Logging":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "MappingTemplate":{ "type":"string", "max":350000, "min":0 }, "MaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "ModifiedDate":{ "type":"timestamp", "timestampFormat":"iso8601" }, "PageToken":{ "type":"string", "max":2048, "min":1 }, "PartnerName":{ "type":"string", "max":254, "min":1 }, "PartnershipCapabilities":{ "type":"list", "member":{"shape":"CapabilityId"} }, "PartnershipId":{ "type":"string", "max":64, "min":1, "pattern":"[a-zA-Z0-9_-]+" }, "PartnershipList":{ "type":"list", "member":{"shape":"PartnershipSummary"} }, "PartnershipSummary":{ "type":"structure", "required":[ "profileId", "partnershipId", "createdAt" ], "members":{ "profileId":{ "shape":"ProfileId", "documentation":"

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

" }, "partnershipId":{ "shape":"PartnershipId", "documentation":"

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

" }, "name":{ "shape":"PartnerName", "documentation":"

Returns the name of the partnership.

" }, "capabilities":{ "shape":"PartnershipCapabilities", "documentation":"

Returns one or more capabilities associated with this partnership.

" }, "tradingPartnerId":{ "shape":"TradingPartnerId", "documentation":"

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

" }, "createdAt":{ "shape":"CreatedDate", "documentation":"

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

" }, "modifiedAt":{ "shape":"ModifiedDate", "documentation":"

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

" } }, "documentation":"

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.

" }, "Phone":{ "type":"string", "max":22, "min":7, "pattern":"\\+?([0-9 \\t\\-()\\/]{7,})(?:\\s*(?:#|x\\.?|ext\\.?|extension) \\t*(\\d+))?", "sensitive":true }, "ProfileId":{ "type":"string", "max":64, "min":1, "pattern":"[a-zA-Z0-9_-]+" }, "ProfileList":{ "type":"list", "member":{"shape":"ProfileSummary"} }, "ProfileName":{ "type":"string", "max":254, "min":1 }, "ProfileSummary":{ "type":"structure", "required":[ "profileId", "name", "businessName", "createdAt" ], "members":{ "profileId":{ "shape":"ProfileId", "documentation":"

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

" }, "name":{ "shape":"ProfileName", "documentation":"

Returns the display name for profile.

" }, "businessName":{ "shape":"BusinessName", "documentation":"

Returns the name for the business associated with this profile.

" }, "logging":{ "shape":"Logging", "documentation":"

Specifies whether or not logging is enabled for this profile.

" }, "logGroupName":{ "shape":"LogGroupName", "documentation":"

Returns the name of the logging group.

" }, "createdAt":{ "shape":"CreatedDate", "documentation":"

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

" }, "modifiedAt":{ "shape":"ModifiedDate", "documentation":"

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

" } }, "documentation":"

Contains the details for a profile. A profile is the mechanism used to create the concept of a private network.

" }, "ResourceArn":{ "type":"string", "max":255, "min":1 }, "ResourceNotFoundException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

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.

", "exception":true }, "S3Key":{ "type":"string", "max":1024, "min":0 }, "S3Location":{ "type":"structure", "members":{ "bucketName":{ "shape":"BucketName", "documentation":"

Specifies the name of the Amazon S3 bucket.

" }, "key":{ "shape":"S3Key", "documentation":"

Specifies the Amazon S3 key for the file location.

" } }, "documentation":"

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.

" }, "S3LocationList":{ "type":"list", "member":{"shape":"S3Location"} }, "ServiceQuotaExceededException":{ "type":"structure", "required":[ "message", "resourceId", "resourceType", "serviceCode", "quotaCode" ], "members":{ "message":{"shape":"ErrorMessage"}, "resourceId":{ "shape":"String", "documentation":"

The ID for the resource that exceeded the quota, which caused the exception.

" }, "resourceType":{ "shape":"String", "documentation":"

The resource type (profile, partnership, transformer, or capability) that exceeded the quota, which caused the exception.

" }, "serviceCode":{ "shape":"String", "documentation":"

The code responsible for exceeding the quota, which caused the exception.

" }, "quotaCode":{ "shape":"String", "documentation":"

The quota that was exceeded, which caused the exception.

" } }, "documentation":"

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.

", "exception":true }, "StartTransformerJobRequest":{ "type":"structure", "required":[ "inputFile", "outputLocation", "transformerId" ], "members":{ "inputFile":{ "shape":"S3Location", "documentation":"

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

" }, "outputLocation":{ "shape":"S3Location", "documentation":"

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

" }, "transformerId":{ "shape":"TransformerId", "documentation":"

Specifies the system-assigned unique identifier for the transformer.

" }, "clientToken":{ "shape":"String", "documentation":"

Reserved for future use.

", "idempotencyToken":true } } }, "StartTransformerJobResponse":{ "type":"structure", "required":["transformerJobId"], "members":{ "transformerJobId":{ "shape":"TransformerJobId", "documentation":"

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

" } } }, "String":{"type":"string"}, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"

Specifies the name assigned to the tag that you create.

" }, "Value":{ "shape":"TagValue", "documentation":"

Contains one or more values that you assigned to the key name that you create.

" } }, "documentation":"

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.

" }, "TagKey":{ "type":"string", "max":128, "min":1 }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":200, "min":0 }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "max":200, "min":0 }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceARN", "Tags" ], "members":{ "ResourceARN":{ "shape":"AmazonResourceName", "documentation":"

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

" }, "Tags":{ "shape":"TagList", "documentation":"

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.

" } } }, "TagValue":{ "type":"string", "max":256, "min":0 }, "TestMappingInputFileContent":{ "type":"string", "max":5000000, "min":0 }, "TestMappingRequest":{ "type":"structure", "required":[ "inputFileContent", "mappingTemplate", "fileFormat" ], "members":{ "inputFileContent":{ "shape":"TestMappingInputFileContent", "documentation":"

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

" }, "mappingTemplate":{ "shape":"MappingTemplate", "documentation":"

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.

" }, "fileFormat":{ "shape":"FileFormat", "documentation":"

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

" } } }, "TestMappingResponse":{ "type":"structure", "required":["mappedFileContent"], "members":{ "mappedFileContent":{ "shape":"String", "documentation":"

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

" } } }, "TestParsingRequest":{ "type":"structure", "required":[ "inputFile", "fileFormat", "ediType" ], "members":{ "inputFile":{ "shape":"S3Location", "documentation":"

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

" }, "fileFormat":{ "shape":"FileFormat", "documentation":"

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

" }, "ediType":{ "shape":"EdiType", "documentation":"

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.

" } } }, "TestParsingResponse":{ "type":"structure", "required":["parsedFileContent"], "members":{ "parsedFileContent":{ "shape":"String", "documentation":"

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

" } } }, "ThrottlingException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"ErrorMessage"}, "retryAfterSeconds":{ "shape":"Integer", "documentation":"

The server attempts to retry a command that was throttled.

" } }, "documentation":"

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

", "exception":true, "retryable":{"throttling":false} }, "TradingPartnerId":{ "type":"string", "max":64, "min":1, "pattern":"[a-zA-Z0-9_-]+" }, "TransformerId":{ "type":"string", "max":64, "min":1, "pattern":"[a-zA-Z0-9_-]+" }, "TransformerJobId":{ "type":"string", "max":25, "min":25, "pattern":"[a-zA-Z0-9_-]+" }, "TransformerJobStatus":{ "type":"string", "enum":[ "running", "succeeded", "failed" ] }, "TransformerList":{ "type":"list", "member":{"shape":"TransformerSummary"} }, "TransformerName":{ "type":"string", "max":254, "min":1 }, "TransformerStatus":{ "type":"string", "enum":[ "active", "inactive" ] }, "TransformerSummary":{ "type":"structure", "required":[ "transformerId", "name", "fileFormat", "mappingTemplate", "status", "ediType", "createdAt" ], "members":{ "transformerId":{ "shape":"TransformerId", "documentation":"

Returns the system-assigned unique identifier for the transformer.

" }, "name":{ "shape":"TransformerName", "documentation":"

Returns the descriptive name for the transformer.

" }, "fileFormat":{ "shape":"FileFormat", "documentation":"

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

" }, "mappingTemplate":{ "shape":"MappingTemplate", "documentation":"

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.

" }, "status":{ "shape":"TransformerStatus", "documentation":"

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

" }, "ediType":{ "shape":"EdiType", "documentation":"

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.

" }, "sampleDocument":{ "shape":"FileLocation", "documentation":"

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

" }, "createdAt":{ "shape":"CreatedDate", "documentation":"

Returns a timestamp indicating when the transformer was created. For example, `2023-07-20T19:58:44.624Z`.

" }, "modifiedAt":{ "shape":"ModifiedDate", "documentation":"

Returns a timestamp representing the date and time for the most recent change for the transformer object.

" } }, "documentation":"

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.

" }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceARN", "TagKeys" ], "members":{ "ResourceARN":{ "shape":"AmazonResourceName", "documentation":"

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

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

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.

" } } }, "UpdateCapabilityRequest":{ "type":"structure", "required":["capabilityId"], "members":{ "capabilityId":{ "shape":"CapabilityId", "documentation":"

Specifies a system-assigned unique identifier for the capability.

" }, "name":{ "shape":"CapabilityName", "documentation":"

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

" }, "configuration":{ "shape":"CapabilityConfiguration", "documentation":"

Specifies a structure that contains the details for a capability.

" }, "instructionsDocuments":{ "shape":"InstructionsDocuments", "documentation":"

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":{ "type":"structure", "required":[ "capabilityId", "capabilityArn", "name", "type", "configuration", "createdAt" ], "members":{ "capabilityId":{ "shape":"CapabilityId", "documentation":"

Returns a system-assigned unique identifier for the capability.

" }, "capabilityArn":{ "shape":"ResourceArn", "documentation":"

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

" }, "name":{ "shape":"CapabilityName", "documentation":"

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

" }, "type":{ "shape":"CapabilityType", "documentation":"

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

" }, "configuration":{ "shape":"CapabilityConfiguration", "documentation":"

Returns a structure that contains the details for a capability.

" }, "instructionsDocuments":{ "shape":"InstructionsDocuments", "documentation":"

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.

" }, "createdAt":{ "shape":"CreatedDate", "documentation":"

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

" }, "modifiedAt":{ "shape":"ModifiedDate", "documentation":"

Returns a timestamp for last time the capability was modified.

" } } }, "UpdatePartnershipRequest":{ "type":"structure", "required":["partnershipId"], "members":{ "partnershipId":{ "shape":"PartnershipId", "documentation":"

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

" }, "name":{ "shape":"PartnerName", "documentation":"

The name of the partnership, used to identify it.

" }, "capabilities":{ "shape":"PartnershipCapabilities", "documentation":"

List of the capabilities associated with this partnership.

" } } }, "UpdatePartnershipResponse":{ "type":"structure", "required":[ "profileId", "partnershipId", "partnershipArn", "createdAt" ], "members":{ "profileId":{ "shape":"ProfileId", "documentation":"

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

" }, "partnershipId":{ "shape":"PartnershipId", "documentation":"

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

" }, "partnershipArn":{ "shape":"ResourceArn", "documentation":"

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

" }, "name":{ "shape":"PartnerName", "documentation":"

The name of the partnership, used to identify it.

" }, "email":{ "shape":"Email", "documentation":"

Returns the email address associated with this trading partner.

" }, "phone":{ "shape":"Phone", "documentation":"

Returns the phone number associated with the partnership.

" }, "capabilities":{ "shape":"PartnershipCapabilities", "documentation":"

Returns one or more capabilities associated with this partnership.

" }, "tradingPartnerId":{ "shape":"TradingPartnerId", "documentation":"

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

" }, "createdAt":{ "shape":"CreatedDate", "documentation":"

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

" }, "modifiedAt":{ "shape":"ModifiedDate", "documentation":"

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

" } } }, "UpdateProfileRequest":{ "type":"structure", "required":["profileId"], "members":{ "profileId":{ "shape":"ProfileId", "documentation":"

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

" }, "name":{ "shape":"ProfileName", "documentation":"

The name of the profile, used to identify it.

" }, "email":{ "shape":"Email", "documentation":"

Specifies the email address associated with this customer profile.

" }, "phone":{ "shape":"Phone", "documentation":"

Specifies the phone number associated with the profile.

" }, "businessName":{ "shape":"BusinessName", "documentation":"

Specifies the name for the business associated with this profile.

" } } }, "UpdateProfileResponse":{ "type":"structure", "required":[ "profileId", "profileArn", "name", "phone", "businessName", "createdAt" ], "members":{ "profileId":{ "shape":"ProfileId", "documentation":"

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

" }, "profileArn":{ "shape":"ResourceArn", "documentation":"

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

" }, "name":{ "shape":"ProfileName", "documentation":"

Returns the name of the profile.

" }, "email":{ "shape":"Email", "documentation":"

Returns the email address associated with this customer profile.

" }, "phone":{ "shape":"Phone", "documentation":"

Returns the phone number associated with the profile.

" }, "businessName":{ "shape":"BusinessName", "documentation":"

Returns the name for the business associated with this profile.

" }, "logging":{ "shape":"Logging", "documentation":"

Specifies whether or not logging is enabled for this profile.

" }, "logGroupName":{ "shape":"LogGroupName", "documentation":"

Returns the name of the logging group.

" }, "createdAt":{ "shape":"CreatedDate", "documentation":"

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

" }, "modifiedAt":{ "shape":"ModifiedDate", "documentation":"

Returns a timestamp for last time the profile was modified.

" } } }, "UpdateTransformerRequest":{ "type":"structure", "required":["transformerId"], "members":{ "transformerId":{ "shape":"TransformerId", "documentation":"

Specifies the system-assigned unique identifier for the transformer.

" }, "name":{ "shape":"TransformerName", "documentation":"

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

" }, "fileFormat":{ "shape":"FileFormat", "documentation":"

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

" }, "mappingTemplate":{ "shape":"MappingTemplate", "documentation":"

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.

" }, "status":{ "shape":"TransformerStatus", "documentation":"

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

" }, "ediType":{ "shape":"EdiType", "documentation":"

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.

" }, "sampleDocument":{ "shape":"FileLocation", "documentation":"

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

" } } }, "UpdateTransformerResponse":{ "type":"structure", "required":[ "transformerId", "transformerArn", "name", "fileFormat", "mappingTemplate", "status", "ediType", "createdAt", "modifiedAt" ], "members":{ "transformerId":{ "shape":"TransformerId", "documentation":"

Returns the system-assigned unique identifier for the transformer.

" }, "transformerArn":{ "shape":"ResourceArn", "documentation":"

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

" }, "name":{ "shape":"TransformerName", "documentation":"

Returns the name of the transformer.

" }, "fileFormat":{ "shape":"FileFormat", "documentation":"

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

" }, "mappingTemplate":{ "shape":"MappingTemplate", "documentation":"

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.

" }, "status":{ "shape":"TransformerStatus", "documentation":"

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

" }, "ediType":{ "shape":"EdiType", "documentation":"

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.

" }, "sampleDocument":{ "shape":"FileLocation", "documentation":"

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

" }, "createdAt":{ "shape":"CreatedDate", "documentation":"

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

" }, "modifiedAt":{ "shape":"ModifiedDate", "documentation":"

Returns a timestamp for last time the transformer was modified.

" } } }, "ValidationException":{ "type":"structure", "required":["Message"], "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

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

", "exception":true }, "X12Details":{ "type":"structure", "members":{ "transactionSet":{ "shape":"X12TransactionSet", "documentation":"

Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.

" }, "version":{ "shape":"X12Version", "documentation":"

Returns the version to use for the specified X12 transaction set. Supported versions are `4010`, `4030`, and `5010`.

" } }, "documentation":"

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.

" }, "X12TransactionSet":{ "type":"string", "enum":[ "X12_110", "X12_180", "X12_204", "X12_210", "X12_214", "X12_215", "X12_310", "X12_315", "X12_322", "X12_404", "X12_410", "X12_820", "X12_824", "X12_830", "X12_846", "X12_850", "X12_852", "X12_855", "X12_856", "X12_860", "X12_861", "X12_864", "X12_940", "X12_990", "X12_997" ] }, "X12Version":{ "type":"string", "enum":[ "VERSION_4010", "VERSION_4030", "VERSION_5010" ] } }, "documentation":"

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.

" }