EC2 / Client / describe_client_vpn_target_networks

describe_client_vpn_target_networks

EC2.Client.describe_client_vpn_target_networks(**kwargs)

Describes the target networks associated with the specified Client VPN endpoint.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ClientVpnEndpointId (string) –

  [REQUIRED]

  The ID of the Client VPN endpoint.

• AssociationIds (list) –

  The IDs of the target network associations.

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

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

• Filters (list) –

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

  • association-id - The ID of the association.

  • target-network-id - The ID of the subnet specified as the target network.

  • vpc-id - The ID of the VPC in which the target network is located.

  • (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) –

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

Return type:

dict

Returns:

Response Syntax

{
    'ClientVpnTargetNetworks': [
        {
            'AssociationId': 'string',
            'VpcId': 'string',
            'TargetNetworkId': 'string',
            'ClientVpnEndpointId': 'string',
            'Status': {
                'Code': 'associating'|'associated'|'association-failed'|'disassociating'|'disassociated',
                'Message': 'string'
            },
            'SecurityGroups': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • ClientVpnTargetNetworks (list) –

    Information about the associated target networks.

    • (dict) –

      Describes a target network associated with a Client VPN endpoint.

      • AssociationId (string) –

        The ID of the association.

      • VpcId (string) –

        The ID of the VPC in which the target network (subnet) is located.

      • TargetNetworkId (string) –

        The ID of the subnet specified as the target network.

      • ClientVpnEndpointId (string) –

        The ID of the Client VPN endpoint with which the target network is associated.

      • Status (dict) –

        The current state of the target network association.

        • Code (string) –

          The state of the target network association.

        • Message (string) –

          A message about the status of the target network association, if applicable.

      • SecurityGroups (list) –

        The IDs of the security groups applied to the target network association.

        • (string) –

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