AWS CLI Command Reference

[ aws . invoicing ]

get-procurement-portal-preference

Description

Retrieves the details of a specific procurement portal preference configuration.

See also: AWS API Documentation

Synopsis

  get-procurement-portal-preference
--procurement-portal-preference-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--procurement-portal-preference-arn (string) [required]

The Amazon Resource Name (ARN) of the procurement portal preference to retrieve.

Constraints:

  • min: 1
  • max: 256
  • pattern: arn:aws:invoicing::[0-9]{12}:procurement-portal-preference/[-a-zA-Z0-9]+

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

ProcurementPortalPreference -> (structure)

The detailed configuration of the requested procurement portal preference.

AwsAccountId -> (string) [required]

The Amazon Web Services account ID associated with this procurement portal preference.

Constraints:

  • pattern: \d{12}

ProcurementPortalPreferenceArn -> (string) [required]

The Amazon Resource Name (ARN) of the procurement portal preference.

Constraints:

  • min: 1
  • max: 256
  • pattern: arn:aws:invoicing::[0-9]{12}:procurement-portal-preference/[-a-zA-Z0-9]+

ProcurementPortalName -> (string) [required]

The name of the procurement portal.

Possible values:

  • SAP_BUSINESS_NETWORK
  • COUPA

BuyerDomain -> (string) [required]

The domain identifier for the buyer in the procurement portal.

Possible values:

  • NetworkID

BuyerIdentifier -> (string) [required]

The unique identifier for the buyer in the procurement portal.

Constraints:

  • min: 0
  • max: 1024
  • pattern: \S+

SupplierDomain -> (string) [required]

The domain identifier for the supplier in the procurement portal.

Possible values:

  • NetworkID

SupplierIdentifier -> (string) [required]

The unique identifier for the supplier in the procurement portal.

Constraints:

  • min: 0
  • max: 1024
  • pattern: \S+

Selector -> (structure)

Specifies criteria for selecting which invoices should be processed using a particular procurement portal preference.

InvoiceUnitArns -> (list)

The Amazon Resource Name (ARN) of invoice unit identifiers to which this preference applies.

Constraints:

  • min: 0
  • max: 500

(string)

Constraints:

  • min: 1
  • max: 256
  • pattern: arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+

SellerOfRecords -> (list)

The list of seller of record IDs to which this preference applies.

Constraints:

  • min: 0
  • max: 100

(string)

Constraints:

  • min: 0
  • max: 1024
  • pattern: \S+

ProcurementPortalSharedSecret -> (string)

The shared secret or authentication credential used for secure communication with the procurement portal.

Constraints:

  • min: 0
  • max: 1024
  • pattern: \S+

ProcurementPortalInstanceEndpoint -> (string)

The endpoint URL where e-invoices are delivered to the procurement portal.

Constraints:

  • min: 0
  • max: 1024
  • pattern: \S+

PurchaseOrderRetrievalEndpoint -> (string)

The endpoint URL used for retrieving purchase orders from the procurement portal.

Constraints:

  • min: 0
  • max: 1024
  • pattern: \S+

TestEnvPreference -> (structure)

Configuration on settings for the test environment of the procurement portal.

BuyerDomain -> (string) [required]

The domain identifier for the buyer in the test environment of the procurement portal.

Possible values:

  • NetworkID

BuyerIdentifier -> (string) [required]

The unique identifier for the buyer in the test environment of the procurement portal.

Constraints:

  • min: 0
  • max: 1024
  • pattern: \S+

SupplierDomain -> (string) [required]

The domain identifier for the supplier in the test environment of the procurement portal.

Possible values:

  • NetworkID

SupplierIdentifier -> (string) [required]

The unique identifier for the supplier in the test environment of the procurement portal.

Constraints:

  • min: 0
  • max: 1024
  • pattern: \S+

ProcurementPortalSharedSecret -> (string)

The shared secret or authentication credential used for secure communication with the test environment.

Constraints:

  • min: 0
  • max: 1024
  • pattern: \S+

ProcurementPortalInstanceEndpoint -> (string)

The endpoint URL where e-invoices are delivered in the test environment.

Constraints:

  • min: 0
  • max: 1024
  • pattern: \S+

PurchaseOrderRetrievalEndpoint -> (string)

The endpoint URL used for retrieving purchase orders in the test environment.

Constraints:

  • min: 0
  • max: 1024
  • pattern: \S+

EinvoiceDeliveryEnabled -> (boolean) [required]

Indicates whether e-invoice delivery is enabled for this procurement portal preference.

EinvoiceDeliveryPreference -> (structure)

The configuration settings that specify how e-invoices are delivered to the procurement portal.

EinvoiceDeliveryDocumentTypes -> (list) [required]

The types of e-invoice documents to be delivered.

Constraints:

  • min: 0
  • max: 10

(string)

Possible values:

  • AWS_CLOUD_INVOICE
  • AWS_CLOUD_CREDIT_MEMO
  • AWS_MARKETPLACE_INVOICE
  • AWS_MARKETPLACE_CREDIT_MEMO
  • AWS_REQUEST_FOR_PAYMENT

EinvoiceDeliveryAttachmentTypes -> (list)

The types of attachments to include with the e-invoice delivery.

(string)

Possible values:

  • INVOICE_PDF
  • RFP_PDF

Protocol -> (string) [required]

The communication protocol to use for e-invoice delivery.

Possible values:

  • CXML

PurchaseOrderDataSources -> (list) [required]

The sources of purchase order data to use for e-invoice generation and delivery.

(structure)

Specifies the source configuration for retrieving purchase order data.

EinvoiceDeliveryDocumentType -> (string)

The type of e-invoice document that requires purchase order data.

Possible values:

  • AWS_CLOUD_INVOICE
  • AWS_CLOUD_CREDIT_MEMO
  • AWS_MARKETPLACE_INVOICE
  • AWS_MARKETPLACE_CREDIT_MEMO
  • AWS_REQUEST_FOR_PAYMENT

PurchaseOrderDataSourceType -> (string)

The type of source for purchase order data.

Possible values:

  • ASSOCIATED_PURCHASE_ORDER_REQUIRED
  • PURCHASE_ORDER_NOT_REQUIRED

ConnectionTestingMethod -> (string) [required]

The method to use for testing the connection to the procurement portal.

Possible values:

  • PROD_ENV_DOLLAR_TEST
  • TEST_ENV_REPLAY_TEST

EinvoiceDeliveryActivationDate -> (timestamp) [required]

The date when e-invoice delivery should be activated for this preference.

PurchaseOrderRetrievalEnabled -> (boolean) [required]

Indicates whether purchase order retrieval is enabled for this procurement portal preference.

Contacts -> (list)

List of contact information for portal administrators and technical contacts.

Constraints:

  • min: 1
  • max: 1

(structure)

Represents contact information for a person or role associated with the procurement portal preference.

Name -> (string)

The name of the contact person or role.

Constraints:

  • min: 0
  • max: 1024
  • pattern: [\s\S]*

Email -> (string)

The email address of the contact person or role.

Constraints:

  • min: 1
  • max: 1024
  • pattern: [a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}

EinvoiceDeliveryPreferenceStatus -> (string)

The current status of the e-invoice delivery preference.

Possible values:

  • PENDING_VERIFICATION
  • TEST_INITIALIZED
  • TEST_INITIALIZATION_FAILED
  • TEST_FAILED
  • ACTIVE
  • SUSPENDED

EinvoiceDeliveryPreferenceStatusReason -> (string)

The reason for the current e-invoice delivery preference status.

Constraints:

  • min: 0
  • max: 1024
  • pattern: [\s\S]*

PurchaseOrderRetrievalPreferenceStatus -> (string)

The current status of the purchase order retrieval preference.

Possible values:

  • PENDING_VERIFICATION
  • TEST_INITIALIZED
  • TEST_INITIALIZATION_FAILED
  • TEST_FAILED
  • ACTIVE
  • SUSPENDED

PurchaseOrderRetrievalPreferenceStatusReason -> (string)

The reason for the current purchase order retrieval preference status.

Constraints:

  • min: 0
  • max: 1024
  • pattern: [\s\S]*

Version -> (long) [required]

The version number of the procurement portal preference configuration.

CreateDate -> (timestamp) [required]

The date and time when the procurement portal preference was created.

LastUpdateDate -> (timestamp) [required]

The date and time when the procurement portal preference was last updated.
© Copyright 2025, Amazon Web Services. Created using Sphinx.