Skip to content

modify_vpc_endpoint_service_permissions

Operation

modify_vpc_endpoint_service_permissions

Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (Amazon Web Services accounts, users, and IAM roles) to connect to your endpoint service. Principal ARNs with path components aren't supported.

If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.

Parameters:

Name Type Description Default
request ModifyVpcEndpointServicePermissionsInput | ModifyVpcEndpointServicePermissionsInputDict | 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[ModifyVpcEndpointServicePermissionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ModifyVpcEndpointServicePermissionsOutput

An instance of ModifyVpcEndpointServicePermissionsOutput.

modify_vpc_endpoint_service_permissions async

Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (Amazon Web Services accounts, users, and IAM roles) to connect to your endpoint service. Principal ARNs with path components aren't supported.

If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.

Parameters:

Name Type Description Default
request ModifyVpcEndpointServicePermissionsInput | ModifyVpcEndpointServicePermissionsInputDict | 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[ModifyVpcEndpointServicePermissionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ModifyVpcEndpointServicePermissionsOutput

An instance of ModifyVpcEndpointServicePermissionsOutput.

Input

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

ModifyVpcEndpointServicePermissionsInputDict

Bases: TypedDict

Dictionary form of ModifyVpcEndpointServicePermissionsInput.

Attributes

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

The Amazon Resource Names (ARN) of the principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*).

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.

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

The Amazon Resource Names (ARN) of the principals. Permissions are revoked for principals in this list.

service_id instance-attribute
service_id: Required[str]

The ID of the service.

ModifyVpcEndpointServicePermissionsInput dataclass

Bases: _SerdeShape

Dataclass for ModifyVpcEndpointServicePermissionsInput structure.

Attributes

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

The Amazon Resource Names (ARN) of the principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*).

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.

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

The Amazon Resource Names (ARN) of the principals. Permissions are revoked for principals in this list.

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

The ID of the service.

Output

ModifyVpcEndpointServicePermissionsOutput dataclass

Bases: _SerdeShape

Dataclass for ModifyVpcEndpointServicePermissionsOutput structure.

Attributes

added_principals class-attribute instance-attribute
added_principals: list[AddedPrincipal] | None = ...

Information about the added principals.

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.