« blib/lib/Paws/RedShift/DescribeTableRestoreStatus.pm
↑ Summary
blib/lib/Paws/RedShift/DescribeUsageLimits.pm »
| 1 | |||
| 2 | package Paws::RedShift::DescribeTags; | ||
| 3 | use Moose; | ||
| 4 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 5 | has MaxRecords => (is => 'ro', isa => 'Int'); | ||
| 6 | has ResourceName => (is => 'ro', isa => 'Str'); | ||
| 7 | has ResourceType => (is => 'ro', isa => 'Str'); | ||
| 8 | has TagKeys => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 9 | has TagValues => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeTags'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::TaggedResourceListMessage'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeTagsResult'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::RedShift::DescribeTags - Arguments for method DescribeTags on L<Paws::RedShift> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method DescribeTags on the | ||
| 27 | L<Amazon Redshift|Paws::RedShift> service. Use the attributes of this class | ||
| 28 | as arguments to method DescribeTags. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeTags. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $redshift = Paws->service('RedShift'); | ||
| 35 | my $TaggedResourceListMessage = $redshift->DescribeTags( | ||
| 36 | Marker => 'MyString', # OPTIONAL | ||
| 37 | MaxRecords => 1, # OPTIONAL | ||
| 38 | ResourceName => 'MyString', # OPTIONAL | ||
| 39 | ResourceType => 'MyString', # OPTIONAL | ||
| 40 | TagKeys => [ | ||
| 41 | 'MyString', ... # max: 2147483647 | ||
| 42 | ], # OPTIONAL | ||
| 43 | TagValues => [ | ||
| 44 | 'MyString', ... # max: 2147483647 | ||
| 45 | ], # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $Marker = $TaggedResourceListMessage->Marker; | ||
| 50 | my $TaggedResources = $TaggedResourceListMessage->TaggedResources; | ||
| 51 | |||
| 52 | # Returns a L<Paws::RedShift::TaggedResourceListMessage> object. | ||
| 53 | |||
| 54 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/DescribeTags> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 Marker => Str | ||
| 61 | |||
| 62 | A value that indicates the starting point for the next set of response | ||
| 63 | records in a subsequent request. If a value is returned in a response, | ||
| 64 | you can retrieve the next set of records by providing this returned | ||
| 65 | marker value in the C<marker> parameter and retrying the command. If | ||
| 66 | the C<marker> field is empty, all response records have been retrieved | ||
| 67 | for the request. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 MaxRecords => Int | ||
| 72 | |||
| 73 | The maximum number or response records to return in each call. If the | ||
| 74 | number of remaining response records exceeds the specified | ||
| 75 | C<MaxRecords> value, a value is returned in a C<marker> field of the | ||
| 76 | response. You can retrieve the next set of records by retrying the | ||
| 77 | command with the returned C<marker> value. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 ResourceName => Str | ||
| 82 | |||
| 83 | The Amazon Resource Name (ARN) for which you want to describe the tag | ||
| 84 | or tags. For example, | ||
| 85 | C<arn:aws:redshift:us-east-2:123456789:cluster:t1>. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 ResourceType => Str | ||
| 90 | |||
| 91 | The type of resource with which you want to view tags. Valid resource | ||
| 92 | types are: | ||
| 93 | |||
| 94 | =over | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | Cluster | ||
| 99 | |||
| 100 | =item * | ||
| 101 | |||
| 102 | CIDR/IP | ||
| 103 | |||
| 104 | =item * | ||
| 105 | |||
| 106 | EC2 security group | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | Snapshot | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | Cluster security group | ||
| 115 | |||
| 116 | =item * | ||
| 117 | |||
| 118 | Subnet group | ||
| 119 | |||
| 120 | =item * | ||
| 121 | |||
| 122 | HSM connection | ||
| 123 | |||
| 124 | =item * | ||
| 125 | |||
| 126 | HSM certificate | ||
| 127 | |||
| 128 | =item * | ||
| 129 | |||
| 130 | Parameter group | ||
| 131 | |||
| 132 | =item * | ||
| 133 | |||
| 134 | Snapshot copy grant | ||
| 135 | |||
| 136 | =back | ||
| 137 | |||
| 138 | For more information about Amazon Redshift resource types and | ||
| 139 | constructing ARNs, go to Specifying Policy Elements: Actions, Effects, | ||
| 140 | Resources, and Principals | ||
| 141 | (https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-overview.html#redshift-iam-access-control-specify-actions) | ||
| 142 | in the Amazon Redshift Cluster Management Guide. | ||
| 143 | |||
| 144 | |||
| 145 | |||
| 146 | =head2 TagKeys => ArrayRef[Str|Undef] | ||
| 147 | |||
| 148 | A tag key or keys for which you want to return all matching resources | ||
| 149 | that are associated with the specified key or keys. For example, | ||
| 150 | suppose that you have resources tagged with keys called C<owner> and | ||
| 151 | C<environment>. If you specify both of these tag keys in the request, | ||
| 152 | Amazon Redshift returns a response with all resources that have either | ||
| 153 | or both of these tag keys associated with them. | ||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | =head2 TagValues => ArrayRef[Str|Undef] | ||
| 158 | |||
| 159 | A tag value or values for which you want to return all matching | ||
| 160 | resources that are associated with the specified value or values. For | ||
| 161 | example, suppose that you have resources tagged with values called | ||
| 162 | C<admin> and C<test>. If you specify both of these tag values in the | ||
| 163 | request, Amazon Redshift returns a response with all resources that | ||
| 164 | have either or both of these tag values associated with them. | ||
| 165 | |||
| 166 | |||
| 167 | |||
| 168 | |||
| 169 | =head1 SEE ALSO | ||
| 170 | |||
| 171 | This class forms part of L<Paws>, documenting arguments for method DescribeTags in L<Paws::RedShift> | ||
| 172 | |||
| 173 | =head1 BUGS and CONTRIBUTIONS | ||
| 174 | |||
| 175 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 176 | |||
| 177 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 178 | |||
| 179 | =cut | ||
| 180 |