UpdateProcurementPortalPreferenceStatus
This feature API is subject to changing at any time. For more information, see the Amazon Service Terms
Updates the status of a procurement portal preference, including the activation state of e-invoice delivery and purchase order retrieval features.
Request Syntax
{
"EinvoiceDeliveryPreferenceStatus": "string",
"EinvoiceDeliveryPreferenceStatusReason": "string",
"ProcurementPortalPreferenceArn": "string",
"PurchaseOrderRetrievalPreferenceStatus": "string",
"PurchaseOrderRetrievalPreferenceStatusReason": "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.
- EinvoiceDeliveryPreferenceStatus
-
The updated status of the e-invoice delivery preference.
Type: String
Valid Values:
PENDING_VERIFICATION | TEST_INITIALIZED | TEST_INITIALIZATION_FAILED | TEST_FAILED | ACTIVE | SUSPENDEDRequired: No
- EinvoiceDeliveryPreferenceStatusReason
-
The reason for the e-invoice delivery preference status update, providing context for the change.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\s\S]*Required: No
- ProcurementPortalPreferenceArn
-
The Amazon Resource Name (ARN) of the procurement portal preference to update.
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
- PurchaseOrderRetrievalPreferenceStatus
-
The updated status of the purchase order retrieval preference.
Type: String
Valid Values:
PENDING_VERIFICATION | TEST_INITIALIZED | TEST_INITIALIZATION_FAILED | TEST_FAILED | ACTIVE | SUSPENDEDRequired: No
- PurchaseOrderRetrievalPreferenceStatusReason
-
The reason for the purchase order retrieval preference status update, providing context for the change.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\s\S]*Required: No
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 with updated status.
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 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
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: