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 UpdateTransformer API operation.

Syntax

Update-B2BITransformer
-TransformerId <String>
-SampleDocuments_BucketName <String>
-InputConversion_FromFormat <FromFormat>
-SampleDocuments_Key <SampleDocumentKeys[]>
-Name <String>
-Status <TransformerStatus>
-Mapping_Template <String>
-Mapping_TemplateLanguage <MappingTemplateLanguage>
-OutputConversion_ToFormat <ToFormat>
-X12Details_TransactionSet <X12TransactionSet>
-InputConversion_FormatOptions_X12_TransactionSet <X12TransactionSet>
-OutputConversion_FormatOptions_X12_TransactionSet <X12TransactionSet>
-X12Details_Version <X12Version>
-InputConversion_FormatOptions_X12_Version <X12Version>
-OutputConversion_FormatOptions_X12_Version <X12Version>
-FileFormat <FileFormat>
-MappingTemplate <String>
-SampleDocument <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonB2biConfig>

Description

Updates the specified parameters for a transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.

Parameters

-ClientConfig <AmazonB2biConfig>
Amazon.PowerShell.Cmdlets.B2BI.AmazonB2biClientCmdlet.ClientConfig
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_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>
Specify a new name for the transformer, if you want to update it.
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)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the TransformerId parameter. The -PassThru parameter is deprecated, use -Select '^TransformerId' instead. This parameter will be removed in a future version.
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.
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.UpdateTransformerResponse). Specifying the name of a property of type Amazon.B2bi.Model.UpdateTransformerResponse 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)
-Status <TransformerStatus>
Specifies the transformer's status. You can update the state of the transformer, from active to inactive, or inactive to active.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TransformerId <String>
Specifies the system-assigned unique identifier for the transformer.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-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.UpdateTransformerResponse
This cmdlet returns an Amazon.B2bi.Model.UpdateTransformerResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

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