Class: Aws::GreengrassV2::Types::EffectiveDeployment

Inherits:

Struct

• Object
• Struct
• Aws::GreengrassV2::Types::EffectiveDeployment

Includes:

Structure

Defined in:

lib/aws-sdk-greengrassv2/types.rb

Overview

Contains information about a deployment job that IoT Greengrass sends to a Greengrass core device.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #core_device_execution_status ⇒ String

  The status of the deployment job on the Greengrass core device.

• #creation_timestamp ⇒ Time

  The time at which the deployment was created, expressed in ISO 8601 format.

• #deployment_id ⇒ String

  The ID of the deployment.

• #deployment_name ⇒ String

  The name of the deployment.

• #description ⇒ String

  The description of the deployment job.

• #iot_job_arn ⇒ String

  The [ARN] of the IoT job that applies the deployment to target devices.

• #iot_job_id ⇒ String

  The ID of the IoT job that applies the deployment to target devices.

• #modified_timestamp ⇒ Time

  The time at which the deployment job was last modified, expressed in ISO 8601 format.

• #reason ⇒ String

  The reason code for the update, if the job was updated.

• #status_details ⇒ Types::EffectiveDeploymentStatusDetails

  The status details that explain why a deployment has an error.

• #target_arn ⇒ String

  The [ARN] of the target IoT thing or thing group.

Instance Attribute Details

#core_device_execution_status ⇒ String

The status of the deployment job on the Greengrass core device.

• ‘IN_PROGRESS` – The deployment job is running.

• ‘QUEUED` – The deployment job is in the job queue and waiting to run.

• ‘FAILED` – The deployment failed. For more information, see the `statusDetails` field.

• ‘COMPLETED` – The deployment to an IoT thing was completed successfully.

• ‘TIMED_OUT` – The deployment didn’t complete in the allotted time.

• ‘CANCELED` – The deployment was canceled by the user.

• ‘REJECTED` – The deployment was rejected. For more information, see the `statusDetails` field.

• ‘SUCCEEDED` – The deployment to an IoT thing group was completed successfully.

Returns:

• (String)

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

class EffectiveDeployment < Struct.new(
  :deployment_id,
  :deployment_name,
  :iot_job_id,
  :iot_job_arn,
  :description,
  :target_arn,
  :core_device_execution_status,
  :reason,
  :creation_timestamp,
  :modified_timestamp,
  :status_details)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timestamp ⇒ Time

The time at which the deployment was created, expressed in ISO 8601 format.

Returns:

• (Time)

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

class EffectiveDeployment < Struct.new(
  :deployment_id,
  :deployment_name,
  :iot_job_id,
  :iot_job_arn,
  :description,
  :target_arn,
  :core_device_execution_status,
  :reason,
  :creation_timestamp,
  :modified_timestamp,
  :status_details)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_id ⇒ String

The ID of the deployment.

Returns:

• (String)

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

class EffectiveDeployment < Struct.new(
  :deployment_id,
  :deployment_name,
  :iot_job_id,
  :iot_job_arn,
  :description,
  :target_arn,
  :core_device_execution_status,
  :reason,
  :creation_timestamp,
  :modified_timestamp,
  :status_details)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_name ⇒ String

The name of the deployment.

Returns:

• (String)

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

class EffectiveDeployment < Struct.new(
  :deployment_id,
  :deployment_name,
  :iot_job_id,
  :iot_job_arn,
  :description,
  :target_arn,
  :core_device_execution_status,
  :reason,
  :creation_timestamp,
  :modified_timestamp,
  :status_details)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the deployment job.

Returns:

• (String)

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

class EffectiveDeployment < Struct.new(
  :deployment_id,
  :deployment_name,
  :iot_job_id,
  :iot_job_arn,
  :description,
  :target_arn,
  :core_device_execution_status,
  :reason,
  :creation_timestamp,
  :modified_timestamp,
  :status_details)
  SENSITIVE = []
  include Aws::Structure
end

#iot_job_arn ⇒ String

The [ARN] of the IoT job that applies the deployment to target devices.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

• (String)

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

class EffectiveDeployment < Struct.new(
  :deployment_id,
  :deployment_name,
  :iot_job_id,
  :iot_job_arn,
  :description,
  :target_arn,
  :core_device_execution_status,
  :reason,
  :creation_timestamp,
  :modified_timestamp,
  :status_details)
  SENSITIVE = []
  include Aws::Structure
end

#iot_job_id ⇒ String

The ID of the IoT job that applies the deployment to target devices.

Returns:

• (String)

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

class EffectiveDeployment < Struct.new(
  :deployment_id,
  :deployment_name,
  :iot_job_id,
  :iot_job_arn,
  :description,
  :target_arn,
  :core_device_execution_status,
  :reason,
  :creation_timestamp,
  :modified_timestamp,
  :status_details)
  SENSITIVE = []
  include Aws::Structure
end

#modified_timestamp ⇒ Time

The time at which the deployment job was last modified, expressed in ISO 8601 format.

Returns:

• (Time)

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

class EffectiveDeployment < Struct.new(
  :deployment_id,
  :deployment_name,
  :iot_job_id,
  :iot_job_arn,
  :description,
  :target_arn,
  :core_device_execution_status,
  :reason,
  :creation_timestamp,
  :modified_timestamp,
  :status_details)
  SENSITIVE = []
  include Aws::Structure
end

#reason ⇒ String

The reason code for the update, if the job was updated.

Returns:

• (String)

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

class EffectiveDeployment < Struct.new(
  :deployment_id,
  :deployment_name,
  :iot_job_id,
  :iot_job_arn,
  :description,
  :target_arn,
  :core_device_execution_status,
  :reason,
  :creation_timestamp,
  :modified_timestamp,
  :status_details)
  SENSITIVE = []
  include Aws::Structure
end

#status_details ⇒ Types::EffectiveDeploymentStatusDetails

The status details that explain why a deployment has an error. This response will be null if the deployment is in a success state.

Returns:

• (Types::EffectiveDeploymentStatusDetails)

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

class EffectiveDeployment < Struct.new(
  :deployment_id,
  :deployment_name,
  :iot_job_id,
  :iot_job_arn,
  :description,
  :target_arn,
  :core_device_execution_status,
  :reason,
  :creation_timestamp,
  :modified_timestamp,
  :status_details)
  SENSITIVE = []
  include Aws::Structure
end

#target_arn ⇒ String

The [ARN] of the target IoT thing or thing group.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

• (String)

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

class EffectiveDeployment < Struct.new(
  :deployment_id,
  :deployment_name,
  :iot_job_id,
  :iot_job_arn,
  :description,
  :target_arn,
  :core_device_execution_status,
  :reason,
  :creation_timestamp,
  :modified_timestamp,
  :status_details)
  SENSITIVE = []
  include Aws::Structure
end