EC2 / Client / modify_vpc_endpoint_service_permissions

modify_vpc_endpoint_service_permissions#

EC2.Client.modify_vpc_endpoint_service_permissions(**kwargs)#

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.

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.

See also: AWS API Documentation

Request Syntax

response = client.modify_vpc_endpoint_service_permissions(
    DryRun=True|False,
    ServiceId='string',
    AddAllowedPrincipals=[
        'string',
    ],
    RemoveAllowedPrincipals=[
        '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.

  • AddAllowedPrincipals (list) –

    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 (*).

    • (string) –

  • RemoveAllowedPrincipals (list) –

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

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'AddedPrincipals': [
        {
            'PrincipalType': 'All'|'Service'|'OrganizationUnit'|'Account'|'User'|'Role',
            'Principal': 'string',
            'ServicePermissionId': 'string',
            'ServiceId': 'string'
        },
    ],
    'ReturnValue': True|False
}

Response Structure

  • (dict) –

    • AddedPrincipals (list) –

      Information about the added 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.

        • ServiceId (string) –

          The ID of the service.

    • ReturnValue (boolean) –

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