| 1 | |||
| 2 | package Paws::RedShift::DescribeUsageLimits; | ||
| 3 | use Moose; | ||
| 4 | has ClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 5 | has FeatureType => (is => 'ro', isa => 'Str'); | ||
| 6 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 7 | has MaxRecords => (is => 'ro', isa => 'Int'); | ||
| 8 | has TagKeys => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 9 | has TagValues => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 10 | has UsageLimitId => (is => 'ro', isa => 'Str'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeUsageLimits'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::UsageLimitList'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeUsageLimitsResult'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::RedShift::DescribeUsageLimits - Arguments for method DescribeUsageLimits on L<Paws::RedShift> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method DescribeUsageLimits on the | ||
| 28 | L<Amazon Redshift|Paws::RedShift> service. Use the attributes of this class | ||
| 29 | as arguments to method DescribeUsageLimits. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeUsageLimits. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $redshift = Paws->service('RedShift'); | ||
| 36 | my $UsageLimitList = $redshift->DescribeUsageLimits( | ||
| 37 | ClusterIdentifier => 'MyString', # OPTIONAL | ||
| 38 | FeatureType => 'spectrum', # OPTIONAL | ||
| 39 | Marker => 'MyString', # OPTIONAL | ||
| 40 | MaxRecords => 1, # OPTIONAL | ||
| 41 | TagKeys => [ | ||
| 42 | 'MyString', ... # max: 2147483647 | ||
| 43 | ], # OPTIONAL | ||
| 44 | TagValues => [ | ||
| 45 | 'MyString', ... # max: 2147483647 | ||
| 46 | ], # OPTIONAL | ||
| 47 | UsageLimitId => 'MyString', # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $Marker = $UsageLimitList->Marker; | ||
| 52 | my $UsageLimits = $UsageLimitList->UsageLimits; | ||
| 53 | |||
| 54 | # Returns a L<Paws::RedShift::UsageLimitList> object. | ||
| 55 | |||
| 56 | 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. | ||
| 57 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/DescribeUsageLimits> | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 ClusterIdentifier => Str | ||
| 63 | |||
| 64 | The identifier of the cluster for which you want to describe usage | ||
| 65 | limits. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 FeatureType => Str | ||
| 70 | |||
| 71 | The feature type for which you want to describe usage limits. | ||
| 72 | |||
| 73 | Valid values are: C<"spectrum">, C<"concurrency-scaling"> | ||
| 74 | |||
| 75 | =head2 Marker => Str | ||
| 76 | |||
| 77 | An optional parameter that specifies the starting point to return a set | ||
| 78 | of response records. When the results of a DescribeUsageLimits request | ||
| 79 | exceed the value specified in C<MaxRecords>, AWS returns a value in the | ||
| 80 | C<Marker> field of the response. You can retrieve the next set of | ||
| 81 | response records by providing the returned marker value in the | ||
| 82 | C<Marker> parameter and retrying the request. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 MaxRecords => Int | ||
| 87 | |||
| 88 | The maximum number of response records to return in each call. If the | ||
| 89 | number of remaining response records exceeds the specified | ||
| 90 | C<MaxRecords> value, a value is returned in a C<marker> field of the | ||
| 91 | response. You can retrieve the next set of records by retrying the | ||
| 92 | command with the returned marker value. | ||
| 93 | |||
| 94 | Default: C<100> | ||
| 95 | |||
| 96 | Constraints: minimum 20, maximum 100. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 TagKeys => ArrayRef[Str|Undef] | ||
| 101 | |||
| 102 | A tag key or keys for which you want to return all matching usage limit | ||
| 103 | objects that are associated with the specified key or keys. For | ||
| 104 | example, suppose that you have parameter groups that are tagged with | ||
| 105 | keys called C<owner> and C<environment>. If you specify both of these | ||
| 106 | tag keys in the request, Amazon Redshift returns a response with the | ||
| 107 | usage limit objects have either or both of these tag keys associated | ||
| 108 | with them. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 TagValues => ArrayRef[Str|Undef] | ||
| 113 | |||
| 114 | A tag value or values for which you want to return all matching usage | ||
| 115 | limit objects that are associated with the specified tag value or | ||
| 116 | values. For example, suppose that you have parameter groups that are | ||
| 117 | tagged with values called C<admin> and C<test>. If you specify both of | ||
| 118 | these tag values in the request, Amazon Redshift returns a response | ||
| 119 | with the usage limit objects that have either or both of these tag | ||
| 120 | values associated with them. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 UsageLimitId => Str | ||
| 125 | |||
| 126 | The identifier of the usage limit to describe. | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head1 SEE ALSO | ||
| 132 | |||
| 133 | This class forms part of L<Paws>, documenting arguments for method DescribeUsageLimits in L<Paws::RedShift> | ||
| 134 | |||
| 135 | =head1 BUGS and CONTRIBUTIONS | ||
| 136 | |||
| 137 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 138 | |||
| 139 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 140 | |||
| 141 | =cut | ||
| 142 |