Skip to content

verify_procurement_portal_validation

verify_procurement_portal_validation(
    procurement_portal_preference_arn: ProcurementPortalPreferenceArnString,
    code: BasicStringWithoutSpace,
    *,
    config_overrides: Optional[InvoicingClientConfig] = None,
    client_token: Optional[BasicStringWithoutSpace] = None,
) -> VerifyProcurementPortalValidationResponse

This feature API is subject to changing at any time. For more information, see the Amazon Web Services 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.

Parameters:

  • procurement_portal_preference_arn (ProcurementPortalPreferenceArnString) –

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

  • code (BasicStringWithoutSpace) –

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

  • client_token (Optional[BasicStringWithoutSpace], default: None ) –

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

Raises:

Examples:

VerifyProcurementPortalValidation call

>>> client.verify_procurement_portal_validation(procurement_portal_preference_arn='arn:aws:invoicing::111111111111:procurement-portal-preference/f71dd02e-f855-4b13-b793-0fd25c0b3ecd', code='validation-code-123')
Source code in docs_src/capo_invoicing/_services/invoicing.py
def verify_procurement_portal_validation(
    self,
    procurement_portal_preference_arn: "capo_invoicing.types.procurement_portal_preference_arn_string.ProcurementPortalPreferenceArnString",
    code: "capo_invoicing.types.basic_string_without_space.BasicStringWithoutSpace",
    *,
    config_overrides: Optional[InvoicingClientConfig] = None,
    client_token: Optional[
        "capo_invoicing.types.basic_string_without_space.BasicStringWithoutSpace"
    ] = None,
) -> "capo_invoicing.types.verify_procurement_portal_validation_response.VerifyProcurementPortalValidationResponse":
    """<p> <i> <b>This feature API is subject to changing at any time. For more information, see the <a href="https://aws.amazon.com/service-terms/">Amazon Web Services Service Terms</a> (Betas and Previews).</b> </i> </p> <p>Submits a validation code to complete the validation of a procurement portal preference. Use this operation after calling <code>SendProcurementPortalValidation</code> to confirm ownership and connectivity of the configured procurement portal endpoint.</p>

    Args:
        procurement_portal_preference_arn: <p>The Amazon Resource Name (ARN) of the procurement portal preference to validate.</p>
        code: <p>The validation code received from the procurement portal in response to a previous <code>SendProcurementPortalValidation</code> request.</p>
        client_token: <p>A unique, case-sensitive identifier that you provide to ensure idempotency of the request.</p>

    Raises:
        capo_invoicing.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action.</p>
        capo_invoicing.errors.internal_server_exception.InternalServerException: <p>The processing request failed because of an unknown error, exception, or failure. </p>
        capo_invoicing.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found. </p>
        capo_invoicing.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_invoicing.errors.validation_exception.ValidationException: <p> The input fails to satisfy the constraints specified by an Amazon Web Services service. </p>
        capo_invoicing.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        VerifyProcurementPortalValidation call

        >>> client.verify_procurement_portal_validation(procurement_portal_preference_arn='arn:aws:invoicing::111111111111:procurement-portal-preference/f71dd02e-f855-4b13-b793-0fd25c0b3ecd', code='validation-code-123')
    """

    def _handler(
        req: "OperationRequest[capo_invoicing.types.verify_procurement_portal_validation_request.VerifyProcurementPortalValidationRequest]",
    ) -> OperationResponse[
        "capo_invoicing.types.verify_procurement_portal_validation_response.VerifyProcurementPortalValidationResponse"
    ]:
        import capo_invoicing._operations.invoicing.verify_procurement_portal_validation

        output, http_response = (
            capo_invoicing._operations.invoicing.verify_procurement_portal_validation.verify_procurement_portal_validation(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("VerifyProcurementPortalValidation")
    )
    input_: capo_invoicing.types.verify_procurement_portal_validation_request.VerifyProcurementPortalValidationRequest = {
        "procurement_portal_preference_arn": procurement_portal_preference_arn,
        "code": code,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output