Skip to content

start_verification

start_verification(
    *,
    config_overrides: Optional[PartnerCentralAccountClientConfig] = None,
    client_token: Optional[ClientToken] = None,
    verification_details: Optional[VerificationDetails] = None,
) -> StartVerificationResponse

Initiates a new verification process for a partner account. This operation begins the verification workflow for either business registration or individual registrant identity verification as required by AWS Partner Central.

Parameters:

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This prevents duplicate verification processes from being started accidentally.

  • verification_details (Optional[VerificationDetails], default: None ) –

    The specific details required for the verification process, including business information for business verification or personal information for registrant verification.

Raises:

  • AccessDeniedException –

    The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.

  • ConflictException –

    The request could not be completed due to a conflict with the current state of the resource. This typically occurs when trying to create a resource that already exists or modify a resource that has been changed by another process.

  • InternalServerException –

    An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.

  • ServiceQuotaExceededException –

    The request was rejected because it would exceed a service quota or limit. This may occur when trying to create more resources than allowed by the service limits.

  • ThrottlingException –

    The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.

  • ValidationException –

    The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_partnercentral_account/_services/partner_central_account.py
def start_verification(
    self,
    *,
    config_overrides: Optional[PartnerCentralAccountClientConfig] = None,
    client_token: Optional[
        "capo_partnercentral_account.types.client_token.ClientToken"
    ] = None,
    verification_details: Optional[
        "capo_partnercentral_account.types.verification_details.VerificationDetails"
    ] = None,
) -> "capo_partnercentral_account.types.start_verification_response.StartVerificationResponse":
    """<p>Initiates a new verification process for a partner account. This operation begins the verification workflow for either business registration or individual registrant identity verification as required by AWS Partner Central.</p>

    Args:
        client_token: <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This prevents duplicate verification processes from being started accidentally.</p>
        verification_details: <p>The specific details required for the verification process, including business information for business verification or personal information for registrant verification.</p>

    Raises:
        capo_partnercentral_account.errors.access_denied_exception.AccessDeniedException: <p>The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.</p>
        capo_partnercentral_account.errors.conflict_exception.ConflictException: <p>The request could not be completed due to a conflict with the current state of the resource. This typically occurs when trying to create a resource that already exists or modify a resource that has been changed by another process.</p>
        capo_partnercentral_account.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.</p>
        capo_partnercentral_account.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request was rejected because it would exceed a service quota or limit. This may occur when trying to create more resources than allowed by the service limits.</p>
        capo_partnercentral_account.errors.throttling_exception.ThrottlingException: <p>The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.</p>
        capo_partnercentral_account.errors.validation_exception.ValidationException: <p>The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.</p>
        capo_partnercentral_account.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_partnercentral_account.types.start_verification_request.StartVerificationRequest]",
    ) -> OperationResponse[
        "capo_partnercentral_account.types.start_verification_response.StartVerificationResponse"
    ]:
        import capo_partnercentral_account._operations.partner_central_account.start_verification

        output, http_response = (
            capo_partnercentral_account._operations.partner_central_account.start_verification.start_verification(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_partnercentral_account.types.start_verification_request.StartVerificationRequest",
    ) -> dict[str, Any]:
        import capo_partnercentral_account.types.start_verification_request

        return capo_partnercentral_account.types.start_verification_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_partnercentral_account.types.start_verification_response.StartVerificationResponse",
    ) -> dict[str, Any]:
        import capo_partnercentral_account.types.start_verification_response

        return capo_partnercentral_account.types.start_verification_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "StartVerification",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_partnercentral_account.types.start_verification_request.StartVerificationRequest = {}
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if verification_details is not None:
        input_["verification_details"] = verification_details

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