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>
-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>
-Tag <Tag[]>
-InterchangeControlHeaders_UsageIndicatorCode <String>
-Common_ValidateEdi <Boolean>
-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

-Capability <String[]>
Specifies a list of the capabilities associated with this partnership.
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_ValidateEdi <Boolean>
Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCapabilityOptions_OutboundEdi_X12_Common_ValidateEdi
-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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

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