« blib/lib/Paws/WorkDocs/GetDocumentVersionResponse.pm
↑ Summary
blib/lib/Paws/WorkDocs/GetFolderPath.pm »
| 1 | |||
| 2 | package Paws::WorkDocs::GetFolder; | ||
| 3 | use Moose; | ||
| 4 | has AuthenticationToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'Authentication'); | ||
| 5 | has FolderId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'FolderId', required => 1); | ||
| 6 | has IncludeCustomMetadata => (is => 'ro', isa => 'Bool', traits => ['ParamInQuery'], query_name => 'includeCustomMetadata'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetFolder'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/api/v1/folders/{FolderId}'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WorkDocs::GetFolderResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::WorkDocs::GetFolder - Arguments for method GetFolder on L<Paws::WorkDocs> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method GetFolder on the | ||
| 25 | L<Amazon WorkDocs|Paws::WorkDocs> service. Use the attributes of this class | ||
| 26 | as arguments to method GetFolder. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetFolder. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $workdocs = Paws->service('WorkDocs'); | ||
| 33 | my $GetFolderResponse = $workdocs->GetFolder( | ||
| 34 | FolderId => 'MyResourceIdType', | ||
| 35 | AuthenticationToken => 'MyAuthenticationHeaderType', # OPTIONAL | ||
| 36 | IncludeCustomMetadata => 1, # OPTIONAL | ||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $CustomMetadata = $GetFolderResponse->CustomMetadata; | ||
| 41 | my $Metadata = $GetFolderResponse->Metadata; | ||
| 42 | |||
| 43 | # Returns a L<Paws::WorkDocs::GetFolderResponse> 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/workdocs/GetFolder> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 AuthenticationToken => Str | ||
| 52 | |||
| 53 | Amazon WorkDocs authentication token. Not required when using AWS | ||
| 54 | administrator credentials to access the API. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> FolderId => Str | ||
| 59 | |||
| 60 | The ID of the folder. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 IncludeCustomMetadata => Bool | ||
| 65 | |||
| 66 | Set to TRUE to include custom metadata in the response. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head1 SEE ALSO | ||
| 72 | |||
| 73 | This class forms part of L<Paws>, documenting arguments for method GetFolder in L<Paws::WorkDocs> | ||
| 74 | |||
| 75 | =head1 BUGS and CONTRIBUTIONS | ||
| 76 | |||
| 77 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 78 | |||
| 79 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 80 | |||
| 81 | =cut | ||
| 82 |