aws-sdk-honeycode 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,189 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::Honeycode
11
+ # @api private
12
+ module ClientApi
13
+
14
+ include Seahorse::Model
15
+
16
+ AccessDeniedException = Shapes::StructureShape.new(name: 'AccessDeniedException')
17
+ AutomationExecutionException = Shapes::StructureShape.new(name: 'AutomationExecutionException')
18
+ AutomationExecutionTimeoutException = Shapes::StructureShape.new(name: 'AutomationExecutionTimeoutException')
19
+ ClientRequestToken = Shapes::StringShape.new(name: 'ClientRequestToken')
20
+ ColumnMetadata = Shapes::StructureShape.new(name: 'ColumnMetadata')
21
+ DataItem = Shapes::StructureShape.new(name: 'DataItem')
22
+ DataItems = Shapes::ListShape.new(name: 'DataItems')
23
+ ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
24
+ Format = Shapes::StringShape.new(name: 'Format')
25
+ FormattedValue = Shapes::StringShape.new(name: 'FormattedValue')
26
+ GetScreenDataRequest = Shapes::StructureShape.new(name: 'GetScreenDataRequest')
27
+ GetScreenDataResult = Shapes::StructureShape.new(name: 'GetScreenDataResult')
28
+ InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
29
+ InvokeScreenAutomationRequest = Shapes::StructureShape.new(name: 'InvokeScreenAutomationRequest')
30
+ InvokeScreenAutomationResult = Shapes::StructureShape.new(name: 'InvokeScreenAutomationResult')
31
+ MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
32
+ Name = Shapes::StringShape.new(name: 'Name')
33
+ PaginationToken = Shapes::StringShape.new(name: 'PaginationToken')
34
+ RawValue = Shapes::StringShape.new(name: 'RawValue')
35
+ RequestTimeoutException = Shapes::StructureShape.new(name: 'RequestTimeoutException')
36
+ ResourceId = Shapes::StringShape.new(name: 'ResourceId')
37
+ ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
38
+ ResultHeader = Shapes::ListShape.new(name: 'ResultHeader')
39
+ ResultRow = Shapes::StructureShape.new(name: 'ResultRow')
40
+ ResultRows = Shapes::ListShape.new(name: 'ResultRows')
41
+ ResultSet = Shapes::StructureShape.new(name: 'ResultSet')
42
+ ResultSetMap = Shapes::MapShape.new(name: 'ResultSetMap')
43
+ RowId = Shapes::StringShape.new(name: 'RowId')
44
+ ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
45
+ ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
46
+ ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
47
+ VariableName = Shapes::StringShape.new(name: 'VariableName')
48
+ VariableValue = Shapes::StructureShape.new(name: 'VariableValue')
49
+ VariableValueMap = Shapes::MapShape.new(name: 'VariableValueMap')
50
+ WorkbookCursor = Shapes::IntegerShape.new(name: 'WorkbookCursor')
51
+
52
+ AccessDeniedException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
53
+ AccessDeniedException.struct_class = Types::AccessDeniedException
54
+
55
+ AutomationExecutionException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
56
+ AutomationExecutionException.struct_class = Types::AutomationExecutionException
57
+
58
+ AutomationExecutionTimeoutException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
59
+ AutomationExecutionTimeoutException.struct_class = Types::AutomationExecutionTimeoutException
60
+
61
+ ColumnMetadata.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
62
+ ColumnMetadata.add_member(:format, Shapes::ShapeRef.new(shape: Format, required: true, location_name: "format"))
63
+ ColumnMetadata.struct_class = Types::ColumnMetadata
64
+
65
+ DataItem.add_member(:override_format, Shapes::ShapeRef.new(shape: Format, location_name: "overrideFormat"))
66
+ DataItem.add_member(:raw_value, Shapes::ShapeRef.new(shape: RawValue, location_name: "rawValue"))
67
+ DataItem.add_member(:formatted_value, Shapes::ShapeRef.new(shape: FormattedValue, location_name: "formattedValue"))
68
+ DataItem.struct_class = Types::DataItem
69
+
70
+ DataItems.member = Shapes::ShapeRef.new(shape: DataItem)
71
+
72
+ GetScreenDataRequest.add_member(:workbook_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location_name: "workbookId"))
73
+ GetScreenDataRequest.add_member(:app_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location_name: "appId"))
74
+ GetScreenDataRequest.add_member(:screen_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location_name: "screenId"))
75
+ GetScreenDataRequest.add_member(:variables, Shapes::ShapeRef.new(shape: VariableValueMap, location_name: "variables"))
76
+ GetScreenDataRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
77
+ GetScreenDataRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken"))
78
+ GetScreenDataRequest.struct_class = Types::GetScreenDataRequest
79
+
80
+ GetScreenDataResult.add_member(:results, Shapes::ShapeRef.new(shape: ResultSetMap, required: true, location_name: "results"))
81
+ GetScreenDataResult.add_member(:workbook_cursor, Shapes::ShapeRef.new(shape: WorkbookCursor, required: true, location_name: "workbookCursor"))
82
+ GetScreenDataResult.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken"))
83
+ GetScreenDataResult.struct_class = Types::GetScreenDataResult
84
+
85
+ InternalServerException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
86
+ InternalServerException.struct_class = Types::InternalServerException
87
+
88
+ InvokeScreenAutomationRequest.add_member(:workbook_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location: "uri", location_name: "workbookId"))
89
+ InvokeScreenAutomationRequest.add_member(:app_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location: "uri", location_name: "appId"))
90
+ InvokeScreenAutomationRequest.add_member(:screen_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location: "uri", location_name: "screenId"))
91
+ InvokeScreenAutomationRequest.add_member(:screen_automation_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location: "uri", location_name: "automationId"))
92
+ InvokeScreenAutomationRequest.add_member(:variables, Shapes::ShapeRef.new(shape: VariableValueMap, location_name: "variables"))
93
+ InvokeScreenAutomationRequest.add_member(:row_id, Shapes::ShapeRef.new(shape: RowId, location_name: "rowId"))
94
+ InvokeScreenAutomationRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "clientRequestToken"))
95
+ InvokeScreenAutomationRequest.struct_class = Types::InvokeScreenAutomationRequest
96
+
97
+ InvokeScreenAutomationResult.add_member(:workbook_cursor, Shapes::ShapeRef.new(shape: WorkbookCursor, required: true, location_name: "workbookCursor"))
98
+ InvokeScreenAutomationResult.struct_class = Types::InvokeScreenAutomationResult
99
+
100
+ RequestTimeoutException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
101
+ RequestTimeoutException.struct_class = Types::RequestTimeoutException
102
+
103
+ ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
104
+ ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
105
+
106
+ ResultHeader.member = Shapes::ShapeRef.new(shape: ColumnMetadata)
107
+
108
+ ResultRow.add_member(:row_id, Shapes::ShapeRef.new(shape: RowId, location_name: "rowId"))
109
+ ResultRow.add_member(:data_items, Shapes::ShapeRef.new(shape: DataItems, required: true, location_name: "dataItems"))
110
+ ResultRow.struct_class = Types::ResultRow
111
+
112
+ ResultRows.member = Shapes::ShapeRef.new(shape: ResultRow)
113
+
114
+ ResultSet.add_member(:headers, Shapes::ShapeRef.new(shape: ResultHeader, required: true, location_name: "headers"))
115
+ ResultSet.add_member(:rows, Shapes::ShapeRef.new(shape: ResultRows, required: true, location_name: "rows"))
116
+ ResultSet.struct_class = Types::ResultSet
117
+
118
+ ResultSetMap.key = Shapes::ShapeRef.new(shape: Name)
119
+ ResultSetMap.value = Shapes::ShapeRef.new(shape: ResultSet)
120
+
121
+ ServiceUnavailableException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
122
+ ServiceUnavailableException.struct_class = Types::ServiceUnavailableException
123
+
124
+ ThrottlingException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
125
+ ThrottlingException.struct_class = Types::ThrottlingException
126
+
127
+ ValidationException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, required: true, location_name: "message"))
128
+ ValidationException.struct_class = Types::ValidationException
129
+
130
+ VariableValue.add_member(:raw_value, Shapes::ShapeRef.new(shape: RawValue, required: true, location_name: "rawValue"))
131
+ VariableValue.struct_class = Types::VariableValue
132
+
133
+ VariableValueMap.key = Shapes::ShapeRef.new(shape: VariableName)
134
+ VariableValueMap.value = Shapes::ShapeRef.new(shape: VariableValue)
135
+
136
+
137
+ # @api private
138
+ API = Seahorse::Model::Api.new.tap do |api|
139
+
140
+ api.version = "2020-03-01"
141
+
142
+ api.metadata = {
143
+ "apiVersion" => "2020-03-01",
144
+ "endpointPrefix" => "honeycode",
145
+ "jsonVersion" => "1.1",
146
+ "protocol" => "rest-json",
147
+ "serviceAbbreviation" => "Honeycode",
148
+ "serviceFullName" => "Amazon Honeycode",
149
+ "serviceId" => "Honeycode",
150
+ "signatureVersion" => "v4",
151
+ "signingName" => "honeycode",
152
+ "uid" => "honeycode-2020-03-01",
153
+ }
154
+
155
+ api.add_operation(:get_screen_data, Seahorse::Model::Operation.new.tap do |o|
156
+ o.name = "GetScreenData"
157
+ o.http_method = "POST"
158
+ o.http_request_uri = "/screendata"
159
+ o.input = Shapes::ShapeRef.new(shape: GetScreenDataRequest)
160
+ o.output = Shapes::ShapeRef.new(shape: GetScreenDataResult)
161
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
162
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
163
+ o.errors << Shapes::ShapeRef.new(shape: RequestTimeoutException)
164
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
165
+ o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
166
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
167
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
168
+ end)
169
+
170
+ api.add_operation(:invoke_screen_automation, Seahorse::Model::Operation.new.tap do |o|
171
+ o.name = "InvokeScreenAutomation"
172
+ o.http_method = "POST"
173
+ o.http_request_uri = "/workbooks/{workbookId}/apps/{appId}/screens/{screenId}/automations/{automationId}"
174
+ o.input = Shapes::ShapeRef.new(shape: InvokeScreenAutomationRequest)
175
+ o.output = Shapes::ShapeRef.new(shape: InvokeScreenAutomationResult)
176
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
177
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
178
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
179
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
180
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
181
+ o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
182
+ o.errors << Shapes::ShapeRef.new(shape: AutomationExecutionException)
183
+ o.errors << Shapes::ShapeRef.new(shape: AutomationExecutionTimeoutException)
184
+ o.errors << Shapes::ShapeRef.new(shape: RequestTimeoutException)
185
+ end)
186
+ end
187
+
188
+ end
189
+ end
@@ -0,0 +1,182 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::Honeycode
11
+
12
+ # When Honeycode returns an error response, the Ruby SDK constructs and raises an error.
13
+ # These errors all extend Aws::Honeycode::Errors::ServiceError < {Aws::Errors::ServiceError}
14
+ #
15
+ # You can rescue all Honeycode errors using ServiceError:
16
+ #
17
+ # begin
18
+ # # do stuff
19
+ # rescue Aws::Honeycode::Errors::ServiceError
20
+ # # rescues all Honeycode API errors
21
+ # end
22
+ #
23
+ #
24
+ # ## Request Context
25
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
26
+ # information about the request that generated the error.
27
+ # See {Seahorse::Client::RequestContext} for more information.
28
+ #
29
+ # ## Error Classes
30
+ # * {AccessDeniedException}
31
+ # * {AutomationExecutionException}
32
+ # * {AutomationExecutionTimeoutException}
33
+ # * {InternalServerException}
34
+ # * {RequestTimeoutException}
35
+ # * {ResourceNotFoundException}
36
+ # * {ServiceUnavailableException}
37
+ # * {ThrottlingException}
38
+ # * {ValidationException}
39
+ #
40
+ # Additionally, error classes are dynamically generated for service errors based on the error code
41
+ # if they are not defined above.
42
+ module Errors
43
+
44
+ extend Aws::Errors::DynamicErrors
45
+
46
+ class AccessDeniedException < ServiceError
47
+
48
+ # @param [Seahorse::Client::RequestContext] context
49
+ # @param [String] message
50
+ # @param [Aws::Honeycode::Types::AccessDeniedException] data
51
+ def initialize(context, message, data = Aws::EmptyStructure.new)
52
+ super(context, message, data)
53
+ end
54
+
55
+ # @return [String]
56
+ def message
57
+ @message || @data[:message]
58
+ end
59
+ end
60
+
61
+ class AutomationExecutionException < ServiceError
62
+
63
+ # @param [Seahorse::Client::RequestContext] context
64
+ # @param [String] message
65
+ # @param [Aws::Honeycode::Types::AutomationExecutionException] data
66
+ def initialize(context, message, data = Aws::EmptyStructure.new)
67
+ super(context, message, data)
68
+ end
69
+
70
+ # @return [String]
71
+ def message
72
+ @message || @data[:message]
73
+ end
74
+ end
75
+
76
+ class AutomationExecutionTimeoutException < ServiceError
77
+
78
+ # @param [Seahorse::Client::RequestContext] context
79
+ # @param [String] message
80
+ # @param [Aws::Honeycode::Types::AutomationExecutionTimeoutException] data
81
+ def initialize(context, message, data = Aws::EmptyStructure.new)
82
+ super(context, message, data)
83
+ end
84
+
85
+ # @return [String]
86
+ def message
87
+ @message || @data[:message]
88
+ end
89
+ end
90
+
91
+ class InternalServerException < ServiceError
92
+
93
+ # @param [Seahorse::Client::RequestContext] context
94
+ # @param [String] message
95
+ # @param [Aws::Honeycode::Types::InternalServerException] data
96
+ def initialize(context, message, data = Aws::EmptyStructure.new)
97
+ super(context, message, data)
98
+ end
99
+
100
+ # @return [String]
101
+ def message
102
+ @message || @data[:message]
103
+ end
104
+ end
105
+
106
+ class RequestTimeoutException < ServiceError
107
+
108
+ # @param [Seahorse::Client::RequestContext] context
109
+ # @param [String] message
110
+ # @param [Aws::Honeycode::Types::RequestTimeoutException] data
111
+ def initialize(context, message, data = Aws::EmptyStructure.new)
112
+ super(context, message, data)
113
+ end
114
+
115
+ # @return [String]
116
+ def message
117
+ @message || @data[:message]
118
+ end
119
+ end
120
+
121
+ class ResourceNotFoundException < ServiceError
122
+
123
+ # @param [Seahorse::Client::RequestContext] context
124
+ # @param [String] message
125
+ # @param [Aws::Honeycode::Types::ResourceNotFoundException] data
126
+ def initialize(context, message, data = Aws::EmptyStructure.new)
127
+ super(context, message, data)
128
+ end
129
+
130
+ # @return [String]
131
+ def message
132
+ @message || @data[:message]
133
+ end
134
+ end
135
+
136
+ class ServiceUnavailableException < ServiceError
137
+
138
+ # @param [Seahorse::Client::RequestContext] context
139
+ # @param [String] message
140
+ # @param [Aws::Honeycode::Types::ServiceUnavailableException] data
141
+ def initialize(context, message, data = Aws::EmptyStructure.new)
142
+ super(context, message, data)
143
+ end
144
+
145
+ # @return [String]
146
+ def message
147
+ @message || @data[:message]
148
+ end
149
+ end
150
+
151
+ class ThrottlingException < ServiceError
152
+
153
+ # @param [Seahorse::Client::RequestContext] context
154
+ # @param [String] message
155
+ # @param [Aws::Honeycode::Types::ThrottlingException] data
156
+ def initialize(context, message, data = Aws::EmptyStructure.new)
157
+ super(context, message, data)
158
+ end
159
+
160
+ # @return [String]
161
+ def message
162
+ @message || @data[:message]
163
+ end
164
+ end
165
+
166
+ class ValidationException < ServiceError
167
+
168
+ # @param [Seahorse::Client::RequestContext] context
169
+ # @param [String] message
170
+ # @param [Aws::Honeycode::Types::ValidationException] data
171
+ def initialize(context, message, data = Aws::EmptyStructure.new)
172
+ super(context, message, data)
173
+ end
174
+
175
+ # @return [String]
176
+ def message
177
+ @message || @data[:message]
178
+ end
179
+ end
180
+
181
+ end
182
+ end
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::Honeycode
11
+
12
+ class Resource
13
+
14
+ # @param options ({})
15
+ # @option options [Client] :client
16
+ def initialize(options = {})
17
+ @client = options[:client] || Client.new(options)
18
+ end
19
+
20
+ # @return [Client]
21
+ def client
22
+ @client
23
+ end
24
+
25
+ end
26
+ end
@@ -0,0 +1,435 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::Honeycode
11
+ module Types
12
+
13
+ # You do not have sufficient access to perform this action. Check that
14
+ # the workbook is owned by you and your IAM policy allows access to the
15
+ # screen/automation in the request.
16
+ #
17
+ # @!attribute [rw] message
18
+ # @return [String]
19
+ #
20
+ # @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/AccessDeniedException AWS API Documentation
21
+ #
22
+ class AccessDeniedException < Struct.new(
23
+ :message)
24
+ SENSITIVE = []
25
+ include Aws::Structure
26
+ end
27
+
28
+ # The automation execution did not end successfully.
29
+ #
30
+ # @!attribute [rw] message
31
+ # @return [String]
32
+ #
33
+ # @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/AutomationExecutionException AWS API Documentation
34
+ #
35
+ class AutomationExecutionException < Struct.new(
36
+ :message)
37
+ SENSITIVE = []
38
+ include Aws::Structure
39
+ end
40
+
41
+ # The automation execution timed out.
42
+ #
43
+ # @!attribute [rw] message
44
+ # @return [String]
45
+ #
46
+ # @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/AutomationExecutionTimeoutException AWS API Documentation
47
+ #
48
+ class AutomationExecutionTimeoutException < Struct.new(
49
+ :message)
50
+ SENSITIVE = []
51
+ include Aws::Structure
52
+ end
53
+
54
+ # Metadata for column in the table.
55
+ #
56
+ # @!attribute [rw] name
57
+ # The name of the column.
58
+ # @return [String]
59
+ #
60
+ # @!attribute [rw] format
61
+ # The format of the column.
62
+ # @return [String]
63
+ #
64
+ # @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/ColumnMetadata AWS API Documentation
65
+ #
66
+ class ColumnMetadata < Struct.new(
67
+ :name,
68
+ :format)
69
+ SENSITIVE = [:name]
70
+ include Aws::Structure
71
+ end
72
+
73
+ # The data in a particular data cell defined on the screen.
74
+ #
75
+ # @!attribute [rw] override_format
76
+ # The overrideFormat is optional and is specified only if a particular
77
+ # row of data has a different format for the data than the default
78
+ # format defined on the screen or the table.
79
+ # @return [String]
80
+ #
81
+ # @!attribute [rw] raw_value
82
+ # The raw value of the data. e.g. jsmith@example.com
83
+ # @return [String]
84
+ #
85
+ # @!attribute [rw] formatted_value
86
+ # The formatted value of the data. e.g. John Smith.
87
+ # @return [String]
88
+ #
89
+ # @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/DataItem AWS API Documentation
90
+ #
91
+ class DataItem < Struct.new(
92
+ :override_format,
93
+ :raw_value,
94
+ :formatted_value)
95
+ SENSITIVE = []
96
+ include Aws::Structure
97
+ end
98
+
99
+ # @note When making an API call, you may pass GetScreenDataRequest
100
+ # data as a hash:
101
+ #
102
+ # {
103
+ # workbook_id: "ResourceId", # required
104
+ # app_id: "ResourceId", # required
105
+ # screen_id: "ResourceId", # required
106
+ # variables: {
107
+ # "VariableName" => {
108
+ # raw_value: "RawValue", # required
109
+ # },
110
+ # },
111
+ # max_results: 1,
112
+ # next_token: "PaginationToken",
113
+ # }
114
+ #
115
+ # @!attribute [rw] workbook_id
116
+ # The ID of the workbook that contains the screen.
117
+ # @return [String]
118
+ #
119
+ # @!attribute [rw] app_id
120
+ # The ID of the app that contains the screem.
121
+ # @return [String]
122
+ #
123
+ # @!attribute [rw] screen_id
124
+ # The ID of the screen.
125
+ # @return [String]
126
+ #
127
+ # @!attribute [rw] variables
128
+ # Variables are optional and are needed only if the screen requires
129
+ # them to render correctly. Variables are specified as a map where the
130
+ # key is the name of the variable as defined on the screen. The value
131
+ # is an object which currently has only one property, rawValue, which
132
+ # holds the value of the variable to be passed to the screen.
133
+ # @return [Hash<String,Types::VariableValue>]
134
+ #
135
+ # @!attribute [rw] max_results
136
+ # The number of results to be returned on a single page. Specify a
137
+ # number between 1 and 100. The maximum value is 100.
138
+ #
139
+ # This parameter is optional. If you don't specify this parameter,
140
+ # the default page size is 100.
141
+ # @return [Integer]
142
+ #
143
+ # @!attribute [rw] next_token
144
+ # This parameter is optional. If a nextToken is not specified, the API
145
+ # returns the first page of data.
146
+ #
147
+ # Pagination tokens expire after 1 hour. If you use a token that was
148
+ # returned more than an hour back, the API will throw
149
+ # ValidationException.
150
+ # @return [String]
151
+ #
152
+ # @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/GetScreenDataRequest AWS API Documentation
153
+ #
154
+ class GetScreenDataRequest < Struct.new(
155
+ :workbook_id,
156
+ :app_id,
157
+ :screen_id,
158
+ :variables,
159
+ :max_results,
160
+ :next_token)
161
+ SENSITIVE = [:variables]
162
+ include Aws::Structure
163
+ end
164
+
165
+ # @!attribute [rw] results
166
+ # A map of all the rows on the screen keyed by block name.
167
+ # @return [Hash<String,Types::ResultSet>]
168
+ #
169
+ # @!attribute [rw] workbook_cursor
170
+ # Indicates the cursor of the workbook at which the data returned by
171
+ # this workbook is read. Workbook cursor keeps increasing with every
172
+ # update and the increments are not sequential.
173
+ # @return [Integer]
174
+ #
175
+ # @!attribute [rw] next_token
176
+ # Provides the pagination token to load the next page if there are
177
+ # more results matching the request. If a pagination token is not
178
+ # present in the response, it means that all data matching the query
179
+ # has been loaded.
180
+ # @return [String]
181
+ #
182
+ # @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/GetScreenDataResult AWS API Documentation
183
+ #
184
+ class GetScreenDataResult < Struct.new(
185
+ :results,
186
+ :workbook_cursor,
187
+ :next_token)
188
+ SENSITIVE = []
189
+ include Aws::Structure
190
+ end
191
+
192
+ # There were unexpected errors from the server.
193
+ #
194
+ # @!attribute [rw] message
195
+ # @return [String]
196
+ #
197
+ # @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/InternalServerException AWS API Documentation
198
+ #
199
+ class InternalServerException < Struct.new(
200
+ :message)
201
+ SENSITIVE = []
202
+ include Aws::Structure
203
+ end
204
+
205
+ # @note When making an API call, you may pass InvokeScreenAutomationRequest
206
+ # data as a hash:
207
+ #
208
+ # {
209
+ # workbook_id: "ResourceId", # required
210
+ # app_id: "ResourceId", # required
211
+ # screen_id: "ResourceId", # required
212
+ # screen_automation_id: "ResourceId", # required
213
+ # variables: {
214
+ # "VariableName" => {
215
+ # raw_value: "RawValue", # required
216
+ # },
217
+ # },
218
+ # row_id: "RowId",
219
+ # client_request_token: "ClientRequestToken",
220
+ # }
221
+ #
222
+ # @!attribute [rw] workbook_id
223
+ # The ID of the workbook that contains the screen automation.
224
+ # @return [String]
225
+ #
226
+ # @!attribute [rw] app_id
227
+ # The ID of the app that contains the screen automation.
228
+ # @return [String]
229
+ #
230
+ # @!attribute [rw] screen_id
231
+ # The ID of the screen that contains the screen automation.
232
+ # @return [String]
233
+ #
234
+ # @!attribute [rw] screen_automation_id
235
+ # The ID of the automation action to be performed.
236
+ # @return [String]
237
+ #
238
+ # @!attribute [rw] variables
239
+ # Variables are optional and are needed only if the screen requires
240
+ # them to render correctly. Variables are specified as a map where the
241
+ # key is the name of the variable as defined on the screen. The value
242
+ # is an object which currently has only one property, rawValue, which
243
+ # holds the value of the variable to be passed to the screen.
244
+ # @return [Hash<String,Types::VariableValue>]
245
+ #
246
+ # @!attribute [rw] row_id
247
+ # The row ID for the automation if the automation is defined inside a
248
+ # block with source or list.
249
+ # @return [String]
250
+ #
251
+ # @!attribute [rw] client_request_token
252
+ # The request token for performing the automation action. Request
253
+ # tokens help to identify duplicate requests. If a call times out or
254
+ # fails due to a transient error like a failed network connection, you
255
+ # can retry the call with the same request token. The service ensures
256
+ # that if the first call using that request token is successfully
257
+ # performed, the second call will return the response of the previous
258
+ # call rather than performing the action again.
259
+ #
260
+ # Note that request tokens are valid only for a few minutes. You
261
+ # cannot use request tokens to dedupe requests spanning hours or days.
262
+ # @return [String]
263
+ #
264
+ # @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/InvokeScreenAutomationRequest AWS API Documentation
265
+ #
266
+ class InvokeScreenAutomationRequest < Struct.new(
267
+ :workbook_id,
268
+ :app_id,
269
+ :screen_id,
270
+ :screen_automation_id,
271
+ :variables,
272
+ :row_id,
273
+ :client_request_token)
274
+ SENSITIVE = [:variables]
275
+ include Aws::Structure
276
+ end
277
+
278
+ # @!attribute [rw] workbook_cursor
279
+ # The updated workbook cursor after performing the automation action.
280
+ # @return [Integer]
281
+ #
282
+ # @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/InvokeScreenAutomationResult AWS API Documentation
283
+ #
284
+ class InvokeScreenAutomationResult < Struct.new(
285
+ :workbook_cursor)
286
+ SENSITIVE = []
287
+ include Aws::Structure
288
+ end
289
+
290
+ # The request timed out.
291
+ #
292
+ # @!attribute [rw] message
293
+ # @return [String]
294
+ #
295
+ # @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/RequestTimeoutException AWS API Documentation
296
+ #
297
+ class RequestTimeoutException < Struct.new(
298
+ :message)
299
+ SENSITIVE = []
300
+ include Aws::Structure
301
+ end
302
+
303
+ # A Workbook, App, Screen or Screen Automation was not found with the
304
+ # given ID.
305
+ #
306
+ # @!attribute [rw] message
307
+ # @return [String]
308
+ #
309
+ # @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/ResourceNotFoundException AWS API Documentation
310
+ #
311
+ class ResourceNotFoundException < Struct.new(
312
+ :message)
313
+ SENSITIVE = []
314
+ include Aws::Structure
315
+ end
316
+
317
+ # A single row in the ResultSet.
318
+ #
319
+ # @!attribute [rw] row_id
320
+ # The ID for a particular row.
321
+ # @return [String]
322
+ #
323
+ # @!attribute [rw] data_items
324
+ # List of all the data cells in a row.
325
+ # @return [Array<Types::DataItem>]
326
+ #
327
+ # @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/ResultRow AWS API Documentation
328
+ #
329
+ class ResultRow < Struct.new(
330
+ :row_id,
331
+ :data_items)
332
+ SENSITIVE = []
333
+ include Aws::Structure
334
+ end
335
+
336
+ # ResultSet contains the results of the request for a single block or
337
+ # list defined on the screen.
338
+ #
339
+ # @!attribute [rw] headers
340
+ # List of headers for all the data cells in the block. The header
341
+ # identifies the name and default format of the data cell. Data cells
342
+ # appear in the same order in all rows as defined in the header. The
343
+ # names and formats are not repeated in the rows. If a particular row
344
+ # does not have a value for a data cell, a blank value is used.
345
+ #
346
+ # For example, a task list that displays the task name, due date and
347
+ # assigned person might have headers \[ \\\{ "name": "Task
348
+ # Name"\\}, \\\{"name": "Due Date", "format": "DATE"\\},
349
+ # \\\{"name": "Assigned", "format": "CONTACT"\\} \]. Every row
350
+ # in the result will have the task name as the first item, due date as
351
+ # the second item and assigned person as the third item. If a
352
+ # particular task does not have a due date, that row will still have a
353
+ # blank value in the second element and the assigned person will still
354
+ # be in the third element.
355
+ # @return [Array<Types::ColumnMetadata>]
356
+ #
357
+ # @!attribute [rw] rows
358
+ # List of rows returned by the request. Each row has a row Id and a
359
+ # list of data cells in that row. The data cells will be present in
360
+ # the same order as they are defined in the header.
361
+ # @return [Array<Types::ResultRow>]
362
+ #
363
+ # @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/ResultSet AWS API Documentation
364
+ #
365
+ class ResultSet < Struct.new(
366
+ :headers,
367
+ :rows)
368
+ SENSITIVE = []
369
+ include Aws::Structure
370
+ end
371
+
372
+ # Remote service is unreachable.
373
+ #
374
+ # @!attribute [rw] message
375
+ # @return [String]
376
+ #
377
+ # @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/ServiceUnavailableException AWS API Documentation
378
+ #
379
+ class ServiceUnavailableException < Struct.new(
380
+ :message)
381
+ SENSITIVE = []
382
+ include Aws::Structure
383
+ end
384
+
385
+ # Tps(transactions per second) rate reached.
386
+ #
387
+ # @!attribute [rw] message
388
+ # @return [String]
389
+ #
390
+ # @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/ThrottlingException AWS API Documentation
391
+ #
392
+ class ThrottlingException < Struct.new(
393
+ :message)
394
+ SENSITIVE = []
395
+ include Aws::Structure
396
+ end
397
+
398
+ # Request is invalid. The message in the response contains details on
399
+ # why the request is invalid.
400
+ #
401
+ # @!attribute [rw] message
402
+ # @return [String]
403
+ #
404
+ # @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/ValidationException AWS API Documentation
405
+ #
406
+ class ValidationException < Struct.new(
407
+ :message)
408
+ SENSITIVE = []
409
+ include Aws::Structure
410
+ end
411
+
412
+ # The input variables to the app to be used by the
413
+ # InvokeScreenAutomation action request.
414
+ #
415
+ # @note When making an API call, you may pass VariableValue
416
+ # data as a hash:
417
+ #
418
+ # {
419
+ # raw_value: "RawValue", # required
420
+ # }
421
+ #
422
+ # @!attribute [rw] raw_value
423
+ # Raw value of the variable.
424
+ # @return [String]
425
+ #
426
+ # @see http://docs.aws.amazon.com/goto/WebAPI/honeycode-2020-03-01/VariableValue AWS API Documentation
427
+ #
428
+ class VariableValue < Struct.new(
429
+ :raw_value)
430
+ SENSITIVE = []
431
+ include Aws::Structure
432
+ end
433
+
434
+ end
435
+ end