Class: Aws::Redshift::Types::DescribeTagsMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::Redshift::Types::DescribeTagsMessage
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-redshift/types.rb
Overview
When making an API call, you may pass DescribeTagsMessage data as a 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.
4364 4365 4366 4367 4368 4369 4370 4371 4372 |
# File 'lib/aws-sdk-redshift/types.rb', line 4364 class DescribeTagsMessage < Struct.new( :resource_name, :resource_type, :max_records, :marker, :tag_keys, :tag_values) include Aws::Structure end |
#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.
4364 4365 4366 4367 4368 4369 4370 4371 4372 |
# File 'lib/aws-sdk-redshift/types.rb', line 4364 class DescribeTagsMessage < Struct.new( :resource_name, :resource_type, :max_records, :marker, :tag_keys, :tag_values) include Aws::Structure end |
#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-1:123456789:cluster:t1`.
4364 4365 4366 4367 4368 4369 4370 4371 4372 |
# File 'lib/aws-sdk-redshift/types.rb', line 4364 class DescribeTagsMessage < Struct.new( :resource_name, :resource_type, :max_records, :marker, :tag_keys, :tag_values) include Aws::Structure end |
#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.
4364 4365 4366 4367 4368 4369 4370 4371 4372 |
# File 'lib/aws-sdk-redshift/types.rb', line 4364 class DescribeTagsMessage < Struct.new( :resource_name, :resource_type, :max_records, :marker, :tag_keys, :tag_values) include Aws::Structure end |
#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.
4364 4365 4366 4367 4368 4369 4370 4371 4372 |
# File 'lib/aws-sdk-redshift/types.rb', line 4364 class DescribeTagsMessage < Struct.new( :resource_name, :resource_type, :max_records, :marker, :tag_keys, :tag_values) include Aws::Structure end |
#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.
4364 4365 4366 4367 4368 4369 4370 4371 4372 |
# File 'lib/aws-sdk-redshift/types.rb', line 4364 class DescribeTagsMessage < Struct.new( :resource_name, :resource_type, :max_records, :marker, :tag_keys, :tag_values) include Aws::Structure end |