UpdateManagedRuleSetVersionExpiryDate
Updates the expiration information for your managed rule set. Use this to initiate the expiration of a managed rule group version. After you initiate expiration for a version, AWS WAF excludes it from the response to ListAvailableManagedRuleGroupVersions for the managed rule group.
Note
This is intended for use only by vendors of managed rule sets. Vendors are AWS and AWS Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
Request Syntax
{
"ExpiryTimestamp": number,
"Id": "string",
"LockToken": "string",
"Name": "string",
"Scope": "string",
"VersionToExpire": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ExpiryTimestamp
-
The time that you want the version to expire.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".
Type: Timestamp
Required: Yes
- Id
-
A unique identifier for the managed rule set. The ID is returned in the responses to commands like
list. You provide it to operations likegetandupdate.Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern:
^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$Required: Yes
- LockToken
-
A token used for optimistic locking. AWS WAF returns a token to your
getandlistrequests, 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 likeupdateanddelete. AWS 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 aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern:
^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$Required: Yes
- Name
-
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[\w\-]+$Required: Yes
- Scope
-
Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS 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.
Type: String
Valid Values:
CLOUDFRONT | REGIONALRequired: Yes
-
- VersionToExpire
-
The version that you want to remove from your list of offerings for the named managed rule group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[\w#:\.\-/]+$Required: Yes
Response Syntax
{
"ExpiringVersion": "string",
"ExpiryTimestamp": number,
"NextLockToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ExpiringVersion
-
The version that is set to expire.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[\w#:\.\-/]+$ - ExpiryTimestamp
-
The time that the version will expire.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".
Type: Timestamp
- NextLockToken
-
A token used for optimistic locking. AWS WAF returns a token to your
getandlistrequests, 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 likeupdateanddelete. AWS 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 aWAFOptimisticLockException. If this happens, perform anotherget, and use the new token returned by that operation.Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern:
^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$
Errors
For information about the errors that are common to all actions, see Common Errors.
- WAFInternalErrorException
-
Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request.
HTTP Status Code: 500
- WAFInvalidOperationException
-
The operation isn't valid.
HTTP Status Code: 400
- WAFInvalidParameterException
-
The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
-
You specified a parameter name or value that isn't valid.
-
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
-
You tried to update a
WebACLwith aDefaultActionthat isn't among the types available at DefaultAction. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
HTTP Status Code: 400
-
- WAFNonexistentItemException
-
AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
HTTP Status Code: 400
- WAFOptimisticLockException
-
AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
