describe_coip_pools

describe_coip_pools(**kwargs)

Describes the specified customer-owned address pools or all of your customer-owned address pools.

See also: AWS API Documentation

Request Syntax

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

Parameters

• PoolIds (list) --

  The IDs of the address pools.

  • (string) --
• Filters (list) --

  One or more filters.

  • coip-pool.local-gateway-route-table-id - The ID of the local gateway route table.
  • coip-pool.pool-id - The ID of the address pool.
  • (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.

    • 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 with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
• NextToken (string) -- The token for the next page of results.
• 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

{
    'CoipPools': [
        {
            'PoolId': 'string',
            'PoolCidrs': [
                'string',
            ],
            'LocalGatewayRouteTableId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'PoolArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • CoipPools (list) --

    Information about the address pools.

    • (dict) --

      Describes a customer-owned address pool.

      • PoolId (string) --

        The ID of the address pool.

      • PoolCidrs (list) --

        The address ranges of the address pool.

        • (string) --

      • LocalGatewayRouteTableId (string) --

        The ID of the local gateway route table.

      • Tags (list) --

        The tags.

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

      • PoolArn (string) --

        The ARN of the address pool.

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