Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . b2bi ]

update-transformer

Description

Updates the specified parameters for a transformer. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.

See also: AWS API Documentation

Synopsis

  update-transformer
--transformer-id <value>
[--name <value>]
[--file-format <value>]
[--mapping-template <value>]
[--status <value>]
[--edi-type <value>]
[--sample-document <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--transformer-id (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.

--file-format (string)

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

Possible values:

  • XML
  • JSON

--mapping-template (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:

  • active
  • inactive

--edi-type (tagged union structure)

Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: x12Details.

x12Details -> (structure)

Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

transactionSet -> (string)

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

version -> (string)

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

Shorthand Syntax:

x12Details={transactionSet=string,version=string}

JSON Syntax:

{
  "x12Details": {
    "transactionSet": "X12_110"|"X12_180"|"X12_204"|"X12_210"|"X12_214"|"X12_215"|"X12_310"|"X12_315"|"X12_322"|"X12_404"|"X12_410"|"X12_820"|"X12_824"|"X12_830"|"X12_846"|"X12_850"|"X12_852"|"X12_855"|"X12_856"|"X12_860"|"X12_861"|"X12_864"|"X12_940"|"X12_990"|"X12_997",
    "version": "VERSION_4010"|"VERSION_4030"|"VERSION_5010"
  }
}

--sample-document (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

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 .

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 .

ediType -> (tagged union structure)

Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: x12Details.

x12Details -> (structure)

Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

transactionSet -> (string)

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

version -> (string)

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

sampleDocument -> (string)

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

createdAt -> (timestamp)

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

modifiedAt -> (timestamp)

Returns a timestamp for last time the transformer was modified.