AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::QuickSight::Types::DeleteAnalysisRequest

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

Overview

Note:

When making an API call, you may pass DeleteAnalysisRequest data as a hash:

{
  aws_account_id: "AwsAccountId", # required
  analysis_id: "RestrictiveResourceId", # required
  recovery_window_in_days: 1,
  force_delete_without_recovery: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#analysis_idString

The ID of the analysis that you're deleting.

Returns:

  • (String)


4392
4393
4394
4395
4396
4397
4398
4399
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 4392

class DeleteAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :recovery_window_in_days,
  :force_delete_without_recovery)
  SENSITIVE = []
  include Aws::Structure
end

#aws_account_idString

The ID of the Amazon Web Services account where you want to delete an analysis.

Returns:

  • (String)


4392
4393
4394
4395
4396
4397
4398
4399
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 4392

class DeleteAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :recovery_window_in_days,
  :force_delete_without_recovery)
  SENSITIVE = []
  include Aws::Structure
end

#force_delete_without_recoveryBoolean

This option defaults to the value NoForceDeleteWithoutRecovery. To immediately delete the analysis, add the ForceDeleteWithoutRecovery option. You can't restore an analysis after it's deleted.

Returns:

  • (Boolean)


4392
4393
4394
4395
4396
4397
4398
4399
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 4392

class DeleteAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :recovery_window_in_days,
  :force_delete_without_recovery)
  SENSITIVE = []
  include Aws::Structure
end

#recovery_window_in_daysInteger

A value that specifies the number of days that Amazon QuickSight waits before it deletes the analysis. You can't use this parameter with the ForceDeleteWithoutRecovery option in the same API call. The default value is 30.

Returns:

  • (Integer)


4392
4393
4394
4395
4396
4397
4398
4399
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 4392

class DeleteAnalysisRequest < Struct.new(
  :aws_account_id,
  :analysis_id,
  :recovery_window_in_days,
  :force_delete_without_recovery)
  SENSITIVE = []
  include Aws::Structure
end