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 Invoicing CreateProcurementPortalPreference API operation.

Syntax

New-INVProcurementPortalPreference
-BuyerDomain <BuyerDomain>
-TestEnvPreference_BuyerDomain <BuyerDomain>
-BuyerIdentifier <String>
-TestEnvPreference_BuyerIdentifier <String>
-EinvoiceDeliveryPreference_ConnectionTestingMethod <ConnectionTestingMethod>
-Contact <Contact[]>
-EinvoiceDeliveryPreference_EinvoiceDeliveryActivationDate <DateTime>
-EinvoiceDeliveryPreference_EinvoiceDeliveryAttachmentType <String[]>
-EinvoiceDeliveryPreference_EinvoiceDeliveryDocumentType <String[]>
-EinvoiceDeliveryEnabled <Boolean>
-Selector_InvoiceUnitArn <String[]>
-ProcurementPortalInstanceEndpoint <String>
-TestEnvPreference_ProcurementPortalInstanceEndpoint <String>
-ProcurementPortalName <ProcurementPortalName>
-ProcurementPortalSharedSecret <String>
-TestEnvPreference_ProcurementPortalSharedSecret <String>
-EinvoiceDeliveryPreference_Protocol <Protocol>
-EinvoiceDeliveryPreference_PurchaseOrderDataSource <PurchaseOrderDataSource[]>
-PurchaseOrderRetrievalEnabled <Boolean>
-ResourceTag <ResourceTag[]>
-Selector_SellerOfRecord <String[]>
-SupplierDomain <SupplierDomain>
-TestEnvPreference_SupplierDomain <SupplierDomain>
-SupplierIdentifier <String>
-TestEnvPreference_SupplierIdentifier <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonInvoicingConfig>

Description

Creates a procurement portal preference configuration for e-invoice delivery and purchase order retrieval. This preference defines how invoices are delivered to a procurement portal and how purchase orders are retrieved.

Parameters

-BuyerDomain <BuyerDomain>
The domain identifier for the buyer in the procurement portal.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-BuyerIdentifier <String>
The unique identifier for the buyer in the procurement portal.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonInvoicingConfig>
Amazon.PowerShell.Cmdlets.INV.AmazonInvoicingClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive identifier that you provide to ensure idempotency of the request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Contact <Contact[]>
List of contact information for portal administrators and technical contacts responsible for the e-invoice integration. 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)
AliasesContacts
-EinvoiceDeliveryEnabled <Boolean>
Indicates whether e-invoice delivery is enabled for this procurement portal preference. Set to true to enable e-invoice delivery, false to disable.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-EinvoiceDeliveryPreference_ConnectionTestingMethod <ConnectionTestingMethod>
The method to use for testing the connection to the procurement portal.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EinvoiceDeliveryPreference_EinvoiceDeliveryActivationDate <DateTime>
The date when e-invoice delivery should be activated for this preference.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EinvoiceDeliveryPreference_EinvoiceDeliveryAttachmentType <String[]>
The types of attachments to include with the e-invoice delivery. 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)
AliasesEinvoiceDeliveryPreference_EinvoiceDeliveryAttachmentTypes
-EinvoiceDeliveryPreference_EinvoiceDeliveryDocumentType <String[]>
The types of e-invoice documents to be delivered. 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)
AliasesEinvoiceDeliveryPreference_EinvoiceDeliveryDocumentTypes
-EinvoiceDeliveryPreference_Protocol <Protocol>
The communication protocol to use for e-invoice delivery.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EinvoiceDeliveryPreference_PurchaseOrderDataSource <PurchaseOrderDataSource[]>
The sources of purchase order data to use for e-invoice generation and delivery. 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)
AliasesEinvoiceDeliveryPreference_PurchaseOrderDataSources
-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)
-ProcurementPortalInstanceEndpoint <String>
The endpoint URL where e-invoices will be delivered to the procurement portal. Must be a valid HTTPS URL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProcurementPortalName <ProcurementPortalName>
The name of the procurement portal.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProcurementPortalSharedSecret <String>
The shared secret or authentication credential used to establish secure communication with the procurement portal. This value must be encrypted at rest.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PurchaseOrderRetrievalEnabled <Boolean>
Indicates whether purchase order retrieval is enabled for this procurement portal preference. Set to true to enable PO retrieval, false to disable.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceTag <ResourceTag[]>
The tags to apply to this procurement portal preference resource. Each tag consists of a key and an optional value. 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)
AliasesResourceTags
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ProcurementPortalPreferenceArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Invoicing.Model.CreateProcurementPortalPreferenceResponse). Specifying the name of a property of type Amazon.Invoicing.Model.CreateProcurementPortalPreferenceResponse 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)
-Selector_InvoiceUnitArn <String[]>
The Amazon Resource Name (ARN) of invoice unit identifiers to which this preference applies. 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)
AliasesSelector_InvoiceUnitArns
-Selector_SellerOfRecord <String[]>
The list of seller of record IDs to which this preference applies. 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)
AliasesSelector_SellerOfRecords
-SupplierDomain <SupplierDomain>
The domain identifier for the supplier in the procurement portal.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-SupplierIdentifier <String>
The unique identifier for the supplier in the procurement portal.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-TestEnvPreference_BuyerDomain <BuyerDomain>
The domain identifier to use for the buyer in the test environment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TestEnvPreference_BuyerIdentifier <String>
The unique identifier to use for the buyer in the test environment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TestEnvPreference_ProcurementPortalInstanceEndpoint <String>
The endpoint URL where e-invoices will be delivered in the test environment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TestEnvPreference_ProcurementPortalSharedSecret <String>
The shared secret or authentication credential to use for secure communication in the test environment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TestEnvPreference_SupplierDomain <SupplierDomain>
The domain identifier to use for the supplier in the test environment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TestEnvPreference_SupplierIdentifier <String>
The unique identifier to use for the supplier in the test environment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

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

System.String or Amazon.Invoicing.Model.CreateProcurementPortalPreferenceResponse
This cmdlet returns a System.String object. The service call response (type Amazon.Invoicing.Model.CreateProcurementPortalPreferenceResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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