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

Syntax

New-B2BIPartnership
-InterchangeControlHeaders_AcknowledgmentRequestedCode <String>
-FunctionalGroupHeaders_ApplicationReceiverCode <String>
-FunctionalGroupHeaders_ApplicationSenderCode <String>
-Capability <String[]>
-Delimiters_ComponentSeparator <String>
-Delimiters_DataElementSeparator <String>
-Email <String>
-AcknowledgmentOptions_FunctionalAcknowledgment <X12FunctionalAcknowledgment>
-Common_Gs05TimeFormat <X12GS05TimeFormat>
-WrapOptions_LineLength <Int32>
-WrapOptions_LineTerminator <LineTerminator>
-Name <String>
-Phone <String>
-ProfileId <String>
-InterchangeControlHeaders_ReceiverId <String>
-InterchangeControlHeaders_ReceiverIdQualifier <String>
-InterchangeControlHeaders_RepetitionSeparator <String>
-FunctionalGroupHeaders_ResponsibleAgencyCode <String>
-Delimiters_SegmentTerminator <String>
-InterchangeControlHeaders_SenderId <String>
-InterchangeControlHeaders_SenderIdQualifier <String>
-ControlNumbers_StartingFunctionalGroupControlNumber <Int32>
-ControlNumbers_StartingInterchangeControlNumber <Int32>
-ControlNumbers_StartingTransactionSetControlNumber <Int32>
-Tag <Tag[]>
-AcknowledgmentOptions_TechnicalAcknowledgment <X12TechnicalAcknowledgment>
-InterchangeControlHeaders_UsageIndicatorCode <String>
-Common_ValidateEdi <Boolean>
-WrapOptions_WrapBy <WrapFormat>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonB2biConfig>

Description

Creates a partnership between a customer and a trading partner, based on the supplied parameters. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

Parameters

-AcknowledgmentOptions_FunctionalAcknowledgment <X12FunctionalAcknowledgment>
Specifies whether functional acknowledgments (997/999) should be generated for incoming X12 transactions. Valid values are DO_NOT_GENERATE, GENERATE_ALL_SEGMENTS and GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP.If you choose GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP, Amazon Web Services B2B Data Interchange skips the AK2_Loop when generating an acknowledgment document.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_InboundEdi_X12_AcknowledgmentOptions_FunctionalAcknowledgment
-AcknowledgmentOptions_TechnicalAcknowledgment <X12TechnicalAcknowledgment>
Specifies whether technical acknowledgments (TA1) should be generated for incoming X12 interchanges. Valid values are DO_NOT_GENERATE and GENERATE_ALL_SEGMENTS and.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_InboundEdi_X12_AcknowledgmentOptions_TechnicalAcknowledgment
-Capability <String[]>
Specifies a list of the capabilities associated with this partnership. 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?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilities
-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)
-Common_Gs05TimeFormat <X12GS05TimeFormat>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_OutboundEdi_X12_Common_Gs05TimeFormat
-Common_ValidateEdi <Boolean>
Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE. When enabled, this performs both standard EDI validation and applies any configured custom validation rules including element length constraints, code list validations, and element requirement checks. Validation results are returned in the response validation messages.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_OutboundEdi_X12_Common_ValidateEdi
-ControlNumbers_StartingFunctionalGroupControlNumber <Int32>
Specifies the starting functional group control number (GS06) to use for X12 EDI generation. This number is incremented for each new functional group. For the GS (functional group) envelope, Amazon Web Services B2B Data Interchange generates a functional group control number that is unique to the sender ID, receiver ID, and functional identifier code combination.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_OutboundEdi_X12_Common_ControlNumbers_StartingFunctionalGroupControlNumber
-ControlNumbers_StartingInterchangeControlNumber <Int32>
Specifies the starting interchange control number (ISA13) to use for X12 EDI generation. This number is incremented for each new interchange. For the ISA (interchange) envelope, Amazon Web Services B2B Data Interchange generates an interchange control number that is unique for the ISA05 and ISA06 (sender) & ISA07 and ISA08 (receiver) combination.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_OutboundEdi_X12_Common_ControlNumbers_StartingInterchangeControlNumber
-ControlNumbers_StartingTransactionSetControlNumber <Int32>
Specifies the starting transaction set control number (ST02) to use for X12 EDI generation. This number is incremented for each new transaction set.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_OutboundEdi_X12_Common_ControlNumbers_StartingTransactionSetControlNumber
-Delimiters_ComponentSeparator <String>
The component, or sub-element, separator. The default value is : (colon).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_OutboundEdi_X12_Common_Delimiters_ComponentSeparator
-Delimiters_DataElementSeparator <String>
The data element separator. The default value is * (asterisk).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_OutboundEdi_X12_Common_Delimiters_DataElementSeparator
-Delimiters_SegmentTerminator <String>
The segment terminator. The default value is ~ (tilde).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_OutboundEdi_X12_Common_Delimiters_SegmentTerminator
-Email <String>
Specifies the email address associated with this trading partner.
Required?True
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)
-FunctionalGroupHeaders_ApplicationReceiverCode <String>
A value representing the code used to identify the party receiving a message, at position GS-03.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_OutboundEdi_X12_Common_FunctionalGroupHeaders_ApplicationReceiverCode
-FunctionalGroupHeaders_ApplicationSenderCode <String>
A value representing the code used to identify the party transmitting a message, at position GS-02.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_OutboundEdi_X12_Common_FunctionalGroupHeaders_ApplicationSenderCode
-FunctionalGroupHeaders_ResponsibleAgencyCode <String>
A code that identifies the issuer of the standard, at position GS-07.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_OutboundEdi_X12_Common_FunctionalGroupHeaders_ResponsibleAgencyCode
-InterchangeControlHeaders_AcknowledgmentRequestedCode <String>
Located at position ISA-14 in the header. The value "1" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value "0" is used otherwise.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_OutboundEdi_X12_Common_InterchangeControlHeaders_AcknowledgmentRequestedCode
-InterchangeControlHeaders_ReceiverId <String>
Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_OutboundEdi_X12_Common_InterchangeControlHeaders_ReceiverId
-InterchangeControlHeaders_ReceiverIdQualifier <String>
Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_OutboundEdi_X12_Common_InterchangeControlHeaders_ReceiverIdQualifier
-InterchangeControlHeaders_RepetitionSeparator <String>
Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.This parameter is only honored for version greater than 401 (VERSION_4010 and higher).For versions less than 401, this field is called StandardsId, in which case our service sets the value to U.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_OutboundEdi_X12_Common_InterchangeControlHeaders_RepetitionSeparator
-InterchangeControlHeaders_SenderId <String>
Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_OutboundEdi_X12_Common_InterchangeControlHeaders_SenderId
-InterchangeControlHeaders_SenderIdQualifier <String>
Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_OutboundEdi_X12_Common_InterchangeControlHeaders_SenderIdQualifier
-InterchangeControlHeaders_UsageIndicatorCode <String>
Located at position ISA-15 in the header. Specifies how this interchange is being used:
  • T indicates this interchange is for testing.
  • P indicates this interchange is for production.
  • I indicates this interchange is informational.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_OutboundEdi_X12_Common_InterchangeControlHeaders_UsageIndicatorCode
-Name <String>
Specifies a descriptive name for the partnership.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Phone <String>
Specifies the phone number associated with the partnership.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProfileId <String>
Specifies the unique, system-generated identifier for the profile connected to this partnership.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.CreatePartnershipResponse). Specifying the name of a property of type Amazon.B2bi.Model.CreatePartnershipResponse 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
-WrapOptions_LineLength <Int32>
Specifies the maximum length of a line before wrapping occurs. This value is used when wrapBy is set to LINE_LENGTH.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_OutboundEdi_X12_WrapOptions_LineLength
-WrapOptions_LineTerminator <LineTerminator>
Specifies the character sequence used to terminate lines when wrapping. Valid values:
  • CRLF: carriage return and line feed
  • LF: line feed)
  • CR: carriage return
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_OutboundEdi_X12_WrapOptions_LineTerminator
-WrapOptions_WrapBy <WrapFormat>
Specifies the method used for wrapping lines in the EDI output. Valid values:
  • SEGMENT: Wraps by segment.
  • ONE_LINE: Indicates that the entire content is on a single line.When you specify ONE_LINE, do not provide either the line length nor the line terminator value.
  • LINE_LENGTH: Wraps by character count, as specified by lineLength value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_OutboundEdi_X12_WrapOptions_WrapBy

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.CreatePartnershipResponse
This cmdlet returns an Amazon.B2bi.Model.CreatePartnershipResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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