« blib/lib/Paws/ACMPCA/ListCertificateAuthoritiesResponse.pm
↑ Summary
blib/lib/Paws/ACMPCA/ListPermissionsResponse.pm »
| 1 | |||
| 2 | package Paws::ACMPCA::ListPermissions; | ||
| 3 | use Moose; | ||
| 4 | has CertificateAuthorityArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListPermissions'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ACMPCA::ListPermissionsResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::ACMPCA::ListPermissions - Arguments for method ListPermissions on L<Paws::ACMPCA> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method ListPermissions on the | ||
| 24 | L<AWS Certificate Manager Private Certificate Authority|Paws::ACMPCA> service. Use the attributes of this class | ||
| 25 | as arguments to method ListPermissions. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListPermissions. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $acm-pca = Paws->service('ACMPCA'); | ||
| 32 | my $ListPermissionsResponse = $acm -pca->ListPermissions( | ||
| 33 | CertificateAuthorityArn => 'MyArn', | ||
| 34 | MaxResults => 1, # OPTIONAL | ||
| 35 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $NextToken = $ListPermissionsResponse->NextToken; | ||
| 40 | my $Permissions = $ListPermissionsResponse->Permissions; | ||
| 41 | |||
| 42 | # Returns a L<Paws::ACMPCA::ListPermissionsResponse> object. | ||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/acm-pca/ListPermissions> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> CertificateAuthorityArn => Str | ||
| 51 | |||
| 52 | The Amazon Resource Number (ARN) of the private CA to inspect. You can | ||
| 53 | find the ARN by calling the ListCertificateAuthorities | ||
| 54 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html) | ||
| 55 | action. This must be of the form: | ||
| 56 | C<arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012> | ||
| 57 | You can get a private CA's ARN by running the | ||
| 58 | ListCertificateAuthorities | ||
| 59 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html) | ||
| 60 | action. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 MaxResults => Int | ||
| 65 | |||
| 66 | When paginating results, use this parameter to specify the maximum | ||
| 67 | number of items to return in the response. If additional items exist | ||
| 68 | beyond the number you specify, the B<NextToken> element is sent in the | ||
| 69 | response. Use this B<NextToken> value in a subsequent request to | ||
| 70 | retrieve additional items. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 NextToken => Str | ||
| 75 | |||
| 76 | When paginating results, use this parameter in a subsequent request | ||
| 77 | after you receive a response with truncated results. Set it to the | ||
| 78 | value of B<NextToken> from the response you just received. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head1 SEE ALSO | ||
| 84 | |||
| 85 | This class forms part of L<Paws>, documenting arguments for method ListPermissions in L<Paws::ACMPCA> | ||
| 86 | |||
| 87 | =head1 BUGS and CONTRIBUTIONS | ||
| 88 | |||
| 89 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 90 | |||
| 91 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 92 | |||
| 93 | =cut | ||
| 94 |