/AWS1/IF_RSH=>DESCRIBETAGS()

About DescribeTags

Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.

The following are limitations for DescribeTags:

• You cannot specify an ARN and a resource-type value together in the same request.

• You cannot use the MaxRecords and Marker parameters together with the ARN parameter.

• The MaxRecords parameter can be a range from 10 to 50 results to return in a request.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all resources that have any combination of those values are returned.

If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.

Method Signature

METHODS /AWS1/IF_RSH~DESCRIBETAGS
  IMPORTING
    !IV_RESOURCENAME TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_RESOURCETYPE TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_MAXRECORDS TYPE /AWS1/RSHINTEGEROPTIONAL OPTIONAL
    !IV_MARKER TYPE /AWS1/RSHSTRING OPTIONAL
    !IT_TAGKEYS TYPE /AWS1/CL_RSHTAGKEYLIST_W=>TT_TAGKEYLIST OPTIONAL
    !IT_TAGVALUES TYPE /AWS1/CL_RSHTAGVALUELIST_W=>TT_TAGVALUELIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rshtaggedresrclistmsg
  RAISING
    /AWS1/CX_RSHINVALIDTAGFAULT
    /AWS1/CX_RSHRESRCNOTFOUNDFAULT
    /AWS1/CX_RSHCLIENTEXC
    /AWS1/CX_RSHSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_resourcename TYPE /AWS1/RSHSTRING /AWS1/RSHSTRING

The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

iv_resourcetype TYPE /AWS1/RSHSTRING /AWS1/RSHSTRING

The type of resource with which you want to view tags. Valid resource types are:

• Cluster

• CIDR/IP

• EC2 security group

• Snapshot

• Cluster security group

• Subnet group

• HSM connection

• HSM certificate

• Parameter group

• Snapshot copy grant

• Integration (zero-ETL integration or S3 event integration)

  To describe the tags associated with an integration, don't specify ResourceType, instead specify the ResourceName of the integration.

For more information about Amazon Redshift resource types and constructing ARNs, go to Specifying Policy Elements: Actions, Effects, Resources, and Principals in the Amazon Redshift Cluster Management Guide.

iv_maxrecords TYPE /AWS1/RSHINTEGEROPTIONAL /AWS1/RSHINTEGEROPTIONAL

The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

iv_marker TYPE /AWS1/RSHSTRING /AWS1/RSHSTRING

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

it_tagkeys TYPE /AWS1/CL_RSHTAGKEYLIST_W=>TT_TAGKEYLIST TT_TAGKEYLIST

A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

it_tagvalues TYPE /AWS1/CL_RSHTAGVALUELIST_W=>TT_TAGVALUELIST TT_TAGVALUELIST

A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

RETURNING

oo_output TYPE REF TO /aws1/cl_rshtaggedresrclistmsg /AWS1/CL_RSHTAGGEDRESRCLISTMSG

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->describetags(
  it_tagkeys = VALUE /aws1/cl_rshtagkeylist_w=>tt_tagkeylist(
    ( new /aws1/cl_rshtagkeylist_w( |string| ) )
  )
  it_tagvalues = VALUE /aws1/cl_rshtagvaluelist_w=>tt_tagvaluelist(
    ( new /aws1/cl_rshtagvaluelist_w( |string| ) )
  )
  iv_marker = |string|
  iv_maxrecords = 123
  iv_resourcename = |string|
  iv_resourcetype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_taggedresources( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lo_tag = lo_row_1->get_tag( ).
      IF lo_tag IS NOT INITIAL.
        lv_string = lo_tag->get_key( ).
        lv_string = lo_tag->get_value( ).
      ENDIF.
      lv_string = lo_row_1->get_resourcename( ).
      lv_string = lo_row_1->get_resourcetype( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_marker( ).
ENDIF.