DescribeTags

GET /?Action=DescribeTags
Description

Describes one or more tags for your resources.
You can use the Filter.N parameter to filter the tags on the following properties:

  • key: The key of the tag.

  • value: The value of the tag.

  • resource-id: The ID of the resource with which the tag is associated.

  • resource-type: The resource type (instance | image | volume | snapshot | public-ip | security-group | route-table | network-interface | vpc | subnet | network-link | vpc-endpoint | nat-gateway | internet-gateway | customer-gateway | vpn-gateway | vpn-connection | dhcp-options | task).

Note

If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.
Body parameter

Required: false
Name: DescribeTagsRequest

Name Description Required Schema Default Example

Filter.N

One or more filters. Example:
osc-cli fcu DescribeTags \
  --Filter.1.Name "resource-id" \
  --Filter.1.Value.1 "i-12345678"

false

Filter

MaxResults

The maximum number of results that can be returned in a single page. You can use the NextToken attribute to request the next results pages. This value is between 5 and 1000. If you provide a value larger than 1000, only 1000 results are returned.

false

integer

NextToken

The token to request the next results page.

false

string
Responses
HTTP Code 200
HTTP Code Description Schema

200

DescribeTagsResult

Response 200

Response 200

Name Description Required Schema Default Example

nextToken

The token to request the next results page. If the value is null, there is no results left to be returned.

false

string

requestId

The ID of the request.

false

string

tagSet.N

Information about one or more tags.

false

TagDescription