Skip to content

start_vpc_endpoint_service_private_dns_verification

start_vpc_endpoint_service_private_dns_verification(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    service_id: Optional[VpcEndpointServiceId] = None,
) -> StartVpcEndpointServicePrivateDnsVerificationResult

Initiates the verification process to prove that the service provider owns the private DNS name domain for the endpoint service.

The service provider must successfully perform the verification before the consumer can use the name to access the service.

Before the service provider runs this command, they must add a record to the DNS server.

Parameters:

  • dry_run (Optional[Boolean], default: None ) –

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • service_id (Optional[VpcEndpointServiceId], default: None ) –

    The ID of the endpoint service.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def start_vpc_endpoint_service_private_dns_verification(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    service_id: Optional[
        "capo_ec2.types.vpc_endpoint_service_id.VpcEndpointServiceId"
    ] = None,
) -> "capo_ec2.types.start_vpc_endpoint_service_private_dns_verification_result.StartVpcEndpointServicePrivateDnsVerificationResult":
    """<p>Initiates the verification process to prove that the service provider owns the private DNS name domain for the endpoint service.</p> <p>The service provider must successfully perform the verification before the consumer can use the name to access the service.</p> <p>Before the service provider runs this command, they must add a record to the DNS server.</p>

    Args:
        dry_run: <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        service_id: <p>The ID of the endpoint service.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.start_vpc_endpoint_service_private_dns_verification_request.StartVpcEndpointServicePrivateDnsVerificationRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.start_vpc_endpoint_service_private_dns_verification_result.StartVpcEndpointServicePrivateDnsVerificationResult"
    ]:
        import capo_ec2._operations.amazon_ec2.start_vpc_endpoint_service_private_dns_verification

        output, http_response = (
            capo_ec2._operations.amazon_ec2.start_vpc_endpoint_service_private_dns_verification.start_vpc_endpoint_service_private_dns_verification(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("StartVpcEndpointServicePrivateDnsVerification"),
    )
    input_: capo_ec2.types.start_vpc_endpoint_service_private_dns_verification_request.StartVpcEndpointServicePrivateDnsVerificationRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if service_id is not None:
        input_["service_id"] = service_id

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