Class: Aws::AlexaForBusiness::Types::ListDeviceEventsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AlexaForBusiness::Types::ListDeviceEventsRequest
- Defined in:
- gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb
Overview
When making an API call, you may pass ListDeviceEventsRequest data as a hash:
{
device_arn: "Arn", # required
event_type: "CONNECTION_STATUS", # accepts CONNECTION_STATUS, DEVICE_STATUS
next_token: "NextToken",
max_results: 1,
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#device_arn ⇒ String
The ARN of a device.
-
#event_type ⇒ String
The event type to filter device events.
-
#max_results ⇒ Integer
The maximum number of results to include in the response.
-
#next_token ⇒ String
An optional token returned from a prior request.
Instance Attribute Details
#device_arn ⇒ String
The ARN of a device.
3307 3308 3309 3310 3311 3312 3313 3314 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 3307 class ListDeviceEventsRequest < Struct.new( :device_arn, :event_type, :next_token, :max_results) SENSITIVE = [] include Aws::Structure end |
#event_type ⇒ String
The event type to filter device events. If EventType isn't specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.
3307 3308 3309 3310 3311 3312 3313 3314 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 3307 class ListDeviceEventsRequest < Struct.new( :device_arn, :event_type, :next_token, :max_results) SENSITIVE = [] include Aws::Structure end |
#max_results ⇒ Integer
The maximum number of results to include in the response. The default value is 50. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
3307 3308 3309 3310 3311 3312 3313 3314 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 3307 class ListDeviceEventsRequest < Struct.new( :device_arn, :event_type, :next_token, :max_results) SENSITIVE = [] include Aws::Structure end |
#next_token ⇒ String
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.
3307 3308 3309 3310 3311 3312 3313 3314 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 3307 class ListDeviceEventsRequest < Struct.new( :device_arn, :event_type, :next_token, :max_results) SENSITIVE = [] include Aws::Structure end |