Skip to content

EC2  >  Operations  >  modify_vpc_endpoint_service_configuration

modify_vpc_endpoint_service_configuration

Operation

modify_vpc_endpoint_service_configuration async

modify_vpc_endpoint_service_configuration(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyVpcEndpointServiceConfigurationInputDict]) -> ModifyVpcEndpointServiceConfigurationOutput

Modifies the attributes of the specified VPC endpoint service configuration.

If you set or modify the private DNS name, you must prove that you own the private DNS domain name.

Parameters:

Name Type Description Default
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

Returns:

Type Description
ModifyVpcEndpointServiceConfigurationOutput

An instance of ModifyVpcEndpointServiceConfigurationOutput.

Input

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

Model

ModifyVpcEndpointServiceConfigurationInput dataclass

Bases: _SerdeShape

Dataclass for ModifyVpcEndpointServiceConfigurationInput structure.

Attributes
acceptance_required class-attribute instance-attribute
acceptance_required: bool | None = ...

Indicates whether requests to create an endpoint to the service must be accepted.

add_gateway_load_balancer_arns class-attribute instance-attribute
add_gateway_load_balancer_arns: list[str] | None = ...

The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to the service configuration.

add_network_load_balancer_arns class-attribute instance-attribute
add_network_load_balancer_arns: list[str] | None = ...

The Amazon Resource Names (ARNs) of Network Load Balancers to add to the service configuration.

add_supported_ip_address_types class-attribute instance-attribute
add_supported_ip_address_types: list[str] | None = ...

The IP address types to add to the service configuration.

add_supported_regions class-attribute instance-attribute
add_supported_regions: list[str] | None = ...

The supported Regions to add to the service configuration.

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.

private_dns_name class-attribute instance-attribute
private_dns_name: str | None = ...

(Interface endpoint configuration) The private DNS name to assign to the endpoint service.

remove_gateway_load_balancer_arns class-attribute instance-attribute
remove_gateway_load_balancer_arns: list[str] | None = ...

The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from the service configuration.

remove_network_load_balancer_arns class-attribute instance-attribute
remove_network_load_balancer_arns: list[str] | None = ...

The Amazon Resource Names (ARNs) of Network Load Balancers to remove from the service configuration.

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

(Interface endpoint configuration) Removes the private DNS name of the endpoint service.

remove_supported_ip_address_types class-attribute instance-attribute
remove_supported_ip_address_types: list[str] | None = ...

The IP address types to remove from the service configuration.

remove_supported_regions class-attribute instance-attribute
remove_supported_regions: list[str] | None = ...

The supported Regions to remove from the service configuration.

service_id class-attribute instance-attribute
service_id: str | None = ...

The ID of the service.

Dictionaries

ModifyVpcEndpointServiceConfigurationInputDict

Bases: TypedDict

Dictionary form of ModifyVpcEndpointServiceConfigurationInput.

Attributes
acceptance_required instance-attribute
acceptance_required: bool | None

Indicates whether requests to create an endpoint to the service must be accepted.

add_gateway_load_balancer_arns instance-attribute
add_gateway_load_balancer_arns: Sequence[str] | None

The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to the service configuration.

add_network_load_balancer_arns instance-attribute
add_network_load_balancer_arns: Sequence[str] | None

The Amazon Resource Names (ARNs) of Network Load Balancers to add to the service configuration.

add_supported_ip_address_types instance-attribute
add_supported_ip_address_types: Sequence[str] | None

The IP address types to add to the service configuration.

add_supported_regions instance-attribute
add_supported_regions: Sequence[str] | None

The supported Regions to add to the service configuration.

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.

private_dns_name instance-attribute
private_dns_name: str | None

(Interface endpoint configuration) The private DNS name to assign to the endpoint service.

remove_gateway_load_balancer_arns instance-attribute
remove_gateway_load_balancer_arns: Sequence[str] | None

The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from the service configuration.

remove_network_load_balancer_arns instance-attribute
remove_network_load_balancer_arns: Sequence[str] | None

The Amazon Resource Names (ARNs) of Network Load Balancers to remove from the service configuration.

remove_private_dns_name instance-attribute
remove_private_dns_name: bool | None

(Interface endpoint configuration) Removes the private DNS name of the endpoint service.

remove_supported_ip_address_types instance-attribute
remove_supported_ip_address_types: Sequence[str] | None

The IP address types to remove from the service configuration.

remove_supported_regions instance-attribute
remove_supported_regions: Sequence[str] | None

The supported Regions to remove from the service configuration.

service_id instance-attribute
service_id: Required[str]

The ID of the service.

Output

ModifyVpcEndpointServiceConfigurationOutput dataclass

Bases: _SerdeShape

Dataclass for ModifyVpcEndpointServiceConfigurationOutput 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_ class-attribute instance-attribute
return_: bool | None = ...

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