Class: Aws::GreengrassV2::Types::ListCoreDevicesRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

The maximum number of results to be returned per paginated request.

Returns:

  • (Integer)


2463
2464
2465
2466
2467
2468
2469
2470
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 2463

class ListCoreDevicesRequest < Struct.new(
  :thing_group_arn,
  :status,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The token to be used for the next set of paginated results.

Returns:

  • (String)


2463
2464
2465
2466
2467
2468
2469
2470
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 2463

class ListCoreDevicesRequest < Struct.new(
  :thing_group_arn,
  :status,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The core device status by which to filter. If you specify this parameter, the list includes only core devices that have this status. Choose one of the following options:

  • HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.

  • UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.

Returns:

  • (String)


2463
2464
2465
2466
2467
2468
2469
2470
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 2463

class ListCoreDevicesRequest < Struct.new(
  :thing_group_arn,
  :status,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#thing_group_arnString

The ARN of the IoT thing group by which to filter. If you specify this parameter, the list includes only core devices that have successfully deployed a deployment that targets the thing group. When you remove a core device from a thing group, the list continues to include that core device.

Returns:

  • (String)


2463
2464
2465
2466
2467
2468
2469
2470
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 2463

class ListCoreDevicesRequest < Struct.new(
  :thing_group_arn,
  :status,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end