WAFV2 / Client / list_available_managed_rule_group_versions

list_available_managed_rule_group_versions

WAFV2.Client.list_available_managed_rule_group_versions(**kwargs)

Returns a list of the available versions for the specified managed rule group.

See also: AWS API Documentation

Request Syntax

response = client.list_available_managed_rule_group_versions(
    VendorName='string',
    Name='string',
    Scope='CLOUDFRONT'|'REGIONAL',
    NextMarker='string',
    Limit=123
)
Parameters:

  • VendorName (string) –

    [REQUIRED]

    The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.

  • Name (string) –

    [REQUIRED]

    The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

  • Scope (string) –

    [REQUIRED]

    Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT.

    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',
    'Versions': [
        {
            'Name': 'string',
            'LastUpdateTimestamp': datetime(2015, 1, 1)
        },
    ],
    'CurrentDefaultVersion': '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.

    • Versions (list) –

      The versions that are currently available for the specified managed rule group. If you specified a Limit in your request, this might not be the full list.

      • (dict) –

        Describes a single version of a managed rule group.

        • Name (string) –

          The version name.

        • LastUpdateTimestamp (datetime) –

          The date and time that the managed rule group owner updated the rule group version information.

    • CurrentDefaultVersion (string) –

      The name of the version that’s currently set as the default.

Exceptions

  • WAFV2.Client.exceptions.WAFInternalErrorException

  • WAFV2.Client.exceptions.WAFInvalidParameterException

  • WAFV2.Client.exceptions.WAFNonexistentItemException

  • WAFV2.Client.exceptions.WAFInvalidOperationException