Class: Aws::Kafka::Types::DescribeAssessmentResponse

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

Overview

Returns the status and summary of an assessment.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#assessment_arn ⇒ String

The Amazon Resource Name (ARN) of the assessment.

Returns:

  • (String)


2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2116

class DescribeAssessmentResponse < Struct.new(
  :assessment_arn,
  :assessment_parameters,
  :assessment_type,
  :cluster_arn,
  :completion_time,
  :creation_time,
  :status,
  :status_message,
  :summary,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#assessment_parameters ⇒ Types::AssessmentParameters

The parameters that were provided when creating the assessment.



2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2116

class DescribeAssessmentResponse < Struct.new(
  :assessment_arn,
  :assessment_parameters,
  :assessment_type,
  :cluster_arn,
  :completion_time,
  :creation_time,
  :status,
  :status_message,
  :summary,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#assessment_type ⇒ String

The type of assessment.

Returns:

  • (String)


2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2116

class DescribeAssessmentResponse < Struct.new(
  :assessment_arn,
  :assessment_parameters,
  :assessment_type,
  :cluster_arn,
  :completion_time,
  :creation_time,
  :status,
  :status_message,
  :summary,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_arn ⇒ String

The Amazon Resource Name (ARN) of the cluster that was assessed.

Returns:

  • (String)


2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2116

class DescribeAssessmentResponse < Struct.new(
  :assessment_arn,
  :assessment_parameters,
  :assessment_type,
  :cluster_arn,
  :completion_time,
  :creation_time,
  :status,
  :status_message,
  :summary,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#completion_time ⇒ Time

The time when the assessment completed. Present only when status is COMPLETE or FAILED.

Returns:

  • (Time)


2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2116

class DescribeAssessmentResponse < Struct.new(
  :assessment_arn,
  :assessment_parameters,
  :assessment_type,
  :cluster_arn,
  :completion_time,
  :creation_time,
  :status,
  :status_message,
  :summary,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The time when the assessment was created.

Returns:

  • (Time)


2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2116

class DescribeAssessmentResponse < Struct.new(
  :assessment_arn,
  :assessment_parameters,
  :assessment_type,
  :cluster_arn,
  :completion_time,
  :creation_time,
  :status,
  :status_message,
  :summary,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the assessment.

Returns:

  • (String)


2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2116

class DescribeAssessmentResponse < Struct.new(
  :assessment_arn,
  :assessment_parameters,
  :assessment_type,
  :cluster_arn,
  :completion_time,
  :creation_time,
  :status,
  :status_message,
  :summary,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

Additional information about the current status. Present when status is FAILED.

Returns:

  • (String)


2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2116

class DescribeAssessmentResponse < Struct.new(
  :assessment_arn,
  :assessment_parameters,
  :assessment_type,
  :cluster_arn,
  :completion_time,
  :creation_time,
  :status,
  :status_message,
  :summary,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#summary ⇒ Types::AssessmentSummary

Summary of findings by category and severity. Present only when status is COMPLETE.



2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2116

class DescribeAssessmentResponse < Struct.new(
  :assessment_arn,
  :assessment_parameters,
  :assessment_type,
  :cluster_arn,
  :completion_time,
  :creation_time,
  :status,
  :status_message,
  :summary,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags attached to the assessment.

Returns:

  • (Hash<String,String>)


2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2116

class DescribeAssessmentResponse < Struct.new(
  :assessment_arn,
  :assessment_parameters,
  :assessment_type,
  :cluster_arn,
  :completion_time,
  :creation_time,
  :status,
  :status_message,
  :summary,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end