« blib/lib/Paws/Quicksight/UpdateAccountSettingsResponse.pm
↑ Summary
blib/lib/Paws/Quicksight/UpdateAnalysisPermissions.pm »
| 1 | |||
| 2 | package Paws::Quicksight::UpdateAnalysis; | ||
| 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 Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Parameters => (is => 'ro', isa => 'Paws::Quicksight::Parameters'); | ||
| 8 | has SourceEntity => (is => 'ro', isa => 'Paws::Quicksight::AnalysisSourceEntity', required => 1); | ||
| 9 | has ThemeArn => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateAnalysis'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/accounts/{AwsAccountId}/analyses/{AnalysisId}'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Quicksight::UpdateAnalysisResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Quicksight::UpdateAnalysis - Arguments for method UpdateAnalysis on L<Paws::Quicksight> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method UpdateAnalysis on the | ||
| 28 | L<Amazon QuickSight|Paws::Quicksight> service. Use the attributes of this class | ||
| 29 | as arguments to method UpdateAnalysis. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateAnalysis. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $quicksight = Paws->service('Quicksight'); | ||
| 36 | my $UpdateAnalysisResponse = $quicksight->UpdateAnalysis( | ||
| 37 | AnalysisId => 'MyRestrictiveResourceId', | ||
| 38 | AwsAccountId => 'MyAwsAccountId', | ||
| 39 | Name => 'MyAnalysisName', | ||
| 40 | SourceEntity => { | ||
| 41 | SourceTemplate => { | ||
| 42 | Arn => 'MyArn', | ||
| 43 | DataSetReferences => [ | ||
| 44 | { | ||
| 45 | DataSetArn => 'MyArn', | ||
| 46 | DataSetPlaceholder => 'MyNonEmptyString', | ||
| 47 | |||
| 48 | }, | ||
| 49 | ... | ||
| 50 | ], # min: 1 | ||
| 51 | |||
| 52 | }, # OPTIONAL | ||
| 53 | }, | ||
| 54 | Parameters => { | ||
| 55 | DateTimeParameters => [ | ||
| 56 | { | ||
| 57 | Name => 'MyNonEmptyString', | ||
| 58 | Values => [ '1970-01-01T01:00:00', ... ], | ||
| 59 | |||
| 60 | }, | ||
| 61 | ... | ||
| 62 | ], # max: 100; OPTIONAL | ||
| 63 | DecimalParameters => [ | ||
| 64 | { | ||
| 65 | Name => 'MyNonEmptyString', | ||
| 66 | Values => [ 1, ... ], | ||
| 67 | |||
| 68 | }, | ||
| 69 | ... | ||
| 70 | ], # max: 100; OPTIONAL | ||
| 71 | IntegerParameters => [ | ||
| 72 | { | ||
| 73 | Name => 'MyNonEmptyString', | ||
| 74 | Values => [ 1, ... ], | ||
| 75 | |||
| 76 | }, | ||
| 77 | ... | ||
| 78 | ], # max: 100; OPTIONAL | ||
| 79 | StringParameters => [ | ||
| 80 | { | ||
| 81 | Name => 'MyNonEmptyString', | ||
| 82 | Values => [ 'MyString', ... ], | ||
| 83 | |||
| 84 | }, | ||
| 85 | ... | ||
| 86 | ], # max: 100; OPTIONAL | ||
| 87 | }, # OPTIONAL | ||
| 88 | ThemeArn => 'MyArn', # OPTIONAL | ||
| 89 | ); | ||
| 90 | |||
| 91 | # Results: | ||
| 92 | my $AnalysisId = $UpdateAnalysisResponse->AnalysisId; | ||
| 93 | my $Arn = $UpdateAnalysisResponse->Arn; | ||
| 94 | my $RequestId = $UpdateAnalysisResponse->RequestId; | ||
| 95 | my $Status = $UpdateAnalysisResponse->Status; | ||
| 96 | my $UpdateStatus = $UpdateAnalysisResponse->UpdateStatus; | ||
| 97 | |||
| 98 | # Returns a L<Paws::Quicksight::UpdateAnalysisResponse> object. | ||
| 99 | |||
| 100 | 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. | ||
| 101 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/quicksight/UpdateAnalysis> | ||
| 102 | |||
| 103 | =head1 ATTRIBUTES | ||
| 104 | |||
| 105 | |||
| 106 | =head2 B<REQUIRED> AnalysisId => Str | ||
| 107 | |||
| 108 | The ID for the analysis that you're updating. This ID displays in the | ||
| 109 | URL of the analysis. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 B<REQUIRED> AwsAccountId => Str | ||
| 114 | |||
| 115 | The ID of the AWS account that contains the analysis that you're | ||
| 116 | updating. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 B<REQUIRED> Name => Str | ||
| 121 | |||
| 122 | A descriptive name for the analysis that you're updating. This name | ||
| 123 | displays for the analysis in the QuickSight console. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head2 Parameters => L<Paws::Quicksight::Parameters> | ||
| 128 | |||
| 129 | The parameter names and override values that you want to use. An | ||
| 130 | analysis can have any parameter type, and some parameters might accept | ||
| 131 | multiple values. | ||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head2 B<REQUIRED> SourceEntity => L<Paws::Quicksight::AnalysisSourceEntity> | ||
| 136 | |||
| 137 | A source entity to use for the analysis that you're updating. This | ||
| 138 | metadata structure contains details that describe a source template and | ||
| 139 | one or more datasets. | ||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head2 ThemeArn => Str | ||
| 144 | |||
| 145 | The Amazon Resource Name (ARN) for the theme to apply to the analysis | ||
| 146 | that you're creating. To see the theme in the QuickSight console, make | ||
| 147 | sure that you have access to it. | ||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head1 SEE ALSO | ||
| 153 | |||
| 154 | This class forms part of L<Paws>, documenting arguments for method UpdateAnalysis in L<Paws::Quicksight> | ||
| 155 | |||
| 156 | =head1 BUGS and CONTRIBUTIONS | ||
| 157 | |||
| 158 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 159 | |||
| 160 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 161 | |||
| 162 | =cut | ||
| 163 |