Class: Aws::GreengrassV2::Types::CloudComponentStatus

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

Overview

Contains the status of a component version in the IoT Greengrass service.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#component_stateString

The state of the component version.

Returns:

  • (String)


305
306
307
308
309
310
311
312
313
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 305

class CloudComponentStatus < Struct.new(
  :component_state,
  :message,
  :errors,
  :vendor_guidance,
  :vendor_guidance_message)
  SENSITIVE = []
  include Aws::Structure
end

#errorsHash<String,String>

A dictionary of errors that communicate why the component version is in an error state. For example, if IoT Greengrass can't access an artifact for the component version, then errors contains the artifact's URI as a key, and the error message as the value for that key.

Returns:

  • (Hash<String,String>)


305
306
307
308
309
310
311
312
313
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 305

class CloudComponentStatus < Struct.new(
  :component_state,
  :message,
  :errors,
  :vendor_guidance,
  :vendor_guidance_message)
  SENSITIVE = []
  include Aws::Structure
end

#messageString

A message that communicates details, such as errors, about the status of the component version.

Returns:

  • (String)


305
306
307
308
309
310
311
312
313
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 305

class CloudComponentStatus < Struct.new(
  :component_state,
  :message,
  :errors,
  :vendor_guidance,
  :vendor_guidance_message)
  SENSITIVE = []
  include Aws::Structure
end

#vendor_guidanceString

The vendor guidance state for the component version. This state indicates whether the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:

  • ACTIVE – This component version is available and recommended for use.

  • DISCONTINUED – This component version has been discontinued by its publisher. You can deploy this component version, but we recommend that you use a different version of this component.

  • DELETED – This component version has been deleted by its publisher, so you can't deploy it. If you have any existing deployments that specify this component version, those deployments will fail.

Returns:

  • (String)


305
306
307
308
309
310
311
312
313
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 305

class CloudComponentStatus < Struct.new(
  :component_state,
  :message,
  :errors,
  :vendor_guidance,
  :vendor_guidance_message)
  SENSITIVE = []
  include Aws::Structure
end

#vendor_guidance_messageString

A message that communicates details about the vendor guidance state of the component version. This message communicates why a component version is discontinued or deleted.

Returns:

  • (String)


305
306
307
308
309
310
311
312
313
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 305

class CloudComponentStatus < Struct.new(
  :component_state,
  :message,
  :errors,
  :vendor_guidance,
  :vendor_guidance_message)
  SENSITIVE = []
  include Aws::Structure
end