ListTagsForResource - AWS WAFV2

ListTagsForResource

Note

AWS WAF Classic support will end on September 30, 2025.

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.

Retrieves the tags associated with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.

Request Syntax

{ "Limit": number, "NextMarker": "string", "ResourceARN": "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.

Limit

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No

NextMarker

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1224.

Pattern: .*\S.*

Required: No

ResourceARN

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1224.

Pattern: .*\S.*

Required: Yes

Response Syntax

{ "NextMarker": "string", "TagInfoForResource": { "ResourceARN": "string", "TagList": [ { "Key": "string", "Value": "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.

NextMarker

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1224.

Pattern: .*\S.*

TagInfoForResource

Type: TagInfoForResource object

Errors

For information about the errors that are common to all actions, see Common Errors.

WAFBadRequestException

HTTP Status Code: 400

WAFInternalErrorException

The operation failed because of a system problem, even though the request was valid. Retry your request.

HTTP Status Code: 500

WAFInvalidParameterException

The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

  • You specified an invalid parameter name.

  • You specified an invalid value.

  • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

  • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

  • You tried to create a RateBasedRule with a RateKey value other than IP.

  • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

  • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

  • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

HTTP Status Code: 400

WAFNonexistentItemException

The operation failed because the referenced object doesn't exist.

HTTP Status Code: 400

WAFTagOperationException

HTTP Status Code: 400

WAFTagOperationInternalErrorException

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: