Skip to content

start_vpc_endpoint_service_private_dns_verification

Operation

start_vpc_endpoint_service_private_dns_verification

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:

Name Type Description Default
request StartVpcEndpointServicePrivateDnsVerificationInput | StartVpcEndpointServicePrivateDnsVerificationInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[StartVpcEndpointServicePrivateDnsVerificationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StartVpcEndpointServicePrivateDnsVerificationOutput

An instance of StartVpcEndpointServicePrivateDnsVerificationOutput.

start_vpc_endpoint_service_private_dns_verification async

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:

Name Type Description Default
request StartVpcEndpointServicePrivateDnsVerificationInput | StartVpcEndpointServicePrivateDnsVerificationInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[StartVpcEndpointServicePrivateDnsVerificationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StartVpcEndpointServicePrivateDnsVerificationOutput

An instance of StartVpcEndpointServicePrivateDnsVerificationOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

StartVpcEndpointServicePrivateDnsVerificationInputDict

Bases: TypedDict

Dictionary form of StartVpcEndpointServicePrivateDnsVerificationInput.

Attributes

dry_run instance-attribute
dry_run: bool | 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 instance-attribute
service_id: Required[str]

The ID of the endpoint service.

StartVpcEndpointServicePrivateDnsVerificationInput dataclass

Bases: _SerdeShape

Dataclass for StartVpcEndpointServicePrivateDnsVerificationInput structure.

Attributes

dry_run class-attribute instance-attribute
dry_run: bool | 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 class-attribute instance-attribute
service_id: str | None = ...

The ID of the endpoint service.

Output

StartVpcEndpointServicePrivateDnsVerificationOutput dataclass

Bases: _SerdeShape

Dataclass for StartVpcEndpointServicePrivateDnsVerificationOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

return_value class-attribute instance-attribute
return_value: bool | None = ...

Returns true if the request succeeds; otherwise, it returns an error.