File Coverage

blib/lib/Paws/RedShift/DescribeHsmClientCertificates.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::RedShift::DescribeHsmClientCertificates;
3 1     1   622 use Moose;
  1         4  
  1         11  
4             has HsmClientCertificateIdentifier => (is => 'ro', isa => 'Str');
5             has Marker => (is => 'ro', isa => 'Str');
6             has MaxRecords => (is => 'ro', isa => 'Int');
7             has TagKeys => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
8             has TagValues => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
9              
10 1     1   7316 use MooseX::ClassAttribute;
  1         3  
  1         12  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeHsmClientCertificates');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::HsmClientCertificateMessage');
14             class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeHsmClientCertificatesResult');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::RedShift::DescribeHsmClientCertificates - Arguments for method DescribeHsmClientCertificates on Paws::RedShift
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method DescribeHsmClientCertificates on the
26             Amazon Redshift service. Use the attributes of this class
27             as arguments to method DescribeHsmClientCertificates.
28              
29             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeHsmClientCertificates.
30              
31             As an example:
32              
33             $service_obj->DescribeHsmClientCertificates(Att1 => $value1, Att2 => $value2, ...);
34              
35             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.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 HsmClientCertificateIdentifier => Str
41              
42             The identifier of a specific HSM client certificate for which you want
43             information. If no identifier is specified, information is returned for
44             all HSM client certificates owned by your AWS customer account.
45              
46              
47              
48             =head2 Marker => Str
49              
50             An optional parameter that specifies the starting point to return a set
51             of response records. When the results of a
52             DescribeHsmClientCertificates request exceed the value specified in
53             C<MaxRecords>, AWS returns a value in the C<Marker> field of the
54             response. You can retrieve the next set of response records by
55             providing the returned marker value in the C<Marker> parameter and
56             retrying the request.
57              
58              
59              
60             =head2 MaxRecords => Int
61              
62             The maximum number of response records to return in each call. If the
63             number of remaining response records exceeds the specified
64             C<MaxRecords> value, a value is returned in a C<marker> field of the
65             response. You can retrieve the next set of records by retrying the
66             command with the returned marker value.
67              
68             Default: C<100>
69              
70             Constraints: minimum 20, maximum 100.
71              
72              
73              
74             =head2 TagKeys => ArrayRef[Str|Undef]
75              
76             A tag key or keys for which you want to return all matching HSM client
77             certificates that are associated with the specified key or keys. For
78             example, suppose that you have HSM client certificates that are tagged
79             with keys called C<owner> and C<environment>. If you specify both of
80             these tag keys in the request, Amazon Redshift returns a response with
81             the HSM client certificates that have either or both of these tag keys
82             associated with them.
83              
84              
85              
86             =head2 TagValues => ArrayRef[Str|Undef]
87              
88             A tag value or values for which you want to return all matching HSM
89             client certificates that are associated with the specified tag value or
90             values. For example, suppose that you have HSM client certificates that
91             are tagged with values called C<admin> and C<test>. If you specify both
92             of these tag values in the request, Amazon Redshift returns a response
93             with the HSM client certificates that have either or both of these tag
94             values associated with them.
95              
96              
97              
98              
99             =head1 SEE ALSO
100              
101             This class forms part of L<Paws>, documenting arguments for method DescribeHsmClientCertificates in L<Paws::RedShift>
102              
103             =head1 BUGS and CONTRIBUTIONS
104              
105             The source code is located here: https://github.com/pplu/aws-sdk-perl
106              
107             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
108              
109             =cut
110