You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Redshift::Types::DescribeTagsMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb

Overview

Note:

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

Instance Attribute Details

#markerString

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.

Returns:

  • (String)


3587
3588
3589
3590
3591
3592
3593
3594
3595
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 3587

class DescribeTagsMessage < Struct.new(
  :resource_name,
  :resource_type,
  :max_records,
  :marker,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end

#max_recordsInteger

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.

Returns:

  • (Integer)


3587
3588
3589
3590
3591
3592
3593
3594
3595
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 3587

class DescribeTagsMessage < Struct.new(
  :resource_name,
  :resource_type,
  :max_records,
  :marker,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end

#resource_nameString

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.

Returns:

  • (String)


3587
3588
3589
3590
3591
3592
3593
3594
3595
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 3587

class DescribeTagsMessage < Struct.new(
  :resource_name,
  :resource_type,
  :max_records,
  :marker,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end

#resource_typeString

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 Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.

Returns:

  • (String)


3587
3588
3589
3590
3591
3592
3593
3594
3595
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 3587

class DescribeTagsMessage < Struct.new(
  :resource_name,
  :resource_type,
  :max_records,
  :marker,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end

#tag_keysArray<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.

Returns:

  • (Array<String>)


3587
3588
3589
3590
3591
3592
3593
3594
3595
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 3587

class DescribeTagsMessage < Struct.new(
  :resource_name,
  :resource_type,
  :max_records,
  :marker,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end

#tag_valuesArray<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.

Returns:

  • (Array<String>)


3587
3588
3589
3590
3591
3592
3593
3594
3595
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 3587

class DescribeTagsMessage < Struct.new(
  :resource_name,
  :resource_type,
  :max_records,
  :marker,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end