Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribeTags

Retrieves a list of configuration items that have tags as specified by the key-value pairs, name and value, passed to the optional parameter filters.

There are three valid tag filter names:

tagKey
tagValue
configurationId

Also, all configuration items associated with your user that have tags can be listed if you call DescribeTags as is without passing any parameters.

Request Syntax


{
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "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.

filters

You can filter the list using a key-value format. You can separate these items by using logical operators. Allowed filters include tagKey, tagValue, and configurationId.

Type: Array of TagFilter objects

Required: No

maxResults

The total number of items to return in a single page of output. The maximum value is 100.

Type: Integer

Required: No

nextToken

A token to start the list. Use this token to get the next set of results.

Type: String

Required: No

Response Syntax


{
   "nextToken": "string",
   "tags": [ 
      { 
         "configurationId": "string",
         "configurationType": "string",
         "key": "string",
         "timeOfCreation": number,
         "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.

nextToken

The call returns a token. Use this token to get the next set of results.

Type: String

tags

Depending on the input, this is a list of configuration items tagged with a specific tag, or a list of tags for a specific configuration item.

Type: Array of ConfigurationTag objects

Errors

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

AuthorizationErrorException

The user does not have permission to perform the action. Check the IAM policy associated with this user.

HTTP Status Code: 400

HomeRegionNotSetException

The home Region is not set. Set the home Region to continue.

HTTP Status Code: 400

InvalidParameterException

One or more parameters are not valid. Verify the parameters and try again.

HTTP Status Code: 400

InvalidParameterValueException

The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.

HTTP Status Code: 400

ResourceNotFoundException

The specified configuration ID was not located. Verify the configuration ID and try again.

HTTP Status Code: 400

ServerInternalErrorException

The server experienced an internal error. Try again.

HTTP Status Code: 500

Examples

Describe tags that have a particular value

The following example lists configuration items associated with an agent installed on a linux server. This is done by passing object array values to the parameter filters where name is "tagValue" and value is "agent on linux server". This results in a descriptive response that lists configuration item details where the tag value is equal to the value specified in the request.

Sample Request



{
"filters": [ 
       { 
         "name": "tagValue",
         "values": [ "agent on linux server" ]
      }
   ]
}

Sample Response



{
    "tags": [
        {
            "configurationType": "SERVER",
            "configurationId": "d-server-0c269e353e6d1fb4c",
            "key": "dp2",
            "value": "agent on linux server",
            "timeOfCreation": 1519674610.0
        }
    ],
    "nextToken": "0039038d504694533"
}