File Coverage

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