EC2 / Client / describe_client_vpn_authorization_rules

describe_client_vpn_authorization_rules

EC2.Client.describe_client_vpn_authorization_rules(**kwargs)

Describes the authorization rules for a specified Client VPN endpoint.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ClientVpnEndpointId (string) –

  [REQUIRED]

  The ID of the Client VPN endpoint.

• 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.

• NextToken (string) – The token to retrieve the next page of results.

• Filters (list) –

  One or more filters. Filter names and values are case-sensitive.

  • description - The description of the authorization rule.

  • destination-cidr - The CIDR of the network to which the authorization rule applies.

  • group-id - The ID of the Active Directory group to which the authorization rule grants access.

  • (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 can be seen by sending another request with the nextToken value.

Return type:

dict

Returns:

Response Syntax

{
    'AuthorizationRules': [
        {
            'ClientVpnEndpointId': 'string',
            'Description': 'string',
            'GroupId': 'string',
            'AccessAll': True|False,
            'DestinationCidr': 'string',
            'Status': {
                'Code': 'authorizing'|'active'|'failed'|'revoking',
                'Message': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • AuthorizationRules (list) –

    Information about the authorization rules.

    • (dict) –

      Information about an authorization rule.

      • ClientVpnEndpointId (string) –

        The ID of the Client VPN endpoint with which the authorization rule is associated.

      • Description (string) –

        A brief description of the authorization rule.

      • GroupId (string) –

        The ID of the Active Directory group to which the authorization rule grants access.

      • AccessAll (boolean) –

        Indicates whether the authorization rule grants access to all clients.

      • DestinationCidr (string) –

        The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies.

      • Status (dict) –

        The current state of the authorization rule.

        • Code (string) –

          The state of the authorization rule.

        • Message (string) –

          A message about the status of the authorization rule, if applicable.

  • 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.