| 1 | |||
| 2 | package Paws::IAM::ListRoles; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has Marker => (is => 'ro', isa => 'Str'); | |
| 5 | 1 | has MaxItems => (is => 'ro', isa => 'Int'); | |
| 6 | 1 | has PathPrefix => (is => 'ro', isa => 'Str'); | |
| 7 | |||
| 8 | 1 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 9 | |||
| 10 | 1 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListRoles'); | |
| 11 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IAM::ListRolesResponse'); | |
| 12 | 1 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ListRolesResult'); | |
| 13 | 1 | 1; | |
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::IAM::ListRoles - Arguments for method ListRoles on L<Paws::IAM> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method ListRoles on the | ||
| 24 | L<AWS Identity and Access Management|Paws::IAM> service. Use the attributes of this class | ||
| 25 | as arguments to method ListRoles. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListRoles. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $iam = Paws->service('IAM'); | ||
| 32 | my $ListRolesResponse = $iam->ListRoles( | ||
| 33 | Marker => 'MymarkerType', # OPTIONAL | ||
| 34 | MaxItems => 1, # OPTIONAL | ||
| 35 | PathPrefix => 'MypathPrefixType', # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $IsTruncated = $ListRolesResponse->IsTruncated; | ||
| 40 | my $Marker = $ListRolesResponse->Marker; | ||
| 41 | my $Roles = $ListRolesResponse->Roles; | ||
| 42 | |||
| 43 | # Returns a L<Paws::IAM::ListRolesResponse> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iam/ListRoles> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 Marker => Str | ||
| 52 | |||
| 53 | Use this parameter only when paginating results and only after you | ||
| 54 | receive a response indicating that the results are truncated. Set it to | ||
| 55 | the value of the C<Marker> element in the response that you received to | ||
| 56 | indicate where the next call should start. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 MaxItems => Int | ||
| 61 | |||
| 62 | Use this only when paginating results to indicate the maximum number of | ||
| 63 | items you want in the response. If additional items exist beyond the | ||
| 64 | maximum you specify, the C<IsTruncated> response element is C<true>. | ||
| 65 | |||
| 66 | If you do not include this parameter, the number of items defaults to | ||
| 67 | 100. Note that IAM might return fewer results, even when there are more | ||
| 68 | results available. In that case, the C<IsTruncated> response element | ||
| 69 | returns C<true>, and C<Marker> contains a value to include in the | ||
| 70 | subsequent call that tells the service where to continue from. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 PathPrefix => Str | ||
| 75 | |||
| 76 | The path prefix for filtering the results. For example, the prefix | ||
| 77 | C</application_abc/component_xyz/> gets all roles whose path starts | ||
| 78 | with C</application_abc/component_xyz/>. | ||
| 79 | |||
| 80 | This parameter is optional. If it is not included, it defaults to a | ||
| 81 | slash (/), listing all roles. This parameter allows (through its regex | ||
| 82 | pattern (http://wikipedia.org/wiki/regex)) a string of characters | ||
| 83 | consisting of either a forward slash (/) by itself or a string that | ||
| 84 | must begin and end with forward slashes. In addition, it can contain | ||
| 85 | any ASCII character from the ! (C<\u0021>) through the DEL character | ||
| 86 | (C<\u007F>), including most punctuation characters, digits, and upper | ||
| 87 | and lowercased letters. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head1 SEE ALSO | ||
| 93 | |||
| 94 | This class forms part of L<Paws>, documenting arguments for method ListRoles in L<Paws::IAM> | ||
| 95 | |||
| 96 | =head1 BUGS and CONTRIBUTIONS | ||
| 97 | |||
| 98 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 99 | |||
| 100 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 101 | |||
| 102 | =cut | ||
| 103 | |||