« blib/lib/Paws/RAM/ListPermissionsResponse.pm
↑ Summary
blib/lib/Paws/RAM/ListPrincipalsResponse.pm »
| 1 | |||
| 2 | package Paws::RAM::ListPrincipals; | ||
| 3 | use Moose; | ||
| 4 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults'); | ||
| 5 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken'); | ||
| 6 | has Principals => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'principals'); | ||
| 7 | has ResourceArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'resourceArn'); | ||
| 8 | has ResourceOwner => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'resourceOwner', required => 1); | ||
| 9 | has ResourceShareArns => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'resourceShareArns'); | ||
| 10 | has ResourceType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'resourceType'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListPrincipals'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/listprincipals'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RAM::ListPrincipalsResponse'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::RAM::ListPrincipals - Arguments for method ListPrincipals on L<Paws::RAM> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method ListPrincipals on the | ||
| 29 | L<AWS Resource Access Manager|Paws::RAM> service. Use the attributes of this class | ||
| 30 | as arguments to method ListPrincipals. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListPrincipals. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $ram = Paws->service('RAM'); | ||
| 37 | my $ListPrincipalsResponse = $ram->ListPrincipals( | ||
| 38 | ResourceOwner => 'SELF', | ||
| 39 | MaxResults => 1, # OPTIONAL | ||
| 40 | NextToken => 'MyString', # OPTIONAL | ||
| 41 | Principals => [ 'MyString', ... ], # OPTIONAL | ||
| 42 | ResourceArn => 'MyString', # OPTIONAL | ||
| 43 | ResourceShareArns => [ 'MyString', ... ], # OPTIONAL | ||
| 44 | ResourceType => 'MyString', # OPTIONAL | ||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $NextToken = $ListPrincipalsResponse->NextToken; | ||
| 49 | my $Principals = $ListPrincipalsResponse->Principals; | ||
| 50 | |||
| 51 | # Returns a L<Paws::RAM::ListPrincipalsResponse> 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/ram/ListPrincipals> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 MaxResults => Int | ||
| 60 | |||
| 61 | The maximum number of results to return with a single call. To retrieve | ||
| 62 | the remaining results, make another call with the returned C<nextToken> | ||
| 63 | value. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 NextToken => Str | ||
| 68 | |||
| 69 | The token for the next page of results. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 Principals => ArrayRef[Str|Undef] | ||
| 74 | |||
| 75 | The principals. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 ResourceArn => Str | ||
| 80 | |||
| 81 | The Amazon Resource Name (ARN) of the resource. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 B<REQUIRED> ResourceOwner => Str | ||
| 86 | |||
| 87 | The type of owner. | ||
| 88 | |||
| 89 | Valid values are: C<"SELF">, C<"OTHER-ACCOUNTS"> | ||
| 90 | |||
| 91 | =head2 ResourceShareArns => ArrayRef[Str|Undef] | ||
| 92 | |||
| 93 | The Amazon Resource Names (ARN) of the resource shares. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 ResourceType => Str | ||
| 98 | |||
| 99 | The resource type. | ||
| 100 | |||
| 101 | Valid values: C<acm-pca:CertificateAuthority> | C<appmesh:Mesh> | | ||
| 102 | C<codebuild:Project> | C<codebuild:ReportGroup> | | ||
| 103 | C<ec2:CapacityReservation> | C<ec2:DedicatedHost> | | ||
| 104 | C<ec2:LocalGatewayRouteTable> | C<ec2:PrefixList> | C<ec2:Subnet> | | ||
| 105 | C<ec2:TrafficMirrorTarget> | C<ec2:TransitGateway> | | ||
| 106 | C<imagebuilder:Component> | C<imagebuilder:Image> | | ||
| 107 | C<imagebuilder:ImageRecipe> | C<imagebuilder:ContainerRecipe> | | ||
| 108 | C<glue:Catalog> | C<glue:Database> | C<glue:Table> | | ||
| 109 | C<license-manager:LicenseConfiguration> I | ||
| 110 | C<network-firewall:FirewallPolicy> | | ||
| 111 | C<network-firewall:StatefulRuleGroup> | | ||
| 112 | C<network-firewall:StatelessRuleGroup> | C<outposts:Outpost> | | ||
| 113 | C<resource-groups:Group> | C<rds:Cluster> | | ||
| 114 | C<route53resolver:ResolverQueryLogConfig> | | ||
| 115 | C<route53resolver:ResolverRule> | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head1 SEE ALSO | ||
| 121 | |||
| 122 | This class forms part of L<Paws>, documenting arguments for method ListPrincipals in L<Paws::RAM> | ||
| 123 | |||
| 124 | =head1 BUGS and CONTRIBUTIONS | ||
| 125 | |||
| 126 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 127 | |||
| 128 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 129 | |||
| 130 | =cut | ||
| 131 |