blib/lib/Paws/Quicksight/SearchDashboards.pm untested

filter: Statementstmt 0.0% 0 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 17 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Quicksight::SearchDashboards;
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::DashboardSearchFilter]', 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 => 'SearchDashboards');
12 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/accounts/{AwsAccountId}/search/dashboards');
13 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Quicksight::SearchDashboardsResponse');
15 1;
16  
17 ### main pod documentation begin ###
18  
19 =head1 NAME
20  
21 Paws::Quicksight::SearchDashboards - Arguments for method SearchDashboards on L<Paws::Quicksight>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method SearchDashboards on the
26 L<Amazon QuickSight|Paws::Quicksight> service. Use the attributes of this class
27 as arguments to method SearchDashboards.
28  
29 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SearchDashboards.
30  
31 =head1 SYNOPSIS
32  
33 my $quicksight = Paws->service('Quicksight');
34 my $SearchDashboardsResponse = $quicksight->SearchDashboards(
35 AwsAccountId => 'MyAwsAccountId',
36 Filters => [
37 {
38 Operator => 'StringEquals', # values: StringEquals
39 Name => 'QUICKSIGHT_USER', # values: QUICKSIGHT_USER; OPTIONAL
40 Value => 'MyString', # OPTIONAL
41 },
42 ...
43 ],
44 MaxResults => 1, # OPTIONAL
45 NextToken => 'MyString', # OPTIONAL
46 );
47  
48 # Results:
49 my $DashboardSummaryList = $SearchDashboardsResponse->DashboardSummaryList;
50 my $NextToken = $SearchDashboardsResponse->NextToken;
51 my $RequestId = $SearchDashboardsResponse->RequestId;
52 my $Status = $SearchDashboardsResponse->Status;
53  
54 # Returns a L<Paws::Quicksight::SearchDashboardsResponse> 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/SearchDashboards>
58  
59 =head1 ATTRIBUTES
60  
61  
62 =head2 B<REQUIRED> AwsAccountId => Str
63  
64 The ID of the AWS account that contains the user whose dashboards
65 you're searching for.
66  
67  
68  
69 =head2 B<REQUIRED> Filters => ArrayRef[L<Paws::Quicksight::DashboardSearchFilter>]
70  
71 The filters to apply to the search. Currently, you can search only by
72 user name, for example, C<"Filters": [ { "Name": "QUICKSIGHT_USER",
73 "Operator": "StringEquals", "Value":
74 "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]>
75  
76  
77  
78 =head2 MaxResults => Int
79  
80 The maximum number of results to be returned per request.
81  
82  
83  
84 =head2 NextToken => Str
85  
86 The token for the next set of results, or null if there are no more
87 results.
88  
89  
90  
91  
92 =head1 SEE ALSO
93  
94 This class forms part of L<Paws>, documenting arguments for method SearchDashboards in L<Paws::Quicksight>
95  
96 =head1 BUGS and CONTRIBUTIONS
97  
98 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
99  
100 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
101  
102 =cut
103