Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

ModifyVpcEndpointServicePermissions

Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (IAM users, IAM roles, and AWS accounts) to discover your endpoint service.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

AddAllowedPrincipals.N

One or more Amazon Resource Names (ARNs) of principals for which to allow permission. Specify * to allow all principals.

Type: Array of strings

Required: No

DryRun

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.

Type: Boolean

Required: No

RemoveAllowedPrincipals.N

One or more Amazon Resource Names (ARNs) of principals for which to remove permission.

Type: Array of strings

Required: No

ServiceId

The ID of the service.

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

return

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

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Client Errors.

Example

Example

This example permits AWS account 123456789012 to discover your endpoint service vpce-svc-03d5ebb7d9579a2b3.

Sample Request

https://ec2.amazonaws.com/?Action=ModifyVpcEndpointServicePermissions &ServiceId=vpce-svc-03d5ebb7d9579a2b3 &AddAllowedPrincipals.1=arn:aws:iam::123456789012:root &AUTHPARAMS

Sample Response

<ModifyVpcEndpointServicePermissionsResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>08d80840-f750-42db-a6f8-2cd32example</requestId> <return>true</return> </ModifyVpcEndpointServicePermissionsResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: