You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Redshift::Types::DescribeTagsMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::Redshift::Types::DescribeTagsMessage
- Defined in:
- (unknown)
Overview
When passing DescribeTagsMessage as input to an Aws::Client method, you can use a vanilla Hash:
{
resource_name: "String",
resource_type: "String",
max_records: 1,
marker: "String",
tag_keys: ["String"],
tag_values: ["String"],
}
Instance Attribute Summary collapse
-
#marker ⇒ String
A value that indicates the starting point for the next set of response records in a subsequent request.
-
#max_records ⇒ Integer
The maximum number or response records to return in each call.
-
#resource_name ⇒ String
The Amazon Resource Name (ARN) for which you want to describe the tag or tags.
-
#resource_type ⇒ String
The type of resource with which you want to view tags.
-
#tag_keys ⇒ Array<String>
A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys.
-
#tag_values ⇒ Array<String>
A tag value or values for which you want to return all matching resources that are associated with the specified value or values.
Instance Attribute Details
#marker ⇒ String
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.
#max_records ⇒ Integer
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.
#resource_name ⇒ String
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
.
#resource_type ⇒ String
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
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.
#tag_keys ⇒ Array<String>
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.
#tag_values ⇒ Array<String>
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.