EC2 / Client / describe_vpc_endpoint_service_permissions

describe_vpc_endpoint_service_permissions#

EC2.Client.describe_vpc_endpoint_service_permissions(**kwargs)#

Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.

Request Syntax

response = client.describe_vpc_endpoint_service_permissions(
    DryRun=True|False,
    ServiceId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

Parameters:

DryRun (boolean) – 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.
ServiceId (string) –
[REQUIRED]

The ID of the service.
Filters (list) –
The filters.
- principal - The ARN of the principal.
- principal-type - The principal type ( All | Service | OrganizationUnit | Account | User | Role).
- (dict) –
  
  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
  
  If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
  
  For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
  - Name (string) –
    
    The name of the filter. Filter names are case-sensitive.
  - Values (list) –
    
    The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
    - (string) –
MaxResults (integer) – 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 NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.
NextToken (string) – The token to retrieve the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'AllowedPrincipals': [
        {
            'PrincipalType': 'All'|'Service'|'OrganizationUnit'|'Account'|'User'|'Role',
            'Principal': 'string',
            'ServicePermissionId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ServiceId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- AllowedPrincipals (list) –
  
  Information about the allowed principals.
  - (dict) –
    
    Describes a principal.
    - PrincipalType (string) –
      
      The type of principal.
    - Principal (string) –
      
      The Amazon Resource Name (ARN) of the principal.
    - ServicePermissionId (string) –
      
      The ID of the service permission.
    - Tags (list) –
      
      The tags.
      - (dict) –
        
        Describes a tag.
        
        Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
        
        Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
    - ServiceId (string) –
      
      The ID of the service.
- NextToken (string) –
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.