list_ip_sets

list_ip_sets(**kwargs)

Retrieves an array of IPSetSummary objects for the IP sets that you manage.

See also: AWS API Documentation

Request Syntax

response = client.list_ip_sets(
    Scope='CLOUDFRONT'|'REGIONAL',
    NextMarker='string',
    Limit=123
)

Parameters

• Scope (string) --

  [REQUIRED]

  Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito user pool, or an App Runner service.

  To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1 .
  • API and SDKs - For all calls, use the Region endpoint us-east-1.
• NextMarker (string) -- When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
• Limit (integer) -- The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

Return type

dict

Returns

Response Syntax

{
    'NextMarker': 'string',
    'IPSets': [
        {
            'Name': 'string',
            'Id': 'string',
            'Description': 'string',
            'LockToken': 'string',
            'ARN': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • NextMarker (string) --

    When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

  • IPSets (list) --

    Array of IPSets. This may not be the full list of IPSets that you have defined. See the Limit specification for this request.

    • (dict) --

      High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet , and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.

      • Name (string) --

        The name of the IP set. You cannot change the name of an IPSet after you create it.

      • Id (string) --

        A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

      • Description (string) --

        A description of the IP set that helps with identification.

      • LockToken (string) --

        A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete . WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException . If this happens, perform another get , and use the new token returned by that operation.

      • ARN (string) --

        The Amazon Resource Name (ARN) of the entity.

Exceptions

• WAFV2.Client.exceptions.WAFInternalErrorException
• WAFV2.Client.exceptions.WAFInvalidParameterException
• WAFV2.Client.exceptions.WAFInvalidOperationException