« blib/lib/Paws/Honeycode/ImportOptions.pm
↑ Summary
blib/lib/Paws/Honeycode/InvokeScreenAutomationResult.pm »
| 1 | |||
| 2 | package Paws::Honeycode::InvokeScreenAutomation; | ||
| 3 | use Moose; | ||
| 4 | has AppId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'appId', required => 1); | ||
| 5 | has ClientRequestToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientRequestToken'); | ||
| 6 | has RowId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'rowId'); | ||
| 7 | has ScreenAutomationId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'automationId', required => 1); | ||
| 8 | has ScreenId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'screenId', required => 1); | ||
| 9 | has Variables => (is => 'ro', isa => 'Paws::Honeycode::VariableValueMap', traits => ['NameInRequest'], request_name => 'variables'); | ||
| 10 | has WorkbookId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'workbookId', required => 1); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'InvokeScreenAutomation'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/workbooks/{workbookId}/apps/{appId}/screens/{screenId}/automations/{automationId}'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Honeycode::InvokeScreenAutomationResult'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::Honeycode::InvokeScreenAutomation - Arguments for method InvokeScreenAutomation on L<Paws::Honeycode> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method InvokeScreenAutomation on the | ||
| 29 | L<Amazon Honeycode|Paws::Honeycode> service. Use the attributes of this class | ||
| 30 | as arguments to method InvokeScreenAutomation. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to InvokeScreenAutomation. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $honeycode = Paws->service('Honeycode'); | ||
| 37 | my $InvokeScreenAutomationResult = $honeycode->InvokeScreenAutomation( | ||
| 38 | AppId => 'MyResourceId', | ||
| 39 | ScreenAutomationId => 'MyResourceId', | ||
| 40 | ScreenId => 'MyResourceId', | ||
| 41 | WorkbookId => 'MyResourceId', | ||
| 42 | ClientRequestToken => 'MyClientRequestToken', # OPTIONAL | ||
| 43 | RowId => 'MyRowId', # OPTIONAL | ||
| 44 | Variables => { | ||
| 45 | 'MyVariableName' => { | ||
| 46 | RawValue => 'MyRawValue', # max: 32767 | ||
| 47 | |||
| 48 | }, | ||
| 49 | }, # OPTIONAL | ||
| 50 | ); | ||
| 51 | |||
| 52 | # Results: | ||
| 53 | my $WorkbookCursor = $InvokeScreenAutomationResult->WorkbookCursor; | ||
| 54 | |||
| 55 | # Returns a L<Paws::Honeycode::InvokeScreenAutomationResult> 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/InvokeScreenAutomation> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> AppId => Str | ||
| 64 | |||
| 65 | The ID of the app that contains the screen automation. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 ClientRequestToken => Str | ||
| 70 | |||
| 71 | The request token for performing the automation action. Request tokens | ||
| 72 | help to identify duplicate requests. If a call times out or fails due | ||
| 73 | to a transient error like a failed network connection, you can retry | ||
| 74 | the call with the same request token. The service ensures that if the | ||
| 75 | first call using that request token is successfully performed, the | ||
| 76 | second call will return the response of the previous call rather than | ||
| 77 | performing the action again. | ||
| 78 | |||
| 79 | Note that request tokens are valid only for a few minutes. You cannot | ||
| 80 | use request tokens to dedupe requests spanning hours or days. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 RowId => Str | ||
| 85 | |||
| 86 | The row ID for the automation if the automation is defined inside a | ||
| 87 | block with source or list. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 B<REQUIRED> ScreenAutomationId => Str | ||
| 92 | |||
| 93 | The ID of the automation action to be performed. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 B<REQUIRED> ScreenId => Str | ||
| 98 | |||
| 99 | The ID of the screen that contains the screen automation. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 Variables => L<Paws::Honeycode::VariableValueMap> | ||
| 104 | |||
| 105 | Variables are specified as a map where the key is the name of the | ||
| 106 | variable as defined on the screen. The value is an object which | ||
| 107 | currently has only one property, rawValue, which holds the value of the | ||
| 108 | variable to be passed to the screen. Any variables defined in a screen | ||
| 109 | are required to be passed in the call. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 B<REQUIRED> WorkbookId => Str | ||
| 114 | |||
| 115 | The ID of the workbook that contains the screen automation. | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head1 SEE ALSO | ||
| 121 | |||
| 122 | This class forms part of L<Paws>, documenting arguments for method InvokeScreenAutomation in L<Paws::Honeycode> | ||
| 123 | |||
| 124 | =head1 BUGS and CONTRIBUTIONS | ||
| 125 | |||
| 126 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 127 | |||
| 128 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 129 | |||
| 130 | =cut | ||
| 131 |