EC2 / Client / describe_customer_gateways

describe_customer_gateways

EC2.Client.describe_customer_gateways(**kwargs)

Describes one or more of your VPN customer gateways.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

See also: AWS API Documentation

Request Syntax

response = client.describe_customer_gateways(
    CustomerGatewayIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False
)

Parameters:

• CustomerGatewayIds (list) –

  One or more customer gateway IDs.

  Default: Describes all your customer gateways.

  • (string) –

• Filters (list) –

  One or more filters.

  • bgp-asn - The customer gateway’s Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway device’s external interface.

  • state - The state of the customer gateway ( pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

{
    'CustomerGateways': [
        {
            'CertificateArn': 'string',
            'DeviceName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'BgpAsnExtended': 'string',
            'CustomerGatewayId': 'string',
            'State': 'string',
            'Type': 'string',
            'IpAddress': 'string',
            'BgpAsn': 'string'
        },
    ]
}

Response Structure

• (dict) –

  Contains the output of DescribeCustomerGateways.

  • CustomerGateways (list) –

    Information about one or more customer gateways.

    • (dict) –

      Describes a customer gateway.

      • CertificateArn (string) –

        The Amazon Resource Name (ARN) for the customer gateway certificate.

      • DeviceName (string) –

        The name of customer gateway device.

      • Tags (list) –

        Any tags assigned to the customer gateway.

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

      • BgpAsnExtended (string) –

        The customer gateway device’s Border Gateway Protocol (BGP) Autonomous System Number (ASN).

        Valid values: 2,147,483,648 to 4,294,967,295

      • CustomerGatewayId (string) –

        The ID of the customer gateway.

      • State (string) –

        The current state of the customer gateway ( pending | available | deleting | deleted).

      • Type (string) –

        The type of VPN connection the customer gateway supports ( ipsec.1).

      • IpAddress (string) –

        IPv4 address for the customer gateway device’s outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.

      • BgpAsn (string) –

        The customer gateway device’s Border Gateway Protocol (BGP) Autonomous System Number (ASN).

        Valid values: 1 to 2,147,483,647

Examples

This example describes the specified customer gateway.

response = client.describe_customer_gateways(
    CustomerGatewayIds=[
        'cgw-0e11f167',
    ],
)

print(response)

Expected Output:

{
    'CustomerGateways': [
        {
            'BgpAsn': '65534',
            'CustomerGatewayId': 'cgw-0e11f167',
            'IpAddress': '12.1.2.3',
            'State': 'available',
            'Type': 'ipsec.1',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}