« blib/lib/Paws/ManagedBlockchain/ListInvitationsOutput.pm
↑ Summary
blib/lib/Paws/ManagedBlockchain/ListMembersOutput.pm »
| 1 | |||
| 2 | package Paws::ManagedBlockchain::ListMembers; | ||
| 3 | use Moose; | ||
| 4 | has IsOwned => (is => 'ro', isa => 'Bool', traits => ['ParamInQuery'], query_name => 'isOwned'); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 6 | has Name => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'name'); | ||
| 7 | has NetworkId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'networkId', required => 1); | ||
| 8 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 9 | has Status => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'status'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListMembers'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/networks/{networkId}/members'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ManagedBlockchain::ListMembersOutput'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::ManagedBlockchain::ListMembers - Arguments for method ListMembers on L<Paws::ManagedBlockchain> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method ListMembers on the | ||
| 28 | L<Amazon Managed Blockchain|Paws::ManagedBlockchain> service. Use the attributes of this class | ||
| 29 | as arguments to method ListMembers. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListMembers. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $managedblockchain = Paws->service('ManagedBlockchain'); | ||
| 36 | my $ListMembersOutput = $managedblockchain->ListMembers( | ||
| 37 | NetworkId => 'MyResourceIdString', | ||
| 38 | IsOwned => 1, # OPTIONAL | ||
| 39 | MaxResults => 1, # OPTIONAL | ||
| 40 | Name => 'MyString', # OPTIONAL | ||
| 41 | NextToken => 'MyPaginationToken', # OPTIONAL | ||
| 42 | Status => 'CREATING', # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $Members = $ListMembersOutput->Members; | ||
| 47 | my $NextToken = $ListMembersOutput->NextToken; | ||
| 48 | |||
| 49 | # Returns a L<Paws::ManagedBlockchain::ListMembersOutput> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/managedblockchain/ListMembers> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 IsOwned => Bool | ||
| 58 | |||
| 59 | An optional Boolean value. If provided, the request is limited either | ||
| 60 | to members that the current AWS account owns (C<true>) or that other | ||
| 61 | AWS accounts own (C<false>). If omitted, all members are listed. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 MaxResults => Int | ||
| 66 | |||
| 67 | The maximum number of members to return in the request. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 Name => Str | ||
| 72 | |||
| 73 | The optional name of the member to list. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> NetworkId => Str | ||
| 78 | |||
| 79 | The unique identifier of the network for which to list members. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 NextToken => Str | ||
| 84 | |||
| 85 | The pagination token that indicates the next set of results to | ||
| 86 | retrieve. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 Status => Str | ||
| 91 | |||
| 92 | An optional status specifier. If provided, only members currently in | ||
| 93 | this status are listed. | ||
| 94 | |||
| 95 | Valid values are: C<"CREATING">, C<"AVAILABLE">, C<"CREATE_FAILED">, C<"UPDATING">, C<"DELETING">, C<"DELETED">, C<"INACCESSIBLE_ENCRYPTION_KEY"> | ||
| 96 | |||
| 97 | |||
| 98 | =head1 SEE ALSO | ||
| 99 | |||
| 100 | This class forms part of L<Paws>, documenting arguments for method ListMembers in L<Paws::ManagedBlockchain> | ||
| 101 | |||
| 102 | =head1 BUGS and CONTRIBUTIONS | ||
| 103 | |||
| 104 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 105 | |||
| 106 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 107 | |||
| 108 | =cut | ||
| 109 |