Skip to content

describe_client_vpn_authorization_rules

describe_client_vpn_authorization_rules(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    client_vpn_endpoint_id: Optional[ClientVpnEndpointId] = None,
    dry_run: Optional[Boolean] = None,
    next_token: Optional[NextToken] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[DescribeClientVpnAuthorizationRulesMaxResults] = None,
) -> DescribeClientVpnAuthorizationRulesResult

Describes the authorization rules for a specified Client VPN endpoint.

Parameters:

  • client_vpn_endpoint_id (Optional[ClientVpnEndpointId], default: None ) –

    The ID of the Client VPN endpoint.

  • dry_run (Optional[Boolean], default: None ) –

    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.

  • next_token (Optional[NextToken], default: None ) –

    The token to retrieve the next page of results.

  • filters (Optional[FilterList], default: None ) –

    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.

  • max_results (Optional[DescribeClientVpnAuthorizationRulesMaxResults], default: None ) –

    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.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def describe_client_vpn_authorization_rules(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    client_vpn_endpoint_id: Optional[
        "capo_ec2.types.client_vpn_endpoint_id.ClientVpnEndpointId"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    next_token: Optional["capo_ec2.types.next_token.NextToken"] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional[
        "capo_ec2.types.describe_client_vpn_authorization_rules_max_results.DescribeClientVpnAuthorizationRulesMaxResults"
    ] = None,
) -> "capo_ec2.types.describe_client_vpn_authorization_rules_result.DescribeClientVpnAuthorizationRulesResult":
    """<p>Describes the authorization rules for a specified Client VPN endpoint.</p>

    Args:
        client_vpn_endpoint_id: <p>The ID of the Client VPN endpoint.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        next_token: <p>The token to retrieve the next page of results.</p>
        filters: <p>One or more filters. Filter names and values are case-sensitive.</p> <ul> <li> <p> <code>description</code> - The description of the authorization rule.</p> </li> <li> <p> <code>destination-cidr</code> - The CIDR of the network to which the authorization rule applies.</p> </li> <li> <p> <code>group-id</code> - The ID of the Active Directory group to which the authorization rule grants access.</p> </li> </ul>
        max_results: <p>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.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_client_vpn_authorization_rules_request.DescribeClientVpnAuthorizationRulesRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_client_vpn_authorization_rules_result.DescribeClientVpnAuthorizationRulesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_client_vpn_authorization_rules

        output, http_response = (
            capo_ec2._operations.amazon_ec2.describe_client_vpn_authorization_rules.describe_client_vpn_authorization_rules(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeClientVpnAuthorizationRules")
    )
    input_: capo_ec2.types.describe_client_vpn_authorization_rules_request.DescribeClientVpnAuthorizationRulesRequest = {}
    if client_vpn_endpoint_id is not None:
        input_["client_vpn_endpoint_id"] = client_vpn_endpoint_id
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if next_token is not None:
        input_["next_token"] = next_token
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output