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