« blib/lib/Paws/Quicksight/UpdateAnalysisResponse.pm
↑ Summary
blib/lib/Paws/Quicksight/UpdateDashboardPermissions.pm »
| 1 | |||
| 2 | package Paws::Quicksight::UpdateDashboard; | ||
| 3 | use Moose; | ||
| 4 | has AwsAccountId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'AwsAccountId', required => 1); | ||
| 5 | has DashboardId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'DashboardId', required => 1); | ||
| 6 | has DashboardPublishOptions => (is => 'ro', isa => 'Paws::Quicksight::DashboardPublishOptions'); | ||
| 7 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has Parameters => (is => 'ro', isa => 'Paws::Quicksight::Parameters'); | ||
| 9 | has SourceEntity => (is => 'ro', isa => 'Paws::Quicksight::DashboardSourceEntity', required => 1); | ||
| 10 | has ThemeArn => (is => 'ro', isa => 'Str'); | ||
| 11 | has VersionDescription => (is => 'ro', isa => 'Str'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateDashboard'); | ||
| 16 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/accounts/{AwsAccountId}/dashboards/{DashboardId}'); | ||
| 17 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Quicksight::UpdateDashboardResponse'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::Quicksight::UpdateDashboard - Arguments for method UpdateDashboard on L<Paws::Quicksight> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method UpdateDashboard on the | ||
| 30 | L<Amazon QuickSight|Paws::Quicksight> service. Use the attributes of this class | ||
| 31 | as arguments to method UpdateDashboard. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateDashboard. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $quicksight = Paws->service('Quicksight'); | ||
| 38 | my $UpdateDashboardResponse = $quicksight->UpdateDashboard( | ||
| 39 | AwsAccountId => 'MyAwsAccountId', | ||
| 40 | DashboardId => 'MyRestrictiveResourceId', | ||
| 41 | Name => 'MyDashboardName', | ||
| 42 | SourceEntity => { | ||
| 43 | SourceTemplate => { | ||
| 44 | Arn => 'MyArn', | ||
| 45 | DataSetReferences => [ | ||
| 46 | { | ||
| 47 | DataSetArn => 'MyArn', | ||
| 48 | DataSetPlaceholder => 'MyNonEmptyString', | ||
| 49 | |||
| 50 | }, | ||
| 51 | ... | ||
| 52 | ], # min: 1 | ||
| 53 | |||
| 54 | }, # OPTIONAL | ||
| 55 | }, | ||
| 56 | DashboardPublishOptions => { | ||
| 57 | AdHocFilteringOption => { | ||
| 58 | AvailabilityStatus => 'ENABLED', # values: ENABLED, DISABLED; OPTIONAL | ||
| 59 | }, # OPTIONAL | ||
| 60 | ExportToCSVOption => { | ||
| 61 | AvailabilityStatus => 'ENABLED', # values: ENABLED, DISABLED; OPTIONAL | ||
| 62 | }, # OPTIONAL | ||
| 63 | SheetControlsOption => { | ||
| 64 | VisibilityState => 'EXPANDED', # values: EXPANDED, COLLAPSED; OPTIONAL | ||
| 65 | }, # OPTIONAL | ||
| 66 | }, # OPTIONAL | ||
| 67 | Parameters => { | ||
| 68 | DateTimeParameters => [ | ||
| 69 | { | ||
| 70 | Name => 'MyNonEmptyString', | ||
| 71 | Values => [ '1970-01-01T01:00:00', ... ], | ||
| 72 | |||
| 73 | }, | ||
| 74 | ... | ||
| 75 | ], # max: 100; OPTIONAL | ||
| 76 | DecimalParameters => [ | ||
| 77 | { | ||
| 78 | Name => 'MyNonEmptyString', | ||
| 79 | Values => [ 1, ... ], | ||
| 80 | |||
| 81 | }, | ||
| 82 | ... | ||
| 83 | ], # max: 100; OPTIONAL | ||
| 84 | IntegerParameters => [ | ||
| 85 | { | ||
| 86 | Name => 'MyNonEmptyString', | ||
| 87 | Values => [ 1, ... ], | ||
| 88 | |||
| 89 | }, | ||
| 90 | ... | ||
| 91 | ], # max: 100; OPTIONAL | ||
| 92 | StringParameters => [ | ||
| 93 | { | ||
| 94 | Name => 'MyNonEmptyString', | ||
| 95 | Values => [ 'MyString', ... ], | ||
| 96 | |||
| 97 | }, | ||
| 98 | ... | ||
| 99 | ], # max: 100; OPTIONAL | ||
| 100 | }, # OPTIONAL | ||
| 101 | ThemeArn => 'MyArn', # OPTIONAL | ||
| 102 | VersionDescription => 'MyVersionDescription', # OPTIONAL | ||
| 103 | ); | ||
| 104 | |||
| 105 | # Results: | ||
| 106 | my $Arn = $UpdateDashboardResponse->Arn; | ||
| 107 | my $CreationStatus = $UpdateDashboardResponse->CreationStatus; | ||
| 108 | my $DashboardId = $UpdateDashboardResponse->DashboardId; | ||
| 109 | my $RequestId = $UpdateDashboardResponse->RequestId; | ||
| 110 | my $Status = $UpdateDashboardResponse->Status; | ||
| 111 | my $VersionArn = $UpdateDashboardResponse->VersionArn; | ||
| 112 | |||
| 113 | # Returns a L<Paws::Quicksight::UpdateDashboardResponse> object. | ||
| 114 | |||
| 115 | 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. | ||
| 116 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/quicksight/UpdateDashboard> | ||
| 117 | |||
| 118 | =head1 ATTRIBUTES | ||
| 119 | |||
| 120 | |||
| 121 | =head2 B<REQUIRED> AwsAccountId => Str | ||
| 122 | |||
| 123 | The ID of the AWS account that contains the dashboard that you're | ||
| 124 | updating. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 B<REQUIRED> DashboardId => Str | ||
| 129 | |||
| 130 | The ID for the dashboard. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head2 DashboardPublishOptions => L<Paws::Quicksight::DashboardPublishOptions> | ||
| 135 | |||
| 136 | Options for publishing the dashboard when you create it: | ||
| 137 | |||
| 138 | =over | ||
| 139 | |||
| 140 | =item * | ||
| 141 | |||
| 142 | C<AvailabilityStatus> for C<AdHocFilteringOption> - This status can be | ||
| 143 | either C<ENABLED> or C<DISABLED>. When this is set to C<DISABLED>, | ||
| 144 | QuickSight disables the left filter pane on the published dashboard, | ||
| 145 | which can be used for ad hoc (one-time) filtering. This option is | ||
| 146 | C<ENABLED> by default. | ||
| 147 | |||
| 148 | =item * | ||
| 149 | |||
| 150 | C<AvailabilityStatus> for C<ExportToCSVOption> - This status can be | ||
| 151 | either C<ENABLED> or C<DISABLED>. The visual option to export data to | ||
| 152 | .CSV format isn't enabled when this is set to C<DISABLED>. This option | ||
| 153 | is C<ENABLED> by default. | ||
| 154 | |||
| 155 | =item * | ||
| 156 | |||
| 157 | C<VisibilityState> for C<SheetControlsOption> - This visibility state | ||
| 158 | can be either C<COLLAPSED> or C<EXPANDED>. This option is C<COLLAPSED> | ||
| 159 | by default. | ||
| 160 | |||
| 161 | =back | ||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | |||
| 166 | =head2 B<REQUIRED> Name => Str | ||
| 167 | |||
| 168 | The display name of the dashboard. | ||
| 169 | |||
| 170 | |||
| 171 | |||
| 172 | =head2 Parameters => L<Paws::Quicksight::Parameters> | ||
| 173 | |||
| 174 | A structure that contains the parameters of the dashboard. These are | ||
| 175 | parameter overrides for a dashboard. A dashboard can have any type of | ||
| 176 | parameters, and some parameters might accept multiple values. | ||
| 177 | |||
| 178 | |||
| 179 | |||
| 180 | =head2 B<REQUIRED> SourceEntity => L<Paws::Quicksight::DashboardSourceEntity> | ||
| 181 | |||
| 182 | The entity that you are using as a source when you update the | ||
| 183 | dashboard. In C<SourceEntity>, you specify the type of object you're | ||
| 184 | using as source. You can only update a dashboard from a template, so | ||
| 185 | you use a C<SourceTemplate> entity. If you need to update a dashboard | ||
| 186 | from an analysis, first convert the analysis to a template by using the | ||
| 187 | CreateTemplate API operation. For C<SourceTemplate>, specify the Amazon | ||
| 188 | Resource Name (ARN) of the source template. The C<SourceTemplate> ARN | ||
| 189 | can contain any AWS Account and any QuickSight-supported AWS Region. | ||
| 190 | |||
| 191 | Use the C<DataSetReferences> entity within C<SourceTemplate> to list | ||
| 192 | the replacement datasets for the placeholders listed in the original. | ||
| 193 | The schema in each dataset must match its placeholder. | ||
| 194 | |||
| 195 | |||
| 196 | |||
| 197 | =head2 ThemeArn => Str | ||
| 198 | |||
| 199 | The Amazon Resource Name (ARN) of the theme that is being used for this | ||
| 200 | dashboard. If you add a value for this field, it overrides the value | ||
| 201 | that was originally associated with the entity. The theme ARN must | ||
| 202 | exist in the same AWS account where you create the dashboard. | ||
| 203 | |||
| 204 | |||
| 205 | |||
| 206 | =head2 VersionDescription => Str | ||
| 207 | |||
| 208 | A description for the first version of the dashboard being created. | ||
| 209 | |||
| 210 | |||
| 211 | |||
| 212 | |||
| 213 | =head1 SEE ALSO | ||
| 214 | |||
| 215 | This class forms part of L<Paws>, documenting arguments for method UpdateDashboard in L<Paws::Quicksight> | ||
| 216 | |||
| 217 | =head1 BUGS and CONTRIBUTIONS | ||
| 218 | |||
| 219 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 220 | |||
| 221 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 222 | |||
| 223 | =cut | ||
| 224 |