Skip to content

start_domain_verification

start_domain_verification(
    domain_name: DomainName,
    *,
    config_overrides: Optional[VPCLatticeClientConfig] = None,
    client_token: Optional[ClientToken] = None,
    tags: Optional[TagMap] = None,
) -> StartDomainVerificationResponse

Starts the domain verification process for a custom domain name.

Parameters:

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

  • domain_name (DomainName) –

    The domain name to verify ownership for.

  • tags (Optional[TagMap], default: None ) –

    The tags for the domain verification.

Raises:

Source code in docs_src/capo_vpc_lattice/_services/vpc_lattice.py
def start_domain_verification(
    self,
    domain_name: "capo_vpc_lattice.types.domain_name.DomainName",
    *,
    config_overrides: Optional[VPCLatticeClientConfig] = None,
    client_token: Optional[
        "capo_vpc_lattice.types.client_token.ClientToken"
    ] = None,
    tags: Optional["capo_vpc_lattice.types.tag_map.TagMap"] = None,
) -> "capo_vpc_lattice.types.start_domain_verification_response.StartDomainVerificationResponse":
    """<p> Starts the domain verification process for a custom domain name. </p>

    Args:
        client_token: <p> A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails. </p>
        domain_name: <p> The domain name to verify ownership for. </p>
        tags: <p> The tags for the domain verification. </p>

    Raises:
        capo_vpc_lattice.errors.access_denied_exception.AccessDeniedException: <p>The user does not have sufficient access to perform this action.</p>
        capo_vpc_lattice.errors.conflict_exception.ConflictException: <p>The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.</p>
        capo_vpc_lattice.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred while processing the request.</p>
        capo_vpc_lattice.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request would cause a service quota to be exceeded.</p>
        capo_vpc_lattice.errors.throttling_exception.ThrottlingException: <p>The limit on the number of requests per second was exceeded.</p>
        capo_vpc_lattice.errors.validation_exception.ValidationException: <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_vpc_lattice.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_vpc_lattice.types.start_domain_verification_request.StartDomainVerificationRequest]",
    ) -> OperationResponse[
        "capo_vpc_lattice.types.start_domain_verification_response.StartDomainVerificationResponse"
    ]:
        import capo_vpc_lattice._operations.mercury_control_plane.start_domain_verification

        output, http_response = (
            capo_vpc_lattice._operations.mercury_control_plane.start_domain_verification.start_domain_verification(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartDomainVerification")
    )
    input_: capo_vpc_lattice.types.start_domain_verification_request.StartDomainVerificationRequest = {
        "domain_name": domain_name
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if tags is not None:
        input_["tags"] = tags

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