AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS B2B Data Interchange CreateTransformer API operation.

Syntax

New-B2BITransformer
-SampleDocuments_BucketName <String>
-InputConversion_FromFormat <FromFormat>
-SampleDocuments_Key <SampleDocumentKeys[]>
-Name <String>
-InputConversion_AdvancedOptions_X12_SplitOptions_SplitBy <X12SplitBy>
-OutputConversion_AdvancedOptions_X12_SplitOptions_SplitBy <X12SplitBy>
-Tag <Tag[]>
-Mapping_Template <String>
-Mapping_TemplateLanguage <MappingTemplateLanguage>
-OutputConversion_ToFormat <ToFormat>
-X12Details_TransactionSet <X12TransactionSet>
-InputConversion_FormatOptions_X12_TransactionSet <X12TransactionSet>
-OutputConversion_FormatOptions_X12_TransactionSet <X12TransactionSet>
-InputConversion_AdvancedOptions_X12_ValidationOptions_ValidationRules <X12ValidationRule[]>
-OutputConversion_AdvancedOptions_X12_ValidationOptions_ValidationRules <X12ValidationRule[]>
-X12Details_Version <X12Version>
-InputConversion_FormatOptions_X12_Version <X12Version>
-OutputConversion_FormatOptions_X12_Version <X12Version>
-ClientToken <String>
-FileFormat <FileFormat>
-MappingTemplate <String>
-SampleDocument <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonB2biConfig>

Description

Creates a transformer. Amazon Web Services B2B Data Interchange currently supports two scenarios:
  • Inbound EDI: the Amazon Web Services customer receives an EDI file from their trading partner. Amazon Web Services B2B Data Interchange converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer, in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires.
  • Outbound EDI: the Amazon Web Services customer has a JSON or XML file containing data that they wish to use in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.
The following fields are provided for backwards compatibility only: fileFormat, mappingTemplate, ediType, and sampleDocument.
  • Use the mapping data type in place of mappingTemplate and fileFormat
  • Use the sampleDocuments data type in place of sampleDocument
  • Use either the inputConversion or outputConversion in place of ediType

Parameters

-ClientConfig <AmazonB2biConfig>
Amazon.PowerShell.Cmdlets.B2BI.AmazonB2biClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
Reserved for future use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FileFormat <FileFormat>
Specifies that the currently supported file formats for EDI transformations are JSON and XML.This parameter is deprecated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InputConversion_AdvancedOptions_X12_SplitOptions_SplitBy <X12SplitBy>
Specifies the method used to split X12 EDI files. Valid values include TRANSACTION (split by individual transaction sets), or NONE (no splitting).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSplitOptions_SplitBy
-InputConversion_AdvancedOptions_X12_ValidationOptions_ValidationRules <X12ValidationRule[]>
Specifies a list of validation rules to apply during EDI document processing. These rules can include code list modifications, element length constraints, and element requirement changes. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InputConversion_FormatOptions_X12_TransactionSet <X12TransactionSet>
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InputConversion_FormatOptions_X12_Version <X12Version>
Returns the version to use for the specified X12 transaction set.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InputConversion_FromFormat <FromFormat>
The format for the transformer input: currently on X12 is supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Mapping_Template <String>
A string that represents the mapping template, in the transformation language specified in templateLanguage.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Mapping_TemplateLanguage <MappingTemplateLanguage>
The transformation language for the template, either XSLT or JSONATA.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MappingTemplate <String>
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.This parameter is available for backwards compatibility. Use the Mapping data type instead.This parameter is deprecated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
Specifies the name of the transformer, used to identify it.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputConversion_AdvancedOptions_X12_SplitOptions_SplitBy <X12SplitBy>
Specifies the method used to split X12 EDI files. Valid values include TRANSACTION (split by individual transaction sets), or NONE (no splitting).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputConversion_AdvancedOptions_X12_ValidationOptions_ValidationRules <X12ValidationRule[]>
Specifies a list of validation rules to apply during EDI document processing. These rules can include code list modifications, element length constraints, and element requirement changes. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputConversion_FormatOptions_X12_TransactionSet <X12TransactionSet>
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputConversion_FormatOptions_X12_Version <X12Version>
Returns the version to use for the specified X12 transaction set.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputConversion_ToFormat <ToFormat>
The format for the output from an outbound transformer: only X12 is currently supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SampleDocument <String>
Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.This parameter is deprecated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SampleDocuments_BucketName <String>
Contains the Amazon S3 bucket that is used to hold your sample documents.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SampleDocuments_Key <SampleDocumentKeys[]>
Contains an array of the Amazon S3 keys used to identify the location for your sample documents. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSampleDocuments_Keys
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.B2bi.Model.CreateTransformerResponse). Specifying the name of a property of type Amazon.B2bi.Model.CreateTransformerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-X12Details_TransactionSet <X12TransactionSet>
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEdiType_X12Details_TransactionSet
-X12Details_Version <X12Version>
Returns the version to use for the specified X12 transaction set.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEdiType_X12Details_Version

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.B2bi.Model.CreateTransformerResponse
This cmdlet returns an Amazon.B2bi.Model.CreateTransformerResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z