« blib/lib/Paws/RedShift/DescribeEventSubscriptions.pm
↑ Summary
blib/lib/Paws/RedShift/DescribeHsmConfigurations.pm »
| 1 | |||
| 2 | package Paws::RedShift::DescribeHsmClientCertificates; | ||
| 3 | use Moose; | ||
| 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 | use MooseX::ClassAttribute; | ||
| 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 L<Paws::RedShift> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DescribeHsmClientCertificates on the | ||
| 26 | L<Amazon Redshift|Paws::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 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $redshift = Paws->service('RedShift'); | ||
| 34 | my $HsmClientCertificateMessage = $redshift->DescribeHsmClientCertificates( | ||
| 35 | HsmClientCertificateIdentifier => 'MyString', # OPTIONAL | ||
| 36 | Marker => 'MyString', # OPTIONAL | ||
| 37 | MaxRecords => 1, # OPTIONAL | ||
| 38 | TagKeys => [ | ||
| 39 | 'MyString', ... # max: 2147483647 | ||
| 40 | ], # OPTIONAL | ||
| 41 | TagValues => [ | ||
| 42 | 'MyString', ... # max: 2147483647 | ||
| 43 | ], # OPTIONAL | ||
| 44 | ); | ||
| 45 | |||
| 46 | # Results: | ||
| 47 | my $HsmClientCertificates = | ||
| 48 | $HsmClientCertificateMessage->HsmClientCertificates; | ||
| 49 | my $Marker = $HsmClientCertificateMessage->Marker; | ||
| 50 | |||
| 51 | # Returns a L<Paws::RedShift::HsmClientCertificateMessage> object. | ||
| 52 | |||
| 53 | 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. | ||
| 54 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/DescribeHsmClientCertificates> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 HsmClientCertificateIdentifier => Str | ||
| 60 | |||
| 61 | The identifier of a specific HSM client certificate for which you want | ||
| 62 | information. If no identifier is specified, information is returned for | ||
| 63 | all HSM client certificates owned by your AWS customer account. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 Marker => Str | ||
| 68 | |||
| 69 | An optional parameter that specifies the starting point to return a set | ||
| 70 | of response records. When the results of a | ||
| 71 | DescribeHsmClientCertificates request exceed the value specified in | ||
| 72 | C<MaxRecords>, AWS returns a value in the C<Marker> field of the | ||
| 73 | response. You can retrieve the next set of response records by | ||
| 74 | providing the returned marker value in the C<Marker> parameter and | ||
| 75 | retrying the request. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 MaxRecords => Int | ||
| 80 | |||
| 81 | The maximum number of response records to return in each call. If the | ||
| 82 | number of remaining response records exceeds the specified | ||
| 83 | C<MaxRecords> value, a value is returned in a C<marker> field of the | ||
| 84 | response. You can retrieve the next set of records by retrying the | ||
| 85 | command with the returned marker value. | ||
| 86 | |||
| 87 | Default: C<100> | ||
| 88 | |||
| 89 | Constraints: minimum 20, maximum 100. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 TagKeys => ArrayRef[Str|Undef] | ||
| 94 | |||
| 95 | A tag key or keys for which you want to return all matching HSM client | ||
| 96 | certificates that are associated with the specified key or keys. For | ||
| 97 | example, suppose that you have HSM client certificates that are tagged | ||
| 98 | with keys called C<owner> and C<environment>. If you specify both of | ||
| 99 | these tag keys in the request, Amazon Redshift returns a response with | ||
| 100 | the HSM client certificates that have either or both of these tag keys | ||
| 101 | associated with them. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 TagValues => ArrayRef[Str|Undef] | ||
| 106 | |||
| 107 | A tag value or values for which you want to return all matching HSM | ||
| 108 | client certificates that are associated with the specified tag value or | ||
| 109 | values. For example, suppose that you have HSM client certificates that | ||
| 110 | are tagged with values called C<admin> and C<test>. If you specify both | ||
| 111 | of these tag values in the request, Amazon Redshift returns a response | ||
| 112 | with the HSM client certificates that have either or both of these tag | ||
| 113 | values associated with them. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head1 SEE ALSO | ||
| 119 | |||
| 120 | This class forms part of L<Paws>, documenting arguments for method DescribeHsmClientCertificates in L<Paws::RedShift> | ||
| 121 | |||
| 122 | =head1 BUGS and CONTRIBUTIONS | ||
| 123 | |||
| 124 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 125 | |||
| 126 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 127 | |||
| 128 | =cut | ||
| 129 |