DescribeVpcEndpointServicePermissions
Describes the principals (service consumers) that are permitted to discover your VPC 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.
- 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 isUnauthorizedOperation.Type: Boolean
Required: No
- Filter.N
-
The filters.
-
principal- The ARN of the principal. -
principal-type- The principal type (All|Service|OrganizationUnit|Account|User|Role).
Type: Array of Filter objects
Required: No
-
- MaxResults
-
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned
NextTokenvalue. This value can be between 5 and 1,000; ifMaxResultsis given a value larger than 1,000, only 1,000 results are returned.Type: Integer
Required: No
- NextToken
-
The token to retrieve the next page of results.
Type: String
Required: No
- ServiceId
-
The ID of the service.
Type: String
Required: Yes
Response Elements
The following elements are returned by the service.
- allowedPrincipals
-
Information about the allowed principals.
Type: Array of AllowedPrincipal objects
- nextToken
-
The token to use to retrieve the next page of results. This value is
nullwhen there are no more results to return.Type: String
- requestId
-
The ID of the request.
Type: String
Errors
For information about the errors that are common to all actions, see Common client error codes.
Examples
Example
This example describes the permissions for service
vpce-svc-03d5ebb7d9579a123.
Sample Request
https://ec2.amazonaws.com/?Action=DescribeVpcEndpointServicePermissions
&ServiceId=vpce-svc-03d5ebb7d9579a123
&AUTHPARAMSSample Response
<DescribeVpcEndpointServicePermissionsResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>5359c8a3-9151-4964-abed-b4422example</requestId>
<allowedPrincipals>
<item>
<principal>arn:aws:iam::123456789012:root</principal>
<principalType>Account</principalType>
</item>
</allowedPrincipals>
</DescribeVpcEndpointServicePermissionsResponse>See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
