Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetProcurementPortalPreference

This feature API is subject to changing at any time. For more information, see the Amazon Service Terms (Betas and Previews).

Retrieves the details of a specific procurement portal preference configuration.

Request Syntax


{
   "ProcurementPortalPreferenceArn": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ProcurementPortalPreferenceArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: arn:aws:invoicing::[0-9]{12}:procurement-portal-preference/[-a-zA-Z0-9]+

Required: Yes

Response Syntax


{
   "ProcurementPortalPreference": { 
      "AwsAccountId": "string",
      "BuyerDomain": "string",
      "BuyerIdentifier": "string",
      "Contacts": [ 
         { 
            "Email": "string",
            "Name": "string"
         }
      ],
      "CreateDate": number,
      "EinvoiceDeliveryEnabled": boolean,
      "EinvoiceDeliveryPreference": { 
         "ConnectionTestingMethod": "string",
         "EinvoiceDeliveryActivationDate": number,
         "EinvoiceDeliveryAttachmentTypes": [ "string" ],
         "EinvoiceDeliveryDocumentTypes": [ "string" ],
         "Protocol": "string",
         "PurchaseOrderDataSources": [ 
            { 
               "EinvoiceDeliveryDocumentType": "string",
               "PurchaseOrderDataSourceType": "string"
            }
         ]
      },
      "EinvoiceDeliveryPreferenceStatus": "string",
      "EinvoiceDeliveryPreferenceStatusReason": "string",
      "LastUpdateDate": number,
      "ProcurementPortalInstanceEndpoint": "string",
      "ProcurementPortalName": "string",
      "ProcurementPortalPreferenceArn": "string",
      "ProcurementPortalSharedSecret": "string",
      "PurchaseOrderRetrievalEnabled": boolean,
      "PurchaseOrderRetrievalEndpoint": "string",
      "PurchaseOrderRetrievalPreferenceStatus": "string",
      "PurchaseOrderRetrievalPreferenceStatusReason": "string",
      "Selector": { 
         "InvoiceUnitArns": [ "string" ],
         "SellerOfRecords": [ "string" ]
      },
      "SupplierDomain": "string",
      "SupplierIdentifier": "string",
      "TestEnvPreference": { 
         "BuyerDomain": "string",
         "BuyerIdentifier": "string",
         "ProcurementPortalInstanceEndpoint": "string",
         "ProcurementPortalSharedSecret": "string",
         "PurchaseOrderRetrievalEndpoint": "string",
         "SupplierDomain": "string",
         "SupplierIdentifier": "string"
      },
      "Version": number
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ProcurementPortalPreference

The detailed configuration of the requested procurement portal preference.

Type: ProcurementPortalPreference object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient access to perform this action.

resourceName: You don't have sufficient access to perform this action.

HTTP Status Code: 400

ConflictException

The request could not be completed due to a conflict with the current state of the resource. This exception occurs when a concurrent modification is detected during an update operation, or when attempting to create a resource that already exists.

resourceId: The identifier of the resource that caused the conflict.
resourceType: The type of resource that caused the conflict.

HTTP Status Code: 400

InternalServerException

The processing request failed because of an unknown error, exception, or failure.

retryAfterSeconds: The processing request failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource could not be found.

resourceName: The resource could not be found.

HTTP Status Code: 400

ServiceQuotaExceededException

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an Amazon Web Services service.

fieldList: The input fails to satisfy the constraints specified by an Amazon Web Services service.
reason: You don't have sufficient access to perform this action.
resourceName: You don't have sufficient access to perform this action.

HTTP Status Code: 400