« blib/lib/Paws/Quicksight/SearchDashboardsResponse.pm
↑ Summary
blib/lib/Paws/Quicksight/SearchFoldersResponse.pm »
| 1 | |||
| 2 | package Paws::Quicksight::SearchFolders; | ||
| 3 | use Moose; | ||
| 4 | has AwsAccountId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'AwsAccountId', required => 1); | ||
| 5 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::Quicksight::FolderSearchFilter]', required => 1); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SearchFolders'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/accounts/{AwsAccountId}/search/folders'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Quicksight::SearchFoldersResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Quicksight::SearchFolders - Arguments for method SearchFolders on L<Paws::Quicksight> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method SearchFolders on the | ||
| 26 | L<Amazon QuickSight|Paws::Quicksight> service. Use the attributes of this class | ||
| 27 | as arguments to method SearchFolders. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SearchFolders. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $quicksight = Paws->service('Quicksight'); | ||
| 34 | my $SearchFoldersResponse = $quicksight->SearchFolders( | ||
| 35 | AwsAccountId => 'MyAwsAccountId', | ||
| 36 | Filters => [ | ||
| 37 | { | ||
| 38 | Name => 'PARENT_FOLDER_ARN', # values: PARENT_FOLDER_ARN; OPTIONAL | ||
| 39 | Operator => 'StringEquals', # values: StringEquals; OPTIONAL | ||
| 40 | Value => 'MyString', # OPTIONAL | ||
| 41 | }, | ||
| 42 | ... | ||
| 43 | ], | ||
| 44 | MaxResults => 1, # OPTIONAL | ||
| 45 | NextToken => 'MyString', # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $FolderSummaryList = $SearchFoldersResponse->FolderSummaryList; | ||
| 50 | my $NextToken = $SearchFoldersResponse->NextToken; | ||
| 51 | my $RequestId = $SearchFoldersResponse->RequestId; | ||
| 52 | my $Status = $SearchFoldersResponse->Status; | ||
| 53 | |||
| 54 | # Returns a L<Paws::Quicksight::SearchFoldersResponse> object. | ||
| 55 | |||
| 56 | 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. | ||
| 57 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/quicksight/SearchFolders> | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> AwsAccountId => Str | ||
| 63 | |||
| 64 | The AWS account ID. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> Filters => ArrayRef[L<Paws::Quicksight::FolderSearchFilter>] | ||
| 69 | |||
| 70 | The filters to apply to the search. Currently, you can search only by | ||
| 71 | the parent folder ARN. For example, C<"Filters": [ { "Name": | ||
| 72 | "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": | ||
| 73 | "arn:aws:quicksight:us-east-1:1:folder/folderId" } ]>. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 MaxResults => Int | ||
| 78 | |||
| 79 | The maximum number of results to be returned per request. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 NextToken => Str | ||
| 84 | |||
| 85 | The token for the next set of results, or null if there are no more | ||
| 86 | results. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head1 SEE ALSO | ||
| 92 | |||
| 93 | This class forms part of L<Paws>, documenting arguments for method SearchFolders in L<Paws::Quicksight> | ||
| 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 |