Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

VerifyProcurementPortalValidation

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

Submits a validation code to complete the validation of a procurement portal preference. Use this operation after calling SendProcurementPortalValidation to confirm ownership and connectivity of the configured procurement portal endpoint.

Request Syntax


{
   "ClientToken": "string",
   "Code": "string",
   "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.

ClientToken

A unique, case-sensitive identifier that you provide to ensure idempotency of the request.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: \S+

Required: No

Code

The validation code received from the procurement portal in response to a previous SendProcurementPortalValidation request.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: \S+

Required: Yes

ProcurementPortalPreferenceArn

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

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


{
   "ProcurementPortalPreferenceArn": "string"
}

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.

ProcurementPortalPreferenceArn

The Amazon Resource Name (ARN) of the procurement portal preference for which validation was completed.

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]+

Errors

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

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

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

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

fieldList: The input fails to satisfy the constraints specified by an AWS 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