list_geo_match_sets

list_geo_match_sets(**kwargs)

Note

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of GeoMatchSetSummary objects in the response.

See also: AWS API Documentation

Request Syntax

response = client.list_geo_match_sets(
    NextMarker='string',
    Limit=123
)
Parameters
  • NextMarker (string) -- If you specify a value for Limit and you have more GeoMatchSet s than the value of Limit , AWS WAF returns a NextMarker value in the response that allows you to list another group of GeoMatchSet objects. For the second and subsequent ListGeoMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of GeoMatchSet objects.
  • Limit (integer) -- Specifies the number of GeoMatchSet objects that you want AWS WAF to return for this request. If you have more GeoMatchSet objects than the number you specify for Limit , the response includes a NextMarker value that you can use to get another batch of GeoMatchSet objects.
Return type

dict

Returns

Response Syntax

{
    'NextMarker': 'string',
    'GeoMatchSets': [
        {
            'GeoMatchSetId': 'string',
            'Name': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextMarker (string) --

      If you have more GeoMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more GeoMatchSet objects, submit another ListGeoMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    • GeoMatchSets (list) --

      An array of GeoMatchSetSummary objects.

      • (dict) --

        Note

        This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

        For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

        Contains the identifier and the name of the GeoMatchSet .

        • GeoMatchSetId (string) --

          The GeoMatchSetId for an GeoMatchSet. You can use GeoMatchSetId in a GetGeoMatchSet request to get detailed information about an GeoMatchSet.

        • Name (string) --

          A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet after you create it.

Exceptions

  • WAF.Client.exceptions.WAFInternalErrorException
  • WAF.Client.exceptions.WAFInvalidAccountException