You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Honeycode::Types::GetScreenDataRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Honeycode::Types::GetScreenDataRequest
- Defined in:
- (unknown)
Overview
When passing GetScreenDataRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
workbook_id: "ResourceId", # required
app_id: "ResourceId", # required
screen_id: "ResourceId", # required
variables: {
"VariableName" => {
raw_value: "RawValue", # required
},
},
max_results: 1,
next_token: "PaginationToken",
}
Instance Attribute Summary collapse
-
#app_id ⇒ String
The ID of the app that contains the screem.
-
#max_results ⇒ Integer
The number of results to be returned on a single page.
-
#next_token ⇒ String
This parameter is optional.
-
#screen_id ⇒ String
The ID of the screen.
-
#variables ⇒ Hash<String,Types::VariableValue>
Variables are optional and are needed only if the screen requires them to render correctly.
-
#workbook_id ⇒ String
The ID of the workbook that contains the screen.
Instance Attribute Details
#app_id ⇒ String
The ID of the app that contains the screem.
#max_results ⇒ Integer
The number of results to be returned on a single page. Specify a number between 1 and 100. The maximum value is 100.
This parameter is optional. If you don\'t specify this parameter, the default page size is 100.
#next_token ⇒ String
This parameter is optional. If a nextToken is not specified, the API returns the first page of data.
Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.
#screen_id ⇒ String
The ID of the screen.
#variables ⇒ Hash<String,Types::VariableValue>
Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.
#workbook_id ⇒ String
The ID of the workbook that contains the screen.