AWS API Changes

2022/04/08 - AWS WAFV2 - 2 updated api methods

Changes Add a new CurrentDefaultVersion field to ListAvailableManagedRuleGroupVersions API response; add a new VersioningSupported boolean to each ManagedRuleGroup returned from ListAvailableManagedRuleGroups API response.

ListAvailableManagedRuleGroupVersions (updated)

Link ¶
Changes (response)

{'CurrentDefaultVersion': 'string'}

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

See also: AWS API Documentation

Request Syntax

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

type VendorName:

string

param VendorName:

[REQUIRED]

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

type Name:

string

param Name:

[REQUIRED]

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

type Scope:

string

param Scope:

[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, or an AppSync GraphQL API.

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.

type NextMarker:

string

param NextMarker:

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.

type Limit:

integer

param Limit:

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.

rtype:

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

ListAvailableManagedRuleGroups (updated)

Link ¶
Changes (response)

{'ManagedRuleGroups': {'VersioningSupported': 'boolean'}}

Retrieves an array of managed rule groups that are available for you to use. This list includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're subscribed to.

See also: AWS API Documentation

Request Syntax

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

type Scope:

string

param Scope:

[REQUIRED]

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.

type NextMarker:

string

param NextMarker:

type Limit:

integer

param Limit:

rtype:

dict

returns:

Response Syntax

{
    'NextMarker': 'string',
    'ManagedRuleGroups': [
        {
            'VendorName': 'string',
            'Name': 'string',
            'VersioningSupported': True|False,
            'Description': '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.
- ManagedRuleGroups (list) --
  - (dict) --
    
    High-level information about a managed rule group, returned by ListAvailableManagedRuleGroups. This provides information like the name and vendor name, that you provide when you add a ManagedRuleGroupStatement to a web ACL. Managed rule groups include Amazon Web Services Managed Rules rule groups, which are free of charge to WAF customers, and Amazon Web Services Marketplace managed rule groups, which you can subscribe to through Amazon Web Services Marketplace.
    - VendorName (string) --
      
      The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
    - Name (string) --
      
      The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
    - VersioningSupported (boolean) --
      
      Indicates whether the managed rule group is versioned. If it is, you can retrieve the versions list by calling ListAvailableManagedRuleGroupVersions.
    - Description (string) --
      
      The description of the managed rule group, provided by Amazon Web Services Managed Rules or the Amazon Web Services Marketplace seller who manages it.