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

Inherits:

Struct

• Object
• Struct
• Aws::GreengrassV2::Types::ListCoreDevicesRequest

Defined in:

gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #max_results ⇒ Integer

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

• #next_token ⇒ String

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

• #status ⇒ String

  The core device status by which to filter.

• #thing_group_arn ⇒ String

  The [ARN][1] of the IoT thing group by which to filter.

Instance Attribute Details

#max_results ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 2490

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

#next_token ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 2490

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

#status ⇒ String

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)

# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 2490

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

#thing_group_arn ⇒ String

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)

# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 2490

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