« blib/lib/Paws/EFS/DescribeMountTargetSecurityGroupsResponse.pm
↑ Summary
blib/lib/Paws/EFS/DescribeMountTargetsResponse.pm »
| 1 | |||
| 2 | package Paws::EFS::DescribeMountTargets; | ||
| 3 | use Moose; | ||
| 4 | has AccessPointId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'AccessPointId'); | ||
| 5 | has FileSystemId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'FileSystemId'); | ||
| 6 | has Marker => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'Marker'); | ||
| 7 | has MaxItems => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'MaxItems'); | ||
| 8 | has MountTargetId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'MountTargetId'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeMountTargets'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/2015-02-01/mount-targets'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EFS::DescribeMountTargetsResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::EFS::DescribeMountTargets - Arguments for method DescribeMountTargets on L<Paws::EFS> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method DescribeMountTargets on the | ||
| 27 | L<Amazon Elastic File System|Paws::EFS> service. Use the attributes of this class | ||
| 28 | as arguments to method DescribeMountTargets. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeMountTargets. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $elasticfilesystem = Paws->service('EFS'); | ||
| 35 | # To describe the mount targets for a file system | ||
| 36 | # This operation describes all of a file system's mount targets. | ||
| 37 | my $DescribeMountTargetsResponse = $elasticfilesystem->DescribeMountTargets( | ||
| 38 | 'FileSystemId' => 'fs-01234567' ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $MountTargets = $DescribeMountTargetsResponse->MountTargets; | ||
| 42 | |||
| 43 | # Returns a L<Paws::EFS::DescribeMountTargetsResponse> 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/elasticfilesystem/DescribeMountTargets> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 AccessPointId => Str | ||
| 52 | |||
| 53 | (Optional) The ID of the access point whose mount targets that you want | ||
| 54 | to list. It must be included in your request if a C<FileSystemId> or | ||
| 55 | C<MountTargetId> is not included in your request. Accepts either an | ||
| 56 | access point ID or ARN as input. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 FileSystemId => Str | ||
| 61 | |||
| 62 | (Optional) ID of the file system whose mount targets you want to list | ||
| 63 | (String). It must be included in your request if an C<AccessPointId> or | ||
| 64 | C<MountTargetId> is not included. Accepts either a file system ID or | ||
| 65 | ARN as input. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 Marker => Str | ||
| 70 | |||
| 71 | (Optional) Opaque pagination token returned from a previous | ||
| 72 | C<DescribeMountTargets> operation (String). If present, it specifies to | ||
| 73 | continue the list from where the previous returning call left off. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 MaxItems => Int | ||
| 78 | |||
| 79 | (Optional) Maximum number of mount targets to return in the response. | ||
| 80 | Currently, this number is automatically set to 10, and other values are | ||
| 81 | ignored. The response is paginated at 100 per page if you have more | ||
| 82 | than 100 mount targets. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 MountTargetId => Str | ||
| 87 | |||
| 88 | (Optional) ID of the mount target that you want to have described | ||
| 89 | (String). It must be included in your request if C<FileSystemId> is not | ||
| 90 | included. Accepts either a mount target ID or ARN as input. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head1 SEE ALSO | ||
| 96 | |||
| 97 | This class forms part of L<Paws>, documenting arguments for method DescribeMountTargets in L<Paws::EFS> | ||
| 98 | |||
| 99 | =head1 BUGS and CONTRIBUTIONS | ||
| 100 | |||
| 101 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 102 | |||
| 103 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 104 | |||
| 105 | =cut | ||
| 106 |