You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::AlexaForBusiness::Types::ListDeviceEventsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb

Overview

Note:

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,
}

Instance Attribute Summary collapse

Instance Attribute Details

#device_arnString

The ARN of a device.

Returns:

  • (String)


2858
2859
2860
2861
2862
2863
2864
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 2858

class ListDeviceEventsRequest < Struct.new(
  :device_arn,
  :event_type,
  :next_token,
  :max_results)
  include Aws::Structure
end

#event_typeString

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.

Returns:

  • (String)


2858
2859
2860
2861
2862
2863
2864
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 2858

class ListDeviceEventsRequest < Struct.new(
  :device_arn,
  :event_type,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

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.

Returns:

  • (Integer)


2858
2859
2860
2861
2862
2863
2864
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 2858

class ListDeviceEventsRequest < Struct.new(
  :device_arn,
  :event_type,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

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.

Returns:

  • (String)


2858
2859
2860
2861
2862
2863
2864
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 2858

class ListDeviceEventsRequest < Struct.new(
  :device_arn,
  :event_type,
  :next_token,
  :max_results)
  include Aws::Structure
end