| 1 | |||
| 2 | package Paws::Honeycode::GetScreenData; | ||
| 3 | use Moose; | ||
| 4 | has AppId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'appId', required => 1); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken'); | ||
| 7 | has ScreenId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'screenId', required => 1); | ||
| 8 | has Variables => (is => 'ro', isa => 'Paws::Honeycode::VariableValueMap', traits => ['NameInRequest'], request_name => 'variables'); | ||
| 9 | has WorkbookId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'workbookId', required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetScreenData'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/screendata'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Honeycode::GetScreenDataResult'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Honeycode::GetScreenData - Arguments for method GetScreenData on L<Paws::Honeycode> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method GetScreenData on the | ||
| 28 | L<Amazon Honeycode|Paws::Honeycode> service. Use the attributes of this class | ||
| 29 | as arguments to method GetScreenData. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetScreenData. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $honeycode = Paws->service('Honeycode'); | ||
| 36 | my $GetScreenDataResult = $honeycode->GetScreenData( | ||
| 37 | AppId => 'MyResourceId', | ||
| 38 | ScreenId => 'MyResourceId', | ||
| 39 | WorkbookId => 'MyResourceId', | ||
| 40 | MaxResults => 1, # OPTIONAL | ||
| 41 | NextToken => 'MyPaginationToken', # OPTIONAL | ||
| 42 | Variables => { | ||
| 43 | 'MyVariableName' => { | ||
| 44 | RawValue => 'MyRawValue', # max: 32767 | ||
| 45 | |||
| 46 | }, | ||
| 47 | }, # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $NextToken = $GetScreenDataResult->NextToken; | ||
| 52 | my $Results = $GetScreenDataResult->Results; | ||
| 53 | my $WorkbookCursor = $GetScreenDataResult->WorkbookCursor; | ||
| 54 | |||
| 55 | # Returns a L<Paws::Honeycode::GetScreenDataResult> object. | ||
| 56 | |||
| 57 | 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. | ||
| 58 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/honeycode/GetScreenData> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> AppId => Str | ||
| 64 | |||
| 65 | The ID of the app that contains the screem. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 MaxResults => Int | ||
| 70 | |||
| 71 | The number of results to be returned on a single page. Specify a number | ||
| 72 | between 1 and 100. The maximum value is 100. | ||
| 73 | |||
| 74 | This parameter is optional. If you don't specify this parameter, the | ||
| 75 | default page size is 100. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 NextToken => Str | ||
| 80 | |||
| 81 | This parameter is optional. If a nextToken is not specified, the API | ||
| 82 | returns the first page of data. | ||
| 83 | |||
| 84 | Pagination tokens expire after 1 hour. If you use a token that was | ||
| 85 | returned more than an hour back, the API will throw | ||
| 86 | ValidationException. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 B<REQUIRED> ScreenId => Str | ||
| 91 | |||
| 92 | The ID of the screen. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 Variables => L<Paws::Honeycode::VariableValueMap> | ||
| 97 | |||
| 98 | Variables are optional and are needed only if the screen requires them | ||
| 99 | to render correctly. Variables are specified as a map where the key is | ||
| 100 | the name of the variable as defined on the screen. The value is an | ||
| 101 | object which currently has only one property, rawValue, which holds the | ||
| 102 | value of the variable to be passed to the screen. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 B<REQUIRED> WorkbookId => Str | ||
| 107 | |||
| 108 | The ID of the workbook that contains the screen. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head1 SEE ALSO | ||
| 114 | |||
| 115 | This class forms part of L<Paws>, documenting arguments for method GetScreenData in L<Paws::Honeycode> | ||
| 116 | |||
| 117 | =head1 BUGS and CONTRIBUTIONS | ||
| 118 | |||
| 119 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 120 | |||
| 121 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 122 | |||
| 123 | =cut | ||
| 124 |