Class: Aws::AccessAnalyzer::Types::AccessPreviewSummary

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

Overview

Contains a summary of information about an access preview.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#analyzer_arnString

The ARN of the analyzer used to generate the access preview.

Returns:

  • (String)


261
262
263
264
265
266
267
268
269
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 261

class AccessPreviewSummary < Struct.new(
  :id,
  :analyzer_arn,
  :created_at,
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#created_atTime

The time at which the access preview was created.

Returns:

  • (Time)


261
262
263
264
265
266
267
268
269
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 261

class AccessPreviewSummary < Struct.new(
  :id,
  :analyzer_arn,
  :created_at,
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The unique ID for the access preview.

Returns:

  • (String)


261
262
263
264
265
266
267
268
269
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 261

class AccessPreviewSummary < Struct.new(
  :id,
  :analyzer_arn,
  :created_at,
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the access preview.

  • Creating - The access preview creation is in progress.

  • Completed - The access preview is complete and previews the findings for external access to the resource.

  • Failed - The access preview creation has failed.

Returns:

  • (String)


261
262
263
264
265
266
267
268
269
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 261

class AccessPreviewSummary < Struct.new(
  :id,
  :analyzer_arn,
  :created_at,
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end

#status_reasonTypes::AccessPreviewStatusReason

Provides more details about the current status of the access preview. For example, if the creation of the access preview fails, a Failed status is returned. This failure can be due to an internal issue with the analysis or due to an invalid proposed resource configuration.



261
262
263
264
265
266
267
268
269
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 261

class AccessPreviewSummary < Struct.new(
  :id,
  :analyzer_arn,
  :created_at,
  :status,
  :status_reason)
  SENSITIVE = []
  include Aws::Structure
end