« blib/lib/Paws/Quicksight/DeleteAccountCustomizationResponse.pm
↑ Summary
blib/lib/Paws/Quicksight/DeleteAnalysisResponse.pm »
| 1 | |||
| 2 | package Paws::Quicksight::DeleteAnalysis; | ||
| 3 | use Moose; | ||
| 4 | has AnalysisId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'AnalysisId', required => 1); | ||
| 5 | has AwsAccountId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'AwsAccountId', required => 1); | ||
| 6 | has ForceDeleteWithoutRecovery => (is => 'ro', isa => 'Bool', traits => ['ParamInQuery'], query_name => 'force-delete-without-recovery'); | ||
| 7 | has RecoveryWindowInDays => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'recovery-window-in-days'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DeleteAnalysis'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/accounts/{AwsAccountId}/analyses/{AnalysisId}'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'DELETE'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Quicksight::DeleteAnalysisResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Quicksight::DeleteAnalysis - Arguments for method DeleteAnalysis on L<Paws::Quicksight> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DeleteAnalysis on the | ||
| 26 | L<Amazon QuickSight|Paws::Quicksight> service. Use the attributes of this class | ||
| 27 | as arguments to method DeleteAnalysis. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteAnalysis. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $quicksight = Paws->service('Quicksight'); | ||
| 34 | my $DeleteAnalysisResponse = $quicksight->DeleteAnalysis( | ||
| 35 | AnalysisId => 'MyRestrictiveResourceId', | ||
| 36 | AwsAccountId => 'MyAwsAccountId', | ||
| 37 | ForceDeleteWithoutRecovery => 1, # OPTIONAL | ||
| 38 | RecoveryWindowInDays => 1, # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $AnalysisId = $DeleteAnalysisResponse->AnalysisId; | ||
| 43 | my $Arn = $DeleteAnalysisResponse->Arn; | ||
| 44 | my $DeletionTime = $DeleteAnalysisResponse->DeletionTime; | ||
| 45 | my $RequestId = $DeleteAnalysisResponse->RequestId; | ||
| 46 | my $Status = $DeleteAnalysisResponse->Status; | ||
| 47 | |||
| 48 | # Returns a L<Paws::Quicksight::DeleteAnalysisResponse> object. | ||
| 49 | |||
| 50 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/quicksight/DeleteAnalysis> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> AnalysisId => Str | ||
| 57 | |||
| 58 | The ID of the analysis that you're deleting. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> AwsAccountId => Str | ||
| 63 | |||
| 64 | The ID of the AWS account where you want to delete an analysis. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 ForceDeleteWithoutRecovery => Bool | ||
| 69 | |||
| 70 | This option defaults to the value C<NoForceDeleteWithoutRecovery>. To | ||
| 71 | immediately delete the analysis, add the C<ForceDeleteWithoutRecovery> | ||
| 72 | option. You can't restore an analysis after it's deleted. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 RecoveryWindowInDays => Int | ||
| 77 | |||
| 78 | A value that specifies the number of days that QuickSight waits before | ||
| 79 | it deletes the analysis. You can't use this parameter with the | ||
| 80 | C<ForceDeleteWithoutRecovery> option in the same API call. The default | ||
| 81 | value is 30. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head1 SEE ALSO | ||
| 87 | |||
| 88 | This class forms part of L<Paws>, documenting arguments for method DeleteAnalysis in L<Paws::Quicksight> | ||
| 89 | |||
| 90 | =head1 BUGS and CONTRIBUTIONS | ||
| 91 | |||
| 92 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 93 | |||
| 94 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 95 | |||
| 96 | =cut | ||
| 97 |