Class: AWS.B2bi

var params = {
  email: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  profileId: 'STRING_VALUE', /* required */
  capabilities: [
    'STRING_VALUE',
    /* more items */
  ],
  clientToken: 'STRING_VALUE',
  phone: 'STRING_VALUE',
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
b2bi.createPartnership(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • profileId — (String)

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

  • name — (String)

    Specifies a descriptive name for the partnership.

  • email — (String)

    Specifies the email address associated with this trading partner.

  • phone — (String)

    Specifies the phone number associated with the partnership.

  • capabilities — (Array<String>)

    Specifies a list of the capabilities associated with this partnership.

  • clientToken — (String)

    Reserved for future use.

    If a token is not provided, the SDK will use a version 4 UUID.
  • tags — (Array<map>)

    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.

    • Key — required — (String)

      Specifies the name assigned to the tag that you create.

    • Value — required — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • profileId — (String)

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

    • partnershipId — (String)

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

    • partnershipArn — (String)

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

    • name — (String)

      Returns a descriptive name for the partnership.

    • email — (String)

      Returns the email address associated with this trading partner.

    • phone — (String)

      Returns the phone number associated with the partnership.

    • capabilities — (Array<String>)

      Returns one or more capabilities associated with this partnership.

    • tradingPartnerId — (String)

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

    • createdAt — (Date)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  businessName: 'STRING_VALUE', /* required */
  logging: ENABLED | DISABLED, /* required */
  name: 'STRING_VALUE', /* required */
  phone: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  email: 'STRING_VALUE',
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
b2bi.createProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    Specifies the name of the profile.

  • email — (String)

    Specifies the email address associated with this customer profile.

  • phone — (String)

    Specifies the phone number associated with the profile.

  • businessName — (String)

    Specifies the name for the business associated with this profile.

  • logging — (String)

    Specifies whether or not logging is enabled for this profile.

    Possible values include:
    • "ENABLED"
    • "DISABLED"
  • clientToken — (String)

    Reserved for future use.

    If a token is not provided, the SDK will use a version 4 UUID.
  • tags — (Array<map>)

    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.

    • Key — required — (String)

      Specifies the name assigned to the tag that you create.

    • Value — required — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • profileId — (String)

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

    • profileArn — (String)

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

    • name — (String)

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

    • businessName — (String)

      Returns the name for the business associated with this profile.

    • phone — (String)

      Returns the phone number associated with the profile.

    • email — (String)

      Returns the email address associated with this customer profile.

    • logging — (String)

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

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • logGroupName — (String)

      Returns the name of the logging group.

    • createdAt — (Date)

      Returns a timestamp representing the time the profile was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ediType: { /* required */
    x12Details: {
      transactionSet: X12_110 | X12_180 | X12_204 | X12_210 | X12_211 | X12_214 | X12_215 | X12_259 | X12_260 | X12_266 | X12_269 | X12_270 | X12_271 | X12_274 | X12_275 | X12_276 | X12_277 | X12_278 | X12_310 | X12_315 | X12_322 | X12_404 | X12_410 | X12_417 | X12_421 | X12_426 | X12_810 | X12_820 | X12_824 | X12_830 | X12_832 | X12_834 | X12_835 | X12_837 | X12_844 | X12_846 | X12_849 | X12_850 | X12_852 | X12_855 | X12_856 | X12_860 | X12_861 | X12_864 | X12_865 | X12_869 | X12_870 | X12_940 | X12_945 | X12_990 | X12_997 | X12_999 | X12_270_X279 | X12_271_X279 | X12_275_X210 | X12_275_X211 | X12_276_X212 | X12_277_X212 | X12_277_X214 | X12_277_X364 | X12_278_X217 | X12_820_X218 | X12_820_X306 | X12_824_X186 | X12_834_X220 | X12_834_X307 | X12_834_X318 | X12_835_X221 | X12_837_X222 | X12_837_X223 | X12_837_X224 | X12_837_X291 | X12_837_X292 | X12_837_X298 | X12_999_X231,
      version: VERSION_4010 | VERSION_4030 | VERSION_5010 | VERSION_5010_HIPAA
    }
  },
  fileFormat: XML | JSON, /* required */
  mappingTemplate: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  sampleDocument: 'STRING_VALUE',
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
b2bi.createTransformer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

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

  • fileFormat — (String)

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

    Possible values include:
    • "XML"
    • "JSON"
  • mappingTemplate — (String)

    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 — (map)

    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.

    • x12Details — (map)

      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.

      • transactionSet — (String)

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

        Possible values include:
        • "X12_110"
        • "X12_180"
        • "X12_204"
        • "X12_210"
        • "X12_211"
        • "X12_214"
        • "X12_215"
        • "X12_259"
        • "X12_260"
        • "X12_266"
        • "X12_269"
        • "X12_270"
        • "X12_271"
        • "X12_274"
        • "X12_275"
        • "X12_276"
        • "X12_277"
        • "X12_278"
        • "X12_310"
        • "X12_315"
        • "X12_322"
        • "X12_404"
        • "X12_410"
        • "X12_417"
        • "X12_421"
        • "X12_426"
        • "X12_810"
        • "X12_820"
        • "X12_824"
        • "X12_830"
        • "X12_832"
        • "X12_834"
        • "X12_835"
        • "X12_837"
        • "X12_844"
        • "X12_846"
        • "X12_849"
        • "X12_850"
        • "X12_852"
        • "X12_855"
        • "X12_856"
        • "X12_860"
        • "X12_861"
        • "X12_864"
        • "X12_865"
        • "X12_869"
        • "X12_870"
        • "X12_940"
        • "X12_945"
        • "X12_990"
        • "X12_997"
        • "X12_999"
        • "X12_270_X279"
        • "X12_271_X279"
        • "X12_275_X210"
        • "X12_275_X211"
        • "X12_276_X212"
        • "X12_277_X212"
        • "X12_277_X214"
        • "X12_277_X364"
        • "X12_278_X217"
        • "X12_820_X218"
        • "X12_820_X306"
        • "X12_824_X186"
        • "X12_834_X220"
        • "X12_834_X307"
        • "X12_834_X318"
        • "X12_835_X221"
        • "X12_837_X222"
        • "X12_837_X223"
        • "X12_837_X224"
        • "X12_837_X291"
        • "X12_837_X292"
        • "X12_837_X298"
        • "X12_999_X231"
      • version — (String)

        Returns the version to use for the specified X12 transaction set.

         </p> 

        Possible values include:
        • "VERSION_4010"
        • "VERSION_4030"
        • "VERSION_5010"
        • "VERSION_5010_HIPAA"
  • sampleDocument — (String)

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

  • clientToken — (String)

    Reserved for future use.

    If a token is not provided, the SDK will use a version 4 UUID.
  • tags — (Array<map>)

    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.

    • Key — required — (String)

      Specifies the name assigned to the tag that you create.

    • Value — required — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • transformerId — (String)

      Returns the system-assigned unique identifier for the transformer.

    • transformerArn — (String)

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

    • name — (String)

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

    • fileFormat — (String)

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

      Possible values include:
      • "XML"
      • "JSON"
    • mappingTemplate — (String)

      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 — (String)

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

      Possible values include:
      • "active"
      • "inactive"
    • ediType — (map)

      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.

      • x12Details — (map)

        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.

        • transactionSet — (String)

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

          Possible values include:
          • "X12_110"
          • "X12_180"
          • "X12_204"
          • "X12_210"
          • "X12_211"
          • "X12_214"
          • "X12_215"
          • "X12_259"
          • "X12_260"
          • "X12_266"
          • "X12_269"
          • "X12_270"
          • "X12_271"
          • "X12_274"
          • "X12_275"
          • "X12_276"
          • "X12_277"
          • "X12_278"
          • "X12_310"
          • "X12_315"
          • "X12_322"
          • "X12_404"
          • "X12_410"
          • "X12_417"
          • "X12_421"
          • "X12_426"
          • "X12_810"
          • "X12_820"
          • "X12_824"
          • "X12_830"
          • "X12_832"
          • "X12_834"
          • "X12_835"
          • "X12_837"
          • "X12_844"
          • "X12_846"
          • "X12_849"
          • "X12_850"
          • "X12_852"
          • "X12_855"
          • "X12_856"
          • "X12_860"
          • "X12_861"
          • "X12_864"
          • "X12_865"
          • "X12_869"
          • "X12_870"
          • "X12_940"
          • "X12_945"
          • "X12_990"
          • "X12_997"
          • "X12_999"
          • "X12_270_X279"
          • "X12_271_X279"
          • "X12_275_X210"
          • "X12_275_X211"
          • "X12_276_X212"
          • "X12_277_X212"
          • "X12_277_X214"
          • "X12_277_X364"
          • "X12_278_X217"
          • "X12_820_X218"
          • "X12_820_X306"
          • "X12_824_X186"
          • "X12_834_X220"
          • "X12_834_X307"
          • "X12_834_X318"
          • "X12_835_X221"
          • "X12_837_X222"
          • "X12_837_X223"
          • "X12_837_X224"
          • "X12_837_X291"
          • "X12_837_X292"
          • "X12_837_X298"
          • "X12_999_X231"
        • version — (String)

          Returns the version to use for the specified X12 transaction set.

           </p> 

          Possible values include:
          • "VERSION_4010"
          • "VERSION_4030"
          • "VERSION_5010"
          • "VERSION_5010_HIPAA"
    • sampleDocument — (String)

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

    • createdAt — (Date)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  capabilityId: 'STRING_VALUE' /* required */
};
b2bi.deleteCapability(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • capabilityId — (String)

    Specifies a system-assigned unique identifier for the capability.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  partnershipId: 'STRING_VALUE' /* required */
};
b2bi.deletePartnership(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • partnershipId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  profileId: 'STRING_VALUE' /* required */
};
b2bi.deleteProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • profileId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  transformerId: 'STRING_VALUE' /* required */
};
b2bi.deleteTransformer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • transformerId — (String)

    Specifies the system-assigned unique identifier for the transformer.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  capabilityId: 'STRING_VALUE' /* required */
};
b2bi.getCapability(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • capabilityId — (String)

    Specifies a system-assigned unique identifier for the capability.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • capabilityId — (String)

      Returns a system-assigned unique identifier for the capability.

    • capabilityArn — (String)

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

    • name — (String)

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

    • type — (String)

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

      Possible values include:
      • "edi"
    • configuration — (map)

      Returns a structure that contains the details for a capability.

      • edi — (map)

        An EDI (electronic data interchange) configuration object.

        • type — required — (map)

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

          • x12Details — (map)

            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.

            • transactionSet — (String)

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

              Possible values include:
              • "X12_110"
              • "X12_180"
              • "X12_204"
              • "X12_210"
              • "X12_211"
              • "X12_214"
              • "X12_215"
              • "X12_259"
              • "X12_260"
              • "X12_266"
              • "X12_269"
              • "X12_270"
              • "X12_271"
              • "X12_274"
              • "X12_275"
              • "X12_276"
              • "X12_277"
              • "X12_278"
              • "X12_310"
              • "X12_315"
              • "X12_322"
              • "X12_404"
              • "X12_410"
              • "X12_417"
              • "X12_421"
              • "X12_426"
              • "X12_810"
              • "X12_820"
              • "X12_824"
              • "X12_830"
              • "X12_832"
              • "X12_834"
              • "X12_835"
              • "X12_837"
              • "X12_844"
              • "X12_846"
              • "X12_849"
              • "X12_850"
              • "X12_852"
              • "X12_855"
              • "X12_856"
              • "X12_860"
              • "X12_861"
              • "X12_864"
              • "X12_865"
              • "X12_869"
              • "X12_870"
              • "X12_940"
              • "X12_945"
              • "X12_990"
              • "X12_997"
              • "X12_999"
              • "X12_270_X279"
              • "X12_271_X279"
              • "X12_275_X210"
              • "X12_275_X211"
              • "X12_276_X212"
              • "X12_277_X212"
              • "X12_277_X214"
              • "X12_277_X364"
              • "X12_278_X217"
              • "X12_820_X218"
              • "X12_820_X306"
              • "X12_824_X186"
              • "X12_834_X220"
              • "X12_834_X307"
              • "X12_834_X318"
              • "X12_835_X221"
              • "X12_837_X222"
              • "X12_837_X223"
              • "X12_837_X224"
              • "X12_837_X291"
              • "X12_837_X292"
              • "X12_837_X298"
              • "X12_999_X231"
            • version — (String)

              Returns the version to use for the specified X12 transaction set.

               </p> 

              Possible values include:
              • "VERSION_4010"
              • "VERSION_4030"
              • "VERSION_5010"
              • "VERSION_5010_HIPAA"
        • inputLocation — required — (map)

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

          • bucketName — (String)

            Specifies the name of the Amazon S3 bucket.

          • key — (String)

            Specifies the Amazon S3 key for the file location.

        • outputLocation — required — (map)

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

          • bucketName — (String)

            Specifies the name of the Amazon S3 bucket.

          • key — (String)

            Specifies the Amazon S3 key for the file location.

        • transformerId — required — (String)

          Returns the system-assigned unique identifier for the transformer.

    • instructionsDocuments — (Array<map>)

      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.

      • bucketName — (String)

        Specifies the name of the Amazon S3 bucket.

      • key — (String)

        Specifies the Amazon S3 key for the file location.

    • createdAt — (Date)

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

    • modifiedAt — (Date)

      Returns a timestamp for last time the capability was modified.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  partnershipId: 'STRING_VALUE' /* required */
};
b2bi.getPartnership(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • partnershipId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • profileId — (String)

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

    • partnershipId — (String)

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

    • partnershipArn — (String)

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

    • name — (String)

      Returns the display name of the partnership

    • email — (String)

      Returns the email address associated with this trading partner.

    • phone — (String)

      Returns the phone number associated with the partnership.

    • capabilities — (Array<String>)

      Returns one or more capabilities associated with this partnership.

    • tradingPartnerId — (String)

      Returns the unique identifier for the partner for this partnership.

    • createdAt — (Date)

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

    • modifiedAt — (Date)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  profileId: 'STRING_VALUE' /* required */
};
b2bi.getProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • profileId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • profileId — (String)

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

    • profileArn — (String)

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

    • name — (String)

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

    • email — (String)

      Returns the email address associated with this customer profile.

    • phone — (String)

      Returns the phone number associated with the profile.

    • businessName — (String)

      Returns the name for the business associated with this profile.

    • logging — (String)

      Returns whether or not logging is enabled for this profile.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • logGroupName — (String)

      Returns the name of the logging group.

    • createdAt — (Date)

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

    • modifiedAt — (Date)

      Returns a timestamp for last time the profile was modified.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  transformerId: 'STRING_VALUE' /* required */
};
b2bi.getTransformer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • transformerId — (String)

    Specifies the system-assigned unique identifier for the transformer.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • transformerId — (String)

      Returns the system-assigned unique identifier for the transformer.

    • transformerArn — (String)

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

    • name — (String)

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

    • fileFormat — (String)

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

      Possible values include:
      • "XML"
      • "JSON"
    • mappingTemplate — (String)

      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 — (String)

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

      Possible values include:
      • "active"
      • "inactive"
    • ediType — (map)

      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.

      • x12Details — (map)

        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.

        • transactionSet — (String)

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

          Possible values include:
          • "X12_110"
          • "X12_180"
          • "X12_204"
          • "X12_210"
          • "X12_211"
          • "X12_214"
          • "X12_215"
          • "X12_259"
          • "X12_260"
          • "X12_266"
          • "X12_269"
          • "X12_270"
          • "X12_271"
          • "X12_274"
          • "X12_275"
          • "X12_276"
          • "X12_277"
          • "X12_278"
          • "X12_310"
          • "X12_315"
          • "X12_322"
          • "X12_404"
          • "X12_410"
          • "X12_417"
          • "X12_421"
          • "X12_426"
          • "X12_810"
          • "X12_820"
          • "X12_824"
          • "X12_830"
          • "X12_832"
          • "X12_834"
          • "X12_835"
          • "X12_837"
          • "X12_844"
          • "X12_846"
          • "X12_849"
          • "X12_850"
          • "X12_852"
          • "X12_855"
          • "X12_856"
          • "X12_860"
          • "X12_861"
          • "X12_864"
          • "X12_865"
          • "X12_869"
          • "X12_870"
          • "X12_940"
          • "X12_945"
          • "X12_990"
          • "X12_997"
          • "X12_999"
          • "X12_270_X279"
          • "X12_271_X279"
          • "X12_275_X210"
          • "X12_275_X211"
          • "X12_276_X212"
          • "X12_277_X212"
          • "X12_277_X214"
          • "X12_277_X364"
          • "X12_278_X217"
          • "X12_820_X218"
          • "X12_820_X306"
          • "X12_824_X186"
          • "X12_834_X220"
          • "X12_834_X307"
          • "X12_834_X318"
          • "X12_835_X221"
          • "X12_837_X222"
          • "X12_837_X223"
          • "X12_837_X224"
          • "X12_837_X291"
          • "X12_837_X292"
          • "X12_837_X298"
          • "X12_999_X231"
        • version — (String)

          Returns the version to use for the specified X12 transaction set.

           </p> 

          Possible values include:
          • "VERSION_4010"
          • "VERSION_4030"
          • "VERSION_5010"
          • "VERSION_5010_HIPAA"
    • sampleDocument — (String)

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

    • createdAt — (Date)

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

    • modifiedAt — (Date)

      Returns a timestamp for last time the transformer was modified.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  transformerId: 'STRING_VALUE', /* required */
  transformerJobId: 'STRING_VALUE' /* required */
};
b2bi.getTransformerJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • transformerJobId — (String)

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

  • transformerId — (String)

    Specifies the system-assigned unique identifier for the transformer.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • status — (String)

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

      Possible values include:
      • "running"
      • "succeeded"
      • "failed"
    • outputFiles — (Array<map>)

      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.

      • bucketName — (String)

        Specifies the name of the Amazon S3 bucket.

      • key — (String)

        Specifies the Amazon S3 key for the file location.

    • message — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
b2bi.listCapabilities(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    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 — (Integer)

    Specifies the maximum number of capabilities to return.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • capabilities — (Array<map>)

      Returns one or more capabilities associated with this partnership.

      • capabilityId — required — (String)

        Returns a system-assigned unique identifier for the capability.

      • name — required — (String)

        The display name of the capability.

      • type — required — (String)

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

        Possible values include:
        • "edi"
      • createdAt — required — (Date)

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

      • modifiedAt — (Date)

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

    • nextToken — (String)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  profileId: 'STRING_VALUE'
};
b2bi.listPartnerships(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • profileId — (String)

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

  • nextToken — (String)

    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 — (Integer)

    Specifies the maximum number of capabilities to return.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • partnerships — (Array<map>)

      Specifies a list of your partnerships.

      • profileId — required — (String)

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

      • partnershipId — required — (String)

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

      • name — (String)

        Returns the name of the partnership.

      • capabilities — (Array<String>)

        Returns one or more capabilities associated with this partnership.

      • tradingPartnerId — (String)

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

      • createdAt — required — (Date)

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

      • modifiedAt — (Date)

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

    • nextToken — (String)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
b2bi.listProfiles(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    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 — (Integer)

    Specifies the maximum number of profiles to return.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • profiles — (Array<map>)

      Returns an array of ProfileSummary objects.

      • profileId — required — (String)

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

      • name — required — (String)

        Returns the display name for profile.

      • businessName — required — (String)

        Returns the name for the business associated with this profile.

      • logging — (String)

        Specifies whether or not logging is enabled for this profile.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • logGroupName — (String)

        Returns the name of the logging group.

      • createdAt — required — (Date)

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

      • modifiedAt — (Date)

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

    • nextToken — (String)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceARN: 'STRING_VALUE' /* required */
};
b2bi.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceARN — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Tags — (Array<map>)

      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.

      • Key — required — (String)

        Specifies the name assigned to the tag that you create.

      • Value — required — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
b2bi.listTransformers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    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 — (Integer)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • transformers — (Array<map>)

      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.

      • transformerId — required — (String)

        Returns the system-assigned unique identifier for the transformer.

      • name — required — (String)

        Returns the descriptive name for the transformer.

      • fileFormat — required — (String)

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

        Possible values include:
        • "XML"
        • "JSON"
      • mappingTemplate — required — (String)

        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 — required — (String)

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

        Possible values include:
        • "active"
        • "inactive"
      • ediType — required — (map)

        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.

        • x12Details — (map)

          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.

          • transactionSet — (String)

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

            Possible values include:
            • "X12_110"
            • "X12_180"
            • "X12_204"
            • "X12_210"
            • "X12_211"
            • "X12_214"
            • "X12_215"
            • "X12_259"
            • "X12_260"
            • "X12_266"
            • "X12_269"
            • "X12_270"
            • "X12_271"
            • "X12_274"
            • "X12_275"
            • "X12_276"
            • "X12_277"
            • "X12_278"
            • "X12_310"
            • "X12_315"
            • "X12_322"
            • "X12_404"
            • "X12_410"
            • "X12_417"
            • "X12_421"
            • "X12_426"
            • "X12_810"
            • "X12_820"
            • "X12_824"
            • "X12_830"
            • "X12_832"
            • "X12_834"
            • "X12_835"
            • "X12_837"
            • "X12_844"
            • "X12_846"
            • "X12_849"
            • "X12_850"
            • "X12_852"
            • "X12_855"
            • "X12_856"
            • "X12_860"
            • "X12_861"
            • "X12_864"
            • "X12_865"
            • "X12_869"
            • "X12_870"
            • "X12_940"
            • "X12_945"
            • "X12_990"
            • "X12_997"
            • "X12_999"
            • "X12_270_X279"
            • "X12_271_X279"
            • "X12_275_X210"
            • "X12_275_X211"
            • "X12_276_X212"
            • "X12_277_X212"
            • "X12_277_X214"
            • "X12_277_X364"
            • "X12_278_X217"
            • "X12_820_X218"
            • "X12_820_X306"
            • "X12_824_X186"
            • "X12_834_X220"
            • "X12_834_X307"
            • "X12_834_X318"
            • "X12_835_X221"
            • "X12_837_X222"
            • "X12_837_X223"
            • "X12_837_X224"
            • "X12_837_X291"
            • "X12_837_X292"
            • "X12_837_X298"
            • "X12_999_X231"
          • version — (String)

            Returns the version to use for the specified X12 transaction set.

             </p> 

            Possible values include:
            • "VERSION_4010"
            • "VERSION_4030"
            • "VERSION_5010"
            • "VERSION_5010_HIPAA"
      • sampleDocument — (String)

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

      • createdAt — required — (Date)

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

      • modifiedAt — (Date)

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

    • nextToken — (String)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  inputFile: { /* required */
    bucketName: 'STRING_VALUE',
    key: 'STRING_VALUE'
  },
  outputLocation: { /* required */
    bucketName: 'STRING_VALUE',
    key: 'STRING_VALUE'
  },
  transformerId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
b2bi.startTransformerJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • inputFile — (map)

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

    • bucketName — (String)

      Specifies the name of the Amazon S3 bucket.

    • key — (String)

      Specifies the Amazon S3 key for the file location.

  • outputLocation — (map)

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

    • bucketName — (String)

      Specifies the name of the Amazon S3 bucket.

    • key — (String)

      Specifies the Amazon S3 key for the file location.

  • transformerId — (String)

    Specifies the system-assigned unique identifier for the transformer.

  • clientToken — (String)

    Reserved for future use.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • transformerJobId — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
b2bi.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceARN — (String)

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

  • Tags — (Array<map>)

    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.

    • Key — required — (String)

      Specifies the name assigned to the tag that you create.

    • Value — required — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  fileFormat: XML | JSON, /* required */
  inputFileContent: 'STRING_VALUE', /* required */
  mappingTemplate: 'STRING_VALUE' /* required */
};
b2bi.testMapping(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • inputFileContent — (String)

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

  • mappingTemplate — (String)

    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 — (String)

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

    Possible values include:
    • "XML"
    • "JSON"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • mappedFileContent — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ediType: { /* required */
    x12Details: {
      transactionSet: X12_110 | X12_180 | X12_204 | X12_210 | X12_211 | X12_214 | X12_215 | X12_259 | X12_260 | X12_266 | X12_269 | X12_270 | X12_271 | X12_274 | X12_275 | X12_276 | X12_277 | X12_278 | X12_310 | X12_315 | X12_322 | X12_404 | X12_410 | X12_417 | X12_421 | X12_426 | X12_810 | X12_820 | X12_824 | X12_830 | X12_832 | X12_834 | X12_835 | X12_837 | X12_844 | X12_846 | X12_849 | X12_850 | X12_852 | X12_855 | X12_856 | X12_860 | X12_861 | X12_864 | X12_865 | X12_869 | X12_870 | X12_940 | X12_945 | X12_990 | X12_997 | X12_999 | X12_270_X279 | X12_271_X279 | X12_275_X210 | X12_275_X211 | X12_276_X212 | X12_277_X212 | X12_277_X214 | X12_277_X364 | X12_278_X217 | X12_820_X218 | X12_820_X306 | X12_824_X186 | X12_834_X220 | X12_834_X307 | X12_834_X318 | X12_835_X221 | X12_837_X222 | X12_837_X223 | X12_837_X224 | X12_837_X291 | X12_837_X292 | X12_837_X298 | X12_999_X231,
      version: VERSION_4010 | VERSION_4030 | VERSION_5010 | VERSION_5010_HIPAA
    }
  },
  fileFormat: XML | JSON, /* required */
  inputFile: { /* required */
    bucketName: 'STRING_VALUE',
    key: 'STRING_VALUE'
  }
};
b2bi.testParsing(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • inputFile — (map)

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

    • bucketName — (String)

      Specifies the name of the Amazon S3 bucket.

    • key — (String)

      Specifies the Amazon S3 key for the file location.

  • fileFormat — (String)

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

    Possible values include:
    • "XML"
    • "JSON"
  • ediType — (map)

    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.

    • x12Details — (map)

      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.

      • transactionSet — (String)

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

        Possible values include:
        • "X12_110"
        • "X12_180"
        • "X12_204"
        • "X12_210"
        • "X12_211"
        • "X12_214"
        • "X12_215"
        • "X12_259"
        • "X12_260"
        • "X12_266"
        • "X12_269"
        • "X12_270"
        • "X12_271"
        • "X12_274"
        • "X12_275"
        • "X12_276"
        • "X12_277"
        • "X12_278"
        • "X12_310"
        • "X12_315"
        • "X12_322"
        • "X12_404"
        • "X12_410"
        • "X12_417"
        • "X12_421"
        • "X12_426"
        • "X12_810"
        • "X12_820"
        • "X12_824"
        • "X12_830"
        • "X12_832"
        • "X12_834"
        • "X12_835"
        • "X12_837"
        • "X12_844"
        • "X12_846"
        • "X12_849"
        • "X12_850"
        • "X12_852"
        • "X12_855"
        • "X12_856"
        • "X12_860"
        • "X12_861"
        • "X12_864"
        • "X12_865"
        • "X12_869"
        • "X12_870"
        • "X12_940"
        • "X12_945"
        • "X12_990"
        • "X12_997"
        • "X12_999"
        • "X12_270_X279"
        • "X12_271_X279"
        • "X12_275_X210"
        • "X12_275_X211"
        • "X12_276_X212"
        • "X12_277_X212"
        • "X12_277_X214"
        • "X12_277_X364"
        • "X12_278_X217"
        • "X12_820_X218"
        • "X12_820_X306"
        • "X12_824_X186"
        • "X12_834_X220"
        • "X12_834_X307"
        • "X12_834_X318"
        • "X12_835_X221"
        • "X12_837_X222"
        • "X12_837_X223"
        • "X12_837_X224"
        • "X12_837_X291"
        • "X12_837_X292"
        • "X12_837_X298"
        • "X12_999_X231"
      • version — (String)

        Returns the version to use for the specified X12 transaction set.

         </p> 

        Possible values include:
        • "VERSION_4010"
        • "VERSION_4030"
        • "VERSION_5010"
        • "VERSION_5010_HIPAA"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • parsedFileContent — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
b2bi.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceARN — (String)

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

  • TagKeys — (Array<String>)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  capabilityId: 'STRING_VALUE', /* required */
  configuration: {
    edi: {
      inputLocation: { /* required */
        bucketName: 'STRING_VALUE',
        key: 'STRING_VALUE'
      },
      outputLocation: { /* required */
        bucketName: 'STRING_VALUE',
        key: 'STRING_VALUE'
      },
      transformerId: 'STRING_VALUE', /* required */
      type: { /* required */
        x12Details: {
          transactionSet: X12_110 | X12_180 | X12_204 | X12_210 | X12_211 | X12_214 | X12_215 | X12_259 | X12_260 | X12_266 | X12_269 | X12_270 | X12_271 | X12_274 | X12_275 | X12_276 | X12_277 | X12_278 | X12_310 | X12_315 | X12_322 | X12_404 | X12_410 | X12_417 | X12_421 | X12_426 | X12_810 | X12_820 | X12_824 | X12_830 | X12_832 | X12_834 | X12_835 | X12_837 | X12_844 | X12_846 | X12_849 | X12_850 | X12_852 | X12_855 | X12_856 | X12_860 | X12_861 | X12_864 | X12_865 | X12_869 | X12_870 | X12_940 | X12_945 | X12_990 | X12_997 | X12_999 | X12_270_X279 | X12_271_X279 | X12_275_X210 | X12_275_X211 | X12_276_X212 | X12_277_X212 | X12_277_X214 | X12_277_X364 | X12_278_X217 | X12_820_X218 | X12_820_X306 | X12_824_X186 | X12_834_X220 | X12_834_X307 | X12_834_X318 | X12_835_X221 | X12_837_X222 | X12_837_X223 | X12_837_X224 | X12_837_X291 | X12_837_X292 | X12_837_X298 | X12_999_X231,
          version: VERSION_4010 | VERSION_4030 | VERSION_5010 | VERSION_5010_HIPAA
        }
      }
    }
  },
  instructionsDocuments: [
    {
      bucketName: 'STRING_VALUE',
      key: 'STRING_VALUE'
    },
    /* more items */
  ],
  name: 'STRING_VALUE'
};
b2bi.updateCapability(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • capabilityId — (String)

    Specifies a system-assigned unique identifier for the capability.

  • name — (String)

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

  • configuration — (map)

    Specifies a structure that contains the details for a capability.

    • edi — (map)

      An EDI (electronic data interchange) configuration object.

      • type — required — (map)

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

        • x12Details — (map)

          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.

          • transactionSet — (String)

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

            Possible values include:
            • "X12_110"
            • "X12_180"
            • "X12_204"
            • "X12_210"
            • "X12_211"
            • "X12_214"
            • "X12_215"
            • "X12_259"
            • "X12_260"
            • "X12_266"
            • "X12_269"
            • "X12_270"
            • "X12_271"
            • "X12_274"
            • "X12_275"
            • "X12_276"
            • "X12_277"
            • "X12_278"
            • "X12_310"
            • "X12_315"
            • "X12_322"
            • "X12_404"
            • "X12_410"
            • "X12_417"
            • "X12_421"
            • "X12_426"
            • "X12_810"
            • "X12_820"
            • "X12_824"
            • "X12_830"
            • "X12_832"
            • "X12_834"
            • "X12_835"
            • "X12_837"
            • "X12_844"
            • "X12_846"
            • "X12_849"
            • "X12_850"
            • "X12_852"
            • "X12_855"
            • "X12_856"
            • "X12_860"
            • "X12_861"
            • "X12_864"
            • "X12_865"
            • "X12_869"
            • "X12_870"
            • "X12_940"
            • "X12_945"
            • "X12_990"
            • "X12_997"
            • "X12_999"
            • "X12_270_X279"
            • "X12_271_X279"
            • "X12_275_X210"
            • "X12_275_X211"
            • "X12_276_X212"
            • "X12_277_X212"
            • "X12_277_X214"
            • "X12_277_X364"
            • "X12_278_X217"
            • "X12_820_X218"
            • "X12_820_X306"
            • "X12_824_X186"
            • "X12_834_X220"
            • "X12_834_X307"
            • "X12_834_X318"
            • "X12_835_X221"
            • "X12_837_X222"
            • "X12_837_X223"
            • "X12_837_X224"
            • "X12_837_X291"
            • "X12_837_X292"
            • "X12_837_X298"
            • "X12_999_X231"
          • version — (String)

            Returns the version to use for the specified X12 transaction set.

             </p> 

            Possible values include:
            • "VERSION_4010"
            • "VERSION_4030"
            • "VERSION_5010"
            • "VERSION_5010_HIPAA"
      • inputLocation — required — (map)

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

        • bucketName — (String)

          Specifies the name of the Amazon S3 bucket.

        • key — (String)

          Specifies the Amazon S3 key for the file location.

      • outputLocation — required — (map)

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

        • bucketName — (String)

          Specifies the name of the Amazon S3 bucket.

        • key — (String)

          Specifies the Amazon S3 key for the file location.

      • transformerId — required — (String)

        Returns the system-assigned unique identifier for the transformer.

  • instructionsDocuments — (Array<map>)

    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.

    • bucketName — (String)

      Specifies the name of the Amazon S3 bucket.

    • key — (String)

      Specifies the Amazon S3 key for the file location.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • capabilityId — (String)

      Returns a system-assigned unique identifier for the capability.

    • capabilityArn — (String)

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

    • name — (String)

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

    • type — (String)

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

      Possible values include:
      • "edi"
    • configuration — (map)

      Returns a structure that contains the details for a capability.

      • edi — (map)

        An EDI (electronic data interchange) configuration object.

        • type — required — (map)

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

          • x12Details — (map)

            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.

            • transactionSet — (String)

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

              Possible values include:
              • "X12_110"
              • "X12_180"
              • "X12_204"
              • "X12_210"
              • "X12_211"
              • "X12_214"
              • "X12_215"
              • "X12_259"
              • "X12_260"
              • "X12_266"
              • "X12_269"
              • "X12_270"
              • "X12_271"
              • "X12_274"
              • "X12_275"
              • "X12_276"
              • "X12_277"
              • "X12_278"
              • "X12_310"
              • "X12_315"
              • "X12_322"
              • "X12_404"
              • "X12_410"
              • "X12_417"
              • "X12_421"
              • "X12_426"
              • "X12_810"
              • "X12_820"
              • "X12_824"
              • "X12_830"
              • "X12_832"
              • "X12_834"
              • "X12_835"
              • "X12_837"
              • "X12_844"
              • "X12_846"
              • "X12_849"
              • "X12_850"
              • "X12_852"
              • "X12_855"
              • "X12_856"
              • "X12_860"
              • "X12_861"
              • "X12_864"
              • "X12_865"
              • "X12_869"
              • "X12_870"
              • "X12_940"
              • "X12_945"
              • "X12_990"
              • "X12_997"
              • "X12_999"
              • "X12_270_X279"
              • "X12_271_X279"
              • "X12_275_X210"
              • "X12_275_X211"
              • "X12_276_X212"
              • "X12_277_X212"
              • "X12_277_X214"
              • "X12_277_X364"
              • "X12_278_X217"
              • "X12_820_X218"
              • "X12_820_X306"
              • "X12_824_X186"
              • "X12_834_X220"
              • "X12_834_X307"
              • "X12_834_X318"
              • "X12_835_X221"
              • "X12_837_X222"
              • "X12_837_X223"
              • "X12_837_X224"
              • "X12_837_X291"
              • "X12_837_X292"
              • "X12_837_X298"
              • "X12_999_X231"
            • version — (String)

              Returns the version to use for the specified X12 transaction set.

               </p> 

              Possible values include:
              • "VERSION_4010"
              • "VERSION_4030"
              • "VERSION_5010"
              • "VERSION_5010_HIPAA"
        • inputLocation — required — (map)

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

          • bucketName — (String)

            Specifies the name of the Amazon S3 bucket.

          • key — (String)

            Specifies the Amazon S3 key for the file location.

        • outputLocation — required — (map)

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

          • bucketName — (String)

            Specifies the name of the Amazon S3 bucket.

          • key — (String)

            Specifies the Amazon S3 key for the file location.

        • transformerId — required — (String)

          Returns the system-assigned unique identifier for the transformer.

    • instructionsDocuments — (Array<map>)

      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.

      • bucketName — (String)

        Specifies the name of the Amazon S3 bucket.

      • key — (String)

        Specifies the Amazon S3 key for the file location.

    • createdAt — (Date)

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

    • modifiedAt — (Date)

      Returns a timestamp for last time the capability was modified.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  partnershipId: 'STRING_VALUE', /* required */
  capabilities: [
    'STRING_VALUE',
    /* more items */
  ],
  name: 'STRING_VALUE'
};
b2bi.updatePartnership(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • partnershipId — (String)

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

  • name — (String)

    The name of the partnership, used to identify it.

  • capabilities — (Array<String>)

    List of the capabilities associated with this partnership.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • profileId — (String)

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

    • partnershipId — (String)

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

    • partnershipArn — (String)

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

    • name — (String)

      The name of the partnership, used to identify it.

    • email — (String)

      Returns the email address associated with this trading partner.

    • phone — (String)

      Returns the phone number associated with the partnership.

    • capabilities — (Array<String>)

      Returns one or more capabilities associated with this partnership.

    • tradingPartnerId — (String)

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

    • createdAt — (Date)

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

    • modifiedAt — (Date)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  profileId: 'STRING_VALUE', /* required */
  businessName: 'STRING_VALUE',
  email: 'STRING_VALUE',
  name: 'STRING_VALUE',
  phone: 'STRING_VALUE'
};
b2bi.updateProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • profileId — (String)

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

  • name — (String)

    The name of the profile, used to identify it.

  • email — (String)

    Specifies the email address associated with this customer profile.

  • phone — (String)

    Specifies the phone number associated with the profile.

  • businessName — (String)

    Specifies the name for the business associated with this profile.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • profileId — (String)

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

    • profileArn — (String)

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

    • name — (String)

      Returns the name of the profile.

    • email — (String)

      Returns the email address associated with this customer profile.

    • phone — (String)

      Returns the phone number associated with the profile.

    • businessName — (String)

      Returns the name for the business associated with this profile.

    • logging — (String)

      Specifies whether or not logging is enabled for this profile.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • logGroupName — (String)

      Returns the name of the logging group.

    • createdAt — (Date)

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

    • modifiedAt — (Date)

      Returns a timestamp for last time the profile was modified.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  transformerId: 'STRING_VALUE', /* required */
  ediType: {
    x12Details: {
      transactionSet: X12_110 | X12_180 | X12_204 | X12_210 | X12_211 | X12_214 | X12_215 | X12_259 | X12_260 | X12_266 | X12_269 | X12_270 | X12_271 | X12_274 | X12_275 | X12_276 | X12_277 | X12_278 | X12_310 | X12_315 | X12_322 | X12_404 | X12_410 | X12_417 | X12_421 | X12_426 | X12_810 | X12_820 | X12_824 | X12_830 | X12_832 | X12_834 | X12_835 | X12_837 | X12_844 | X12_846 | X12_849 | X12_850 | X12_852 | X12_855 | X12_856 | X12_860 | X12_861 | X12_864 | X12_865 | X12_869 | X12_870 | X12_940 | X12_945 | X12_990 | X12_997 | X12_999 | X12_270_X279 | X12_271_X279 | X12_275_X210 | X12_275_X211 | X12_276_X212 | X12_277_X212 | X12_277_X214 | X12_277_X364 | X12_278_X217 | X12_820_X218 | X12_820_X306 | X12_824_X186 | X12_834_X220 | X12_834_X307 | X12_834_X318 | X12_835_X221 | X12_837_X222 | X12_837_X223 | X12_837_X224 | X12_837_X291 | X12_837_X292 | X12_837_X298 | X12_999_X231,
      version: VERSION_4010 | VERSION_4030 | VERSION_5010 | VERSION_5010_HIPAA
    }
  },
  fileFormat: XML | JSON,
  mappingTemplate: 'STRING_VALUE',
  name: 'STRING_VALUE',
  sampleDocument: 'STRING_VALUE',
  status: active | inactive
};
b2bi.updateTransformer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • transformerId — (String)

    Specifies the system-assigned unique identifier for the transformer.

  • name — (String)

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

  • fileFormat — (String)

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

    Possible values include:
    • "XML"
    • "JSON"
  • mappingTemplate — (String)

    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 — (String)

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

    Possible values include:
    • "active"
    • "inactive"
  • ediType — (map)

    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.

    • x12Details — (map)

      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.

      • transactionSet — (String)

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

        Possible values include:
        • "X12_110"
        • "X12_180"
        • "X12_204"
        • "X12_210"
        • "X12_211"
        • "X12_214"
        • "X12_215"
        • "X12_259"
        • "X12_260"
        • "X12_266"
        • "X12_269"
        • "X12_270"
        • "X12_271"
        • "X12_274"
        • "X12_275"
        • "X12_276"
        • "X12_277"
        • "X12_278"
        • "X12_310"
        • "X12_315"
        • "X12_322"
        • "X12_404"
        • "X12_410"
        • "X12_417"
        • "X12_421"
        • "X12_426"
        • "X12_810"
        • "X12_820"
        • "X12_824"
        • "X12_830"
        • "X12_832"
        • "X12_834"
        • "X12_835"
        • "X12_837"
        • "X12_844"
        • "X12_846"
        • "X12_849"
        • "X12_850"
        • "X12_852"
        • "X12_855"
        • "X12_856"
        • "X12_860"
        • "X12_861"
        • "X12_864"
        • "X12_865"
        • "X12_869"
        • "X12_870"
        • "X12_940"
        • "X12_945"
        • "X12_990"
        • "X12_997"
        • "X12_999"
        • "X12_270_X279"
        • "X12_271_X279"
        • "X12_275_X210"
        • "X12_275_X211"
        • "X12_276_X212"
        • "X12_277_X212"
        • "X12_277_X214"
        • "X12_277_X364"
        • "X12_278_X217"
        • "X12_820_X218"
        • "X12_820_X306"
        • "X12_824_X186"
        • "X12_834_X220"
        • "X12_834_X307"
        • "X12_834_X318"
        • "X12_835_X221"
        • "X12_837_X222"
        • "X12_837_X223"
        • "X12_837_X224"
        • "X12_837_X291"
        • "X12_837_X292"
        • "X12_837_X298"
        • "X12_999_X231"
      • version — (String)

        Returns the version to use for the specified X12 transaction set.

         </p> 

        Possible values include:
        • "VERSION_4010"
        • "VERSION_4030"
        • "VERSION_5010"
        • "VERSION_5010_HIPAA"
  • sampleDocument — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • transformerId — (String)

      Returns the system-assigned unique identifier for the transformer.

    • transformerArn — (String)

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

    • name — (String)

      Returns the name of the transformer.

    • fileFormat — (String)

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

      Possible values include:
      • "XML"
      • "JSON"
    • mappingTemplate — (String)

      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 — (String)

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

      Possible values include:
      • "active"
      • "inactive"
    • ediType — (map)

      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.

      • x12Details — (map)

        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.

        • transactionSet — (String)

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

          Possible values include:
          • "X12_110"
          • "X12_180"
          • "X12_204"
          • "X12_210"
          • "X12_211"
          • "X12_214"
          • "X12_215"
          • "X12_259"
          • "X12_260"
          • "X12_266"
          • "X12_269"
          • "X12_270"
          • "X12_271"
          • "X12_274"
          • "X12_275"
          • "X12_276"
          • "X12_277"
          • "X12_278"
          • "X12_310"
          • "X12_315"
          • "X12_322"
          • "X12_404"
          • "X12_410"
          • "X12_417"
          • "X12_421"
          • "X12_426"
          • "X12_810"
          • "X12_820"
          • "X12_824"
          • "X12_830"
          • "X12_832"
          • "X12_834"
          • "X12_835"
          • "X12_837"
          • "X12_844"
          • "X12_846"
          • "X12_849"
          • "X12_850"
          • "X12_852"
          • "X12_855"
          • "X12_856"
          • "X12_860"
          • "X12_861"
          • "X12_864"
          • "X12_865"
          • "X12_869"
          • "X12_870"
          • "X12_940"
          • "X12_945"
          • "X12_990"
          • "X12_997"
          • "X12_999"
          • "X12_270_X279"
          • "X12_271_X279"
          • "X12_275_X210"
          • "X12_275_X211"
          • "X12_276_X212"
          • "X12_277_X212"
          • "X12_277_X214"
          • "X12_277_X364"
          • "X12_278_X217"
          • "X12_820_X218"
          • "X12_820_X306"
          • "X12_824_X186"
          • "X12_834_X220"
          • "X12_834_X307"
          • "X12_834_X318"
          • "X12_835_X221"
          • "X12_837_X222"
          • "X12_837_X223"
          • "X12_837_X224"
          • "X12_837_X291"
          • "X12_837_X292"
          • "X12_837_X298"
          • "X12_999_X231"
        • version — (String)

          Returns the version to use for the specified X12 transaction set.

           </p> 

          Possible values include:
          • "VERSION_4010"
          • "VERSION_4030"
          • "VERSION_5010"
          • "VERSION_5010_HIPAA"
    • sampleDocument — (String)

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

    • createdAt — (Date)

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

    • modifiedAt — (Date)

      Returns a timestamp for last time the transformer was modified.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.