Skip to content

modify_vpc_endpoint_service_configuration async

modify_vpc_endpoint_service_configuration(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    service_id: Optional[VpcEndpointServiceId] = None,
    private_dns_name: Optional[String] = None,
    remove_private_dns_name: Optional[Boolean] = None,
    acceptance_required: Optional[Boolean] = None,
    add_network_load_balancer_arns: Optional[ValueStringList] = None,
    remove_network_load_balancer_arns: Optional[ValueStringList] = None,
    add_gateway_load_balancer_arns: Optional[ValueStringList] = None,
    remove_gateway_load_balancer_arns: Optional[ValueStringList] = None,
    add_supported_ip_address_types: Optional[ValueStringList] = None,
    remove_supported_ip_address_types: Optional[ValueStringList] = None,
    add_supported_regions: Optional[ValueStringList] = None,
    remove_supported_regions: Optional[ValueStringList] = None,
) -> ModifyVpcEndpointServiceConfigurationResult

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:

  • 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 service.

  • private_dns_name (Optional[String], default: None ) –

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

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

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

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

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

  • add_network_load_balancer_arns (Optional[ValueStringList], default: None ) –

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

  • remove_network_load_balancer_arns (Optional[ValueStringList], default: None ) –

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

  • add_gateway_load_balancer_arns (Optional[ValueStringList], default: None ) –

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

  • remove_gateway_load_balancer_arns (Optional[ValueStringList], default: None ) –

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

  • add_supported_ip_address_types (Optional[ValueStringList], default: None ) –

    The IP address types to add to the service configuration.

  • remove_supported_ip_address_types (Optional[ValueStringList], default: None ) –

    The IP address types to remove from the service configuration.

  • add_supported_regions (Optional[ValueStringList], default: None ) –

    The supported Regions to add to the service configuration.

  • remove_supported_regions (Optional[ValueStringList], default: None ) –

    The supported Regions to remove from the service configuration.

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def modify_vpc_endpoint_service_configuration(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    service_id: Optional[
        "capo_ec2.types.vpc_endpoint_service_id.VpcEndpointServiceId"
    ] = None,
    private_dns_name: Optional["capo_ec2.types.string.String"] = None,
    remove_private_dns_name: Optional["capo_ec2.types.boolean.Boolean"] = None,
    acceptance_required: Optional["capo_ec2.types.boolean.Boolean"] = None,
    add_network_load_balancer_arns: Optional[
        "capo_ec2.types.value_string_list.ValueStringList"
    ] = None,
    remove_network_load_balancer_arns: Optional[
        "capo_ec2.types.value_string_list.ValueStringList"
    ] = None,
    add_gateway_load_balancer_arns: Optional[
        "capo_ec2.types.value_string_list.ValueStringList"
    ] = None,
    remove_gateway_load_balancer_arns: Optional[
        "capo_ec2.types.value_string_list.ValueStringList"
    ] = None,
    add_supported_ip_address_types: Optional[
        "capo_ec2.types.value_string_list.ValueStringList"
    ] = None,
    remove_supported_ip_address_types: Optional[
        "capo_ec2.types.value_string_list.ValueStringList"
    ] = None,
    add_supported_regions: Optional[
        "capo_ec2.types.value_string_list.ValueStringList"
    ] = None,
    remove_supported_regions: Optional[
        "capo_ec2.types.value_string_list.ValueStringList"
    ] = None,
) -> "capo_ec2.types.modify_vpc_endpoint_service_configuration_result.ModifyVpcEndpointServiceConfigurationResult":
    """<p>Modifies the attributes of the specified VPC endpoint service configuration.</p> <p>If you set or modify the private DNS name, you must prove that you own the private DNS domain name.</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 service.</p>
        private_dns_name: <p>(Interface endpoint configuration) The private DNS name to assign to the endpoint service.</p>
        remove_private_dns_name: <p>(Interface endpoint configuration) Removes the private DNS name of the endpoint service.</p>
        acceptance_required: <p>Indicates whether requests to create an endpoint to the service must be accepted.</p>
        add_network_load_balancer_arns: <p>The Amazon Resource Names (ARNs) of Network Load Balancers to add to the service configuration.</p>
        remove_network_load_balancer_arns: <p>The Amazon Resource Names (ARNs) of Network Load Balancers to remove from the service configuration.</p>
        add_gateway_load_balancer_arns: <p>The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to the service configuration.</p>
        remove_gateway_load_balancer_arns: <p>The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from the service configuration.</p>
        add_supported_ip_address_types: <p>The IP address types to add to the service configuration.</p>
        remove_supported_ip_address_types: <p>The IP address types to remove from the service configuration.</p>
        add_supported_regions: <p>The supported Regions to add to the service configuration.</p>
        remove_supported_regions: <p>The supported Regions to remove from the service configuration.</p>

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

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.modify_vpc_endpoint_service_configuration_request.ModifyVpcEndpointServiceConfigurationRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.modify_vpc_endpoint_service_configuration_result.ModifyVpcEndpointServiceConfigurationResult"
    ]:
        import capo_ec2._operations.amazon_ec2.modify_vpc_endpoint_service_configuration

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.modify_vpc_endpoint_service_configuration.async_modify_vpc_endpoint_service_configuration(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ModifyVpcEndpointServiceConfiguration")
    )
    input_: capo_ec2.types.modify_vpc_endpoint_service_configuration_request.ModifyVpcEndpointServiceConfigurationRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if service_id is not None:
        input_["service_id"] = service_id
    if private_dns_name is not None:
        input_["private_dns_name"] = private_dns_name
    if remove_private_dns_name is not None:
        input_["remove_private_dns_name"] = remove_private_dns_name
    if acceptance_required is not None:
        input_["acceptance_required"] = acceptance_required
    if add_network_load_balancer_arns is not None:
        input_["add_network_load_balancer_arns"] = add_network_load_balancer_arns
    if remove_network_load_balancer_arns is not None:
        input_["remove_network_load_balancer_arns"] = (
            remove_network_load_balancer_arns
        )
    if add_gateway_load_balancer_arns is not None:
        input_["add_gateway_load_balancer_arns"] = add_gateway_load_balancer_arns
    if remove_gateway_load_balancer_arns is not None:
        input_["remove_gateway_load_balancer_arns"] = (
            remove_gateway_load_balancer_arns
        )
    if add_supported_ip_address_types is not None:
        input_["add_supported_ip_address_types"] = add_supported_ip_address_types
    if remove_supported_ip_address_types is not None:
        input_["remove_supported_ip_address_types"] = (
            remove_supported_ip_address_types
        )
    if add_supported_regions is not None:
        input_["add_supported_regions"] = add_supported_regions
    if remove_supported_regions is not None:
        input_["remove_supported_regions"] = remove_supported_regions

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output