aws-cdk-lib 2.219.0__py3-none-any.whl → 2.221.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/__init__.py +33 -35
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.219.0.jsii.tgz → aws-cdk-lib@2.221.0.jsii.tgz} +0 -0
- aws_cdk/alexa_ask/__init__.py +3 -0
- aws_cdk/aws_accessanalyzer/__init__.py +3 -0
- aws_cdk/aws_acmpca/__init__.py +4 -1
- aws_cdk/aws_aiops/__init__.py +3 -0
- aws_cdk/aws_amazonmq/__init__.py +3 -29
- aws_cdk/aws_amplify/__init__.py +3 -0
- aws_cdk/aws_amplifyuibuilder/__init__.py +3 -0
- aws_cdk/aws_apigateway/__init__.py +3 -0
- aws_cdk/aws_apigatewayv2/__init__.py +3 -0
- aws_cdk/aws_appconfig/__init__.py +3 -29
- aws_cdk/aws_appflow/__init__.py +3 -0
- aws_cdk/aws_appintegrations/__init__.py +3 -0
- aws_cdk/aws_applicationautoscaling/__init__.py +3 -0
- aws_cdk/aws_applicationinsights/__init__.py +3 -0
- aws_cdk/aws_applicationsignals/__init__.py +453 -2
- aws_cdk/aws_appmesh/__init__.py +3 -0
- aws_cdk/aws_apprunner/__init__.py +3 -0
- aws_cdk/aws_appstream/__init__.py +3 -0
- aws_cdk/aws_appsync/__init__.py +3 -0
- aws_cdk/aws_apptest/__init__.py +3 -0
- aws_cdk/aws_aps/__init__.py +1168 -83
- aws_cdk/aws_arcregionswitch/__init__.py +11 -0
- aws_cdk/aws_arczonalshift/__init__.py +3 -0
- aws_cdk/aws_athena/__init__.py +3 -0
- aws_cdk/aws_auditmanager/__init__.py +3 -0
- aws_cdk/aws_autoscaling/__init__.py +3 -0
- aws_cdk/aws_autoscaling_common/__init__.py +3 -0
- aws_cdk/aws_autoscalingplans/__init__.py +3 -0
- aws_cdk/aws_b2bi/__init__.py +3 -0
- aws_cdk/aws_backup/__init__.py +32 -29
- aws_cdk/aws_backupgateway/__init__.py +3 -0
- aws_cdk/aws_batch/__init__.py +112 -7
- aws_cdk/aws_bcmdataexports/__init__.py +3 -0
- aws_cdk/aws_bedrock/__init__.py +53 -45
- aws_cdk/aws_bedrockagentcore/__init__.py +8499 -1732
- aws_cdk/aws_billingconductor/__init__.py +3 -0
- aws_cdk/aws_budgets/__init__.py +3 -0
- aws_cdk/aws_cassandra/__init__.py +3 -0
- aws_cdk/aws_ce/__init__.py +3 -0
- aws_cdk/aws_certificatemanager/__init__.py +3 -0
- aws_cdk/aws_chatbot/__init__.py +3 -0
- aws_cdk/aws_cleanrooms/__init__.py +3 -0
- aws_cdk/aws_cleanroomsml/__init__.py +3 -0
- aws_cdk/aws_cloud9/__init__.py +3 -0
- aws_cdk/aws_cloudformation/__init__.py +3 -0
- aws_cdk/aws_cloudfront/__init__.py +69 -3
- aws_cdk/aws_cloudfront/experimental/__init__.py +4 -0
- aws_cdk/aws_cloudfront_origins/__init__.py +87 -6
- aws_cdk/aws_cloudtrail/__init__.py +3 -0
- aws_cdk/aws_cloudwatch/__init__.py +8 -5
- aws_cdk/aws_codeartifact/__init__.py +3 -0
- aws_cdk/aws_codebuild/__init__.py +3 -0
- aws_cdk/aws_codecommit/__init__.py +3 -0
- aws_cdk/aws_codeconnections/__init__.py +3 -0
- aws_cdk/aws_codedeploy/__init__.py +3 -0
- aws_cdk/aws_codeguruprofiler/__init__.py +3 -0
- aws_cdk/aws_codegurureviewer/__init__.py +3 -0
- aws_cdk/aws_codepipeline/__init__.py +3 -0
- aws_cdk/aws_codepipeline_actions/__init__.py +3 -0
- aws_cdk/aws_codestar/__init__.py +3 -0
- aws_cdk/aws_codestarconnections/__init__.py +3 -0
- aws_cdk/aws_codestarnotifications/__init__.py +3 -0
- aws_cdk/aws_cognito/__init__.py +9 -4
- aws_cdk/aws_cognito_identitypool/__init__.py +3 -0
- aws_cdk/aws_comprehend/__init__.py +3 -0
- aws_cdk/aws_config/__init__.py +3 -0
- aws_cdk/aws_connect/__init__.py +1232 -2
- aws_cdk/aws_connectcampaigns/__init__.py +3 -0
- aws_cdk/aws_connectcampaignsv2/__init__.py +3 -0
- aws_cdk/aws_controltower/__init__.py +3 -0
- aws_cdk/aws_cur/__init__.py +3 -0
- aws_cdk/aws_customerprofiles/__init__.py +3 -29
- aws_cdk/aws_databrew/__init__.py +3 -0
- aws_cdk/aws_datapipeline/__init__.py +3 -0
- aws_cdk/aws_datasync/__init__.py +3 -0
- aws_cdk/aws_datazone/__init__.py +17 -15
- aws_cdk/aws_dax/__init__.py +15 -3
- aws_cdk/aws_deadline/__init__.py +3 -0
- aws_cdk/aws_detective/__init__.py +3 -0
- aws_cdk/aws_devicefarm/__init__.py +3 -0
- aws_cdk/aws_devopsguru/__init__.py +3 -0
- aws_cdk/aws_directoryservice/__init__.py +32 -0
- aws_cdk/aws_dlm/__init__.py +3 -0
- aws_cdk/aws_dms/__init__.py +3 -0
- aws_cdk/aws_docdb/__init__.py +14 -3
- aws_cdk/aws_docdbelastic/__init__.py +3 -0
- aws_cdk/aws_dsql/__init__.py +3 -0
- aws_cdk/aws_dynamodb/__init__.py +3 -0
- aws_cdk/aws_ec2/__init__.py +205 -48
- aws_cdk/aws_ecr/__init__.py +156 -33
- aws_cdk/aws_ecs/__init__.py +429 -182
- aws_cdk/aws_efs/__init__.py +3 -0
- aws_cdk/aws_eks/__init__.py +117 -67
- aws_cdk/aws_elasticache/__init__.py +3 -0
- aws_cdk/aws_elasticbeanstalk/__init__.py +3 -0
- aws_cdk/aws_elasticloadbalancing/__init__.py +3 -0
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +445 -36
- aws_cdk/aws_elasticsearch/__init__.py +3 -0
- aws_cdk/aws_emr/__init__.py +3 -0
- aws_cdk/aws_emrcontainers/__init__.py +3 -0
- aws_cdk/aws_emrserverless/__init__.py +12 -11
- aws_cdk/aws_entityresolution/__init__.py +3 -0
- aws_cdk/aws_events/__init__.py +73 -29
- aws_cdk/aws_events_targets/__init__.py +3 -0
- aws_cdk/aws_eventschemas/__init__.py +3 -0
- aws_cdk/aws_evidently/__init__.py +3 -0
- aws_cdk/aws_evs/__init__.py +3 -0
- aws_cdk/aws_finspace/__init__.py +3 -0
- aws_cdk/aws_fis/__init__.py +3 -0
- aws_cdk/aws_fms/__init__.py +3 -0
- aws_cdk/aws_forecast/__init__.py +3 -0
- aws_cdk/aws_frauddetector/__init__.py +3 -0
- aws_cdk/aws_fsx/__init__.py +7 -4
- aws_cdk/aws_gamelift/__init__.py +3 -0
- aws_cdk/aws_gameliftstreams/__init__.py +8 -5
- aws_cdk/aws_globalaccelerator/__init__.py +3 -0
- aws_cdk/aws_glue/__init__.py +11 -80
- aws_cdk/aws_grafana/__init__.py +3 -0
- aws_cdk/aws_greengrass/__init__.py +3 -0
- aws_cdk/aws_greengrassv2/__init__.py +3 -0
- aws_cdk/aws_groundstation/__init__.py +3 -0
- aws_cdk/aws_guardduty/__init__.py +3 -0
- aws_cdk/aws_healthimaging/__init__.py +3 -0
- aws_cdk/aws_healthlake/__init__.py +3 -0
- aws_cdk/aws_iam/__init__.py +30 -32
- aws_cdk/aws_identitystore/__init__.py +3 -0
- aws_cdk/aws_imagebuilder/__init__.py +896 -0
- aws_cdk/aws_inspector/__init__.py +3 -0
- aws_cdk/aws_inspectorv2/__init__.py +3 -0
- aws_cdk/aws_internetmonitor/__init__.py +3 -0
- aws_cdk/aws_invoicing/__init__.py +3 -0
- aws_cdk/aws_iot/__init__.py +3 -0
- aws_cdk/aws_iotanalytics/__init__.py +3 -0
- aws_cdk/aws_iotcoredeviceadvisor/__init__.py +3 -0
- aws_cdk/aws_iotevents/__init__.py +3 -0
- aws_cdk/aws_iotfleethub/__init__.py +3 -0
- aws_cdk/aws_iotfleetwise/__init__.py +3 -0
- aws_cdk/aws_iotsitewise/__init__.py +139 -80
- aws_cdk/aws_iotthingsgraph/__init__.py +3 -0
- aws_cdk/aws_iottwinmaker/__init__.py +3 -87
- aws_cdk/aws_iotwireless/__init__.py +61 -0
- aws_cdk/aws_ivs/__init__.py +3 -0
- aws_cdk/aws_ivschat/__init__.py +3 -0
- aws_cdk/aws_kafkaconnect/__init__.py +3 -0
- aws_cdk/aws_kendra/__init__.py +3 -58
- aws_cdk/aws_kendraranking/__init__.py +3 -0
- aws_cdk/aws_kinesis/__init__.py +98 -4
- aws_cdk/aws_kinesisanalytics/__init__.py +3 -0
- aws_cdk/aws_kinesisanalyticsv2/__init__.py +3 -0
- aws_cdk/aws_kinesisfirehose/__init__.py +1709 -10
- aws_cdk/aws_kinesisvideo/__init__.py +3 -29
- aws_cdk/aws_kms/__init__.py +3 -0
- aws_cdk/aws_lakeformation/__init__.py +3 -0
- aws_cdk/aws_lambda/__init__.py +57 -7
- aws_cdk/aws_lambda_nodejs/__init__.py +3 -0
- aws_cdk/aws_launchwizard/__init__.py +3 -0
- aws_cdk/aws_lex/__init__.py +3 -29
- aws_cdk/aws_licensemanager/__init__.py +3 -0
- aws_cdk/aws_lightsail/__init__.py +587 -0
- aws_cdk/aws_location/__init__.py +3 -0
- aws_cdk/aws_logs/__init__.py +283 -9
- aws_cdk/aws_lookoutequipment/__init__.py +3 -29
- aws_cdk/aws_lookoutmetrics/__init__.py +17 -2
- aws_cdk/aws_lookoutvision/__init__.py +3 -0
- aws_cdk/aws_m2/__init__.py +62 -13
- aws_cdk/aws_macie/__init__.py +3 -0
- aws_cdk/aws_managedblockchain/__init__.py +3 -0
- aws_cdk/aws_mediaconnect/__init__.py +3 -0
- aws_cdk/aws_mediaconvert/__init__.py +3 -0
- aws_cdk/aws_medialive/__init__.py +279 -33
- aws_cdk/aws_mediapackage/__init__.py +3 -0
- aws_cdk/aws_mediapackagev2/__init__.py +3 -0
- aws_cdk/aws_mediastore/__init__.py +3 -0
- aws_cdk/aws_mediatailor/__init__.py +3 -58
- aws_cdk/aws_memorydb/__init__.py +3 -0
- aws_cdk/aws_mpa/__init__.py +3 -0
- aws_cdk/aws_msk/__init__.py +3 -0
- aws_cdk/aws_mwaa/__init__.py +8 -5
- aws_cdk/aws_neptune/__init__.py +188 -70
- aws_cdk/aws_neptunegraph/__init__.py +3 -0
- aws_cdk/aws_networkfirewall/__init__.py +3 -0
- aws_cdk/aws_networkmanager/__init__.py +32 -0
- aws_cdk/aws_nimblestudio/__init__.py +3 -0
- aws_cdk/aws_notifications/__init__.py +3 -0
- aws_cdk/aws_notificationscontacts/__init__.py +3 -0
- aws_cdk/aws_oam/__init__.py +3 -0
- aws_cdk/aws_observabilityadmin/__init__.py +1365 -187
- aws_cdk/aws_odb/__init__.py +4 -1
- aws_cdk/aws_omics/__init__.py +10 -1
- aws_cdk/aws_opensearchserverless/__init__.py +3 -0
- aws_cdk/aws_opensearchservice/__init__.py +9 -0
- aws_cdk/aws_opsworks/__init__.py +3 -0
- aws_cdk/aws_opsworkscm/__init__.py +3 -0
- aws_cdk/aws_organizations/__init__.py +3 -116
- aws_cdk/aws_osis/__init__.py +157 -0
- aws_cdk/aws_panorama/__init__.py +3 -0
- aws_cdk/aws_paymentcryptography/__init__.py +3 -0
- aws_cdk/aws_pcaconnectorad/__init__.py +3 -0
- aws_cdk/aws_pcaconnectorscep/__init__.py +3 -0
- aws_cdk/aws_pcs/__init__.py +227 -33
- aws_cdk/aws_personalize/__init__.py +3 -0
- aws_cdk/aws_pinpoint/__init__.py +61 -58
- aws_cdk/aws_pinpointemail/__init__.py +3 -0
- aws_cdk/aws_pipes/__init__.py +3 -0
- aws_cdk/aws_proton/__init__.py +3 -0
- aws_cdk/aws_qbusiness/__init__.py +3 -174
- aws_cdk/aws_qldb/__init__.py +3 -29
- aws_cdk/aws_quicksight/__init__.py +493 -406
- aws_cdk/aws_ram/__init__.py +3 -0
- aws_cdk/aws_rbin/__init__.py +3 -0
- aws_cdk/aws_rds/__init__.py +71 -42
- aws_cdk/aws_redshift/__init__.py +3 -0
- aws_cdk/aws_redshiftserverless/__init__.py +3 -0
- aws_cdk/aws_refactorspaces/__init__.py +21 -6
- aws_cdk/aws_rekognition/__init__.py +3 -29
- aws_cdk/aws_resiliencehub/__init__.py +3 -0
- aws_cdk/aws_resourceexplorer2/__init__.py +3 -0
- aws_cdk/aws_resourcegroups/__init__.py +3 -0
- aws_cdk/aws_robomaker/__init__.py +3 -0
- aws_cdk/aws_rolesanywhere/__init__.py +3 -0
- aws_cdk/aws_route53/__init__.py +148 -24
- aws_cdk/aws_route53_targets/__init__.py +3 -0
- aws_cdk/aws_route53profiles/__init__.py +3 -0
- aws_cdk/aws_route53recoverycontrol/__init__.py +3 -0
- aws_cdk/aws_route53recoveryreadiness/__init__.py +3 -0
- aws_cdk/aws_route53resolver/__init__.py +11 -4
- aws_cdk/aws_rum/__init__.py +3 -0
- aws_cdk/aws_s3/__init__.py +80 -43
- aws_cdk/aws_s3_deployment/__init__.py +3 -0
- aws_cdk/aws_s3express/__init__.py +3 -0
- aws_cdk/aws_s3objectlambda/__init__.py +47 -12
- aws_cdk/aws_s3outposts/__init__.py +3 -0
- aws_cdk/aws_s3tables/__init__.py +3 -0
- aws_cdk/aws_sagemaker/__init__.py +166 -87
- aws_cdk/aws_sam/__init__.py +3 -0
- aws_cdk/aws_scheduler/__init__.py +3 -29
- aws_cdk/aws_sdb/__init__.py +3 -0
- aws_cdk/aws_secretsmanager/__init__.py +3 -0
- aws_cdk/aws_securityhub/__init__.py +3 -0
- aws_cdk/aws_securitylake/__init__.py +3 -0
- aws_cdk/aws_servicecatalog/__init__.py +161 -144
- aws_cdk/aws_servicecatalogappregistry/__init__.py +3 -0
- aws_cdk/aws_servicediscovery/__init__.py +3 -0
- aws_cdk/aws_ses/__init__.py +3 -0
- aws_cdk/aws_shield/__init__.py +3 -0
- aws_cdk/aws_signer/__init__.py +3 -0
- aws_cdk/aws_simspaceweaver/__init__.py +3 -0
- aws_cdk/aws_smsvoice/__init__.py +3 -29
- aws_cdk/aws_sns/__init__.py +3 -0
- aws_cdk/aws_sqs/__init__.py +3 -0
- aws_cdk/aws_ssm/__init__.py +10 -3
- aws_cdk/aws_ssmcontacts/__init__.py +3 -0
- aws_cdk/aws_ssmguiconnect/__init__.py +3 -0
- aws_cdk/aws_ssmincidents/__init__.py +3 -0
- aws_cdk/aws_ssmquicksetup/__init__.py +470 -3
- aws_cdk/aws_sso/__init__.py +3 -0
- aws_cdk/aws_stepfunctions/__init__.py +23 -19
- aws_cdk/aws_stepfunctions_tasks/__init__.py +6 -3
- aws_cdk/aws_supportapp/__init__.py +3 -0
- aws_cdk/aws_synthetics/__init__.py +80 -27
- aws_cdk/aws_systemsmanagersap/__init__.py +3 -0
- aws_cdk/aws_timestream/__init__.py +3 -29
- aws_cdk/aws_transfer/__init__.py +20 -34
- aws_cdk/aws_verifiedpermissions/__init__.py +3 -0
- aws_cdk/aws_voiceid/__init__.py +3 -0
- aws_cdk/aws_vpclattice/__init__.py +7 -4
- aws_cdk/aws_waf/__init__.py +3 -0
- aws_cdk/aws_wafregional/__init__.py +3 -0
- aws_cdk/aws_wafv2/__init__.py +3 -0
- aws_cdk/aws_wisdom/__init__.py +3 -116
- aws_cdk/aws_workspaces/__init__.py +3 -0
- aws_cdk/aws_workspacesinstances/__init__.py +3 -0
- aws_cdk/aws_workspacesthinclient/__init__.py +3 -0
- aws_cdk/aws_workspacesweb/__init__.py +3 -0
- aws_cdk/aws_xray/__init__.py +3 -0
- aws_cdk/cloud_assembly_schema/__init__.py +3 -0
- aws_cdk/cx_api/__init__.py +34 -0
- aws_cdk/pipelines/__init__.py +3 -0
- aws_cdk/region_info/__init__.py +3 -0
- aws_cdk/triggers/__init__.py +3 -0
- {aws_cdk_lib-2.219.0.dist-info → aws_cdk_lib-2.221.0.dist-info}/METADATA +2 -2
- aws_cdk_lib-2.221.0.dist-info/RECORD +313 -0
- aws_cdk_lib-2.219.0.dist-info/RECORD +0 -313
- {aws_cdk_lib-2.219.0.dist-info → aws_cdk_lib-2.221.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.219.0.dist-info → aws_cdk_lib-2.221.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.219.0.dist-info → aws_cdk_lib-2.221.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.219.0.dist-info → aws_cdk_lib-2.221.0.dist-info}/top_level.txt +0 -0
|
@@ -194,7 +194,7 @@ class CfnAnalysisProps:
|
|
|
194
194
|
|
|
195
195
|
:param analysis_id: The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
|
|
196
196
|
:param aws_account_id: The ID of the AWS account where you are creating an analysis.
|
|
197
|
-
:param name: A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon
|
|
197
|
+
:param name: A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon Quick Sight console.
|
|
198
198
|
:param definition:
|
|
199
199
|
:param errors: Errors associated with the analysis.
|
|
200
200
|
:param folder_arns:
|
|
@@ -204,7 +204,7 @@ class CfnAnalysisProps:
|
|
|
204
204
|
:param source_entity: A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets. Either a ``SourceEntity`` or a ``Definition`` must be provided in order for the request to be valid.
|
|
205
205
|
:param status: Status associated with the analysis.
|
|
206
206
|
:param tags: Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
|
|
207
|
-
:param theme_arn: The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon
|
|
207
|
+
:param theme_arn: The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon Quick Sight console, make sure that you have access to it.
|
|
208
208
|
:param validation_strategy: The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to ``LENIENT`` , validation is skipped for specific errors.
|
|
209
209
|
|
|
210
210
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html
|
|
@@ -284,7 +284,7 @@ class CfnAnalysisProps:
|
|
|
284
284
|
def name(self) -> builtins.str:
|
|
285
285
|
'''A descriptive name for the analysis that you're creating.
|
|
286
286
|
|
|
287
|
-
This name displays for the analysis in the Amazon
|
|
287
|
+
This name displays for the analysis in the Amazon Quick Sight console.
|
|
288
288
|
|
|
289
289
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-name
|
|
290
290
|
'''
|
|
@@ -397,7 +397,7 @@ class CfnAnalysisProps:
|
|
|
397
397
|
def theme_arn(self) -> typing.Optional[builtins.str]:
|
|
398
398
|
'''The ARN for the theme to apply to the analysis that you're creating.
|
|
399
399
|
|
|
400
|
-
To see the theme in the Amazon
|
|
400
|
+
To see the theme in the Amazon Quick Sight console, make sure that you have access to it.
|
|
401
401
|
|
|
402
402
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html#cfn-quicksight-analysis-themearn
|
|
403
403
|
'''
|
|
@@ -615,7 +615,7 @@ class CfnDashboardProps:
|
|
|
615
615
|
:param aws_account_id: The ID of the AWS account where you want to create the dashboard.
|
|
616
616
|
:param dashboard_id: The ID for the dashboard, also added to the IAM policy.
|
|
617
617
|
:param name: The display name of the dashboard.
|
|
618
|
-
:param dashboard_publish_options: Options for publishing the dashboard when you create it:. - ``AvailabilityStatus`` for ``AdHocFilteringOption`` - This status can be either ``ENABLED`` or ``DISABLED`` . When this is set to ``DISABLED`` , Amazon
|
|
618
|
+
:param dashboard_publish_options: Options for publishing the dashboard when you create it:. - ``AvailabilityStatus`` for ``AdHocFilteringOption`` - This status can be either ``ENABLED`` or ``DISABLED`` . When this is set to ``DISABLED`` , Amazon Quick Sight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ``ENABLED`` by default. - ``AvailabilityStatus`` for ``ExportToCSVOption`` - This status can be either ``ENABLED`` or ``DISABLED`` . The visual option to export data to .CSV format isn't enabled when this is set to ``DISABLED`` . This option is ``ENABLED`` by default. - ``VisibilityState`` for ``SheetControlsOption`` - This visibility state can be either ``COLLAPSED`` or ``EXPANDED`` . This option is ``COLLAPSED`` by default. - ``AvailabilityStatus`` for ``QuickSuiteActionsOption`` - This status can be either ``ENABLED`` or ``DISABLED`` . Features related to Actions in Amazon Quick Suite on dashboards are disabled when this is set to ``DISABLED`` . This option is ``DISABLED`` by default. - ``AvailabilityStatus`` for ``ExecutiveSummaryOption`` - This status can be either ``ENABLED`` or ``DISABLED`` . The option to build an executive summary is disabled when this is set to ``DISABLED`` . This option is ``ENABLED`` by default. - ``AvailabilityStatus`` for ``DataStoriesSharingOption`` - This status can be either ``ENABLED`` or ``DISABLED`` . The option to share a data story is disabled when this is set to ``DISABLED`` . This option is ``ENABLED`` by default.
|
|
619
619
|
:param definition:
|
|
620
620
|
:param folder_arns:
|
|
621
621
|
:param link_entities: A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
|
|
@@ -718,9 +718,10 @@ class CfnDashboardProps:
|
|
|
718
718
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.DashboardPublishOptionsProperty"]]:
|
|
719
719
|
'''Options for publishing the dashboard when you create it:.
|
|
720
720
|
|
|
721
|
-
- ``AvailabilityStatus`` for ``AdHocFilteringOption`` - This status can be either ``ENABLED`` or ``DISABLED`` . When this is set to ``DISABLED`` , Amazon
|
|
721
|
+
- ``AvailabilityStatus`` for ``AdHocFilteringOption`` - This status can be either ``ENABLED`` or ``DISABLED`` . When this is set to ``DISABLED`` , Amazon Quick Sight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ``ENABLED`` by default.
|
|
722
722
|
- ``AvailabilityStatus`` for ``ExportToCSVOption`` - This status can be either ``ENABLED`` or ``DISABLED`` . The visual option to export data to .CSV format isn't enabled when this is set to ``DISABLED`` . This option is ``ENABLED`` by default.
|
|
723
723
|
- ``VisibilityState`` for ``SheetControlsOption`` - This visibility state can be either ``COLLAPSED`` or ``EXPANDED`` . This option is ``COLLAPSED`` by default.
|
|
724
|
+
- ``AvailabilityStatus`` for ``QuickSuiteActionsOption`` - This status can be either ``ENABLED`` or ``DISABLED`` . Features related to Actions in Amazon Quick Suite on dashboards are disabled when this is set to ``DISABLED`` . This option is ``DISABLED`` by default.
|
|
724
725
|
- ``AvailabilityStatus`` for ``ExecutiveSummaryOption`` - This status can be either ``ENABLED`` or ``DISABLED`` . The option to build an executive summary is disabled when this is set to ``DISABLED`` . This option is ``ENABLED`` by default.
|
|
725
726
|
- ``AvailabilityStatus`` for ``DataStoriesSharingOption`` - This status can be either ``ENABLED`` or ``DISABLED`` . The option to share a data story is disabled when this is set to ``DISABLED`` . This option is ``ENABLED`` by default.
|
|
726
727
|
|
|
@@ -918,7 +919,7 @@ class CfnDataSetProps:
|
|
|
918
919
|
'''Properties for defining a ``CfnDataSet``.
|
|
919
920
|
|
|
920
921
|
:param aws_account_id: The AWS account ID.
|
|
921
|
-
:param column_groups: Groupings of columns that work together in certain Amazon
|
|
922
|
+
:param column_groups: Groupings of columns that work together in certain Amazon Quick Sight features. Currently, only geospatial hierarchy is supported.
|
|
922
923
|
:param column_level_permission_rules: A set of one or more definitions of a ``ColumnLevelPermissionRule`` .
|
|
923
924
|
:param data_set_id: An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
|
|
924
925
|
:param dataset_parameters: The parameters that are declared in a dataset.
|
|
@@ -1286,7 +1287,7 @@ class CfnDataSetProps:
|
|
|
1286
1287
|
def column_groups(
|
|
1287
1288
|
self,
|
|
1288
1289
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnDataSet.ColumnGroupProperty"]]]]:
|
|
1289
|
-
'''Groupings of columns that work together in certain Amazon
|
|
1290
|
+
'''Groupings of columns that work together in certain Amazon Quick Sight features.
|
|
1290
1291
|
|
|
1291
1292
|
Currently, only geospatial hierarchy is supported.
|
|
1292
1293
|
|
|
@@ -1539,15 +1540,15 @@ class CfnDataSourceProps:
|
|
|
1539
1540
|
:param type: The type of the data source. To return a list of all data sources, use ``ListDataSources`` . Use ``AMAZON_ELASTICSEARCH`` for Amazon OpenSearch Service.
|
|
1540
1541
|
:param alternate_data_source_parameters: A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the ``DataSourceParameters`` structure that's in the request with the structures in the ``AlternateDataSourceParameters`` allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the ``AlternateDataSourceParameters`` list is null, the ``Credentials`` originally used with this ``DataSourceParameters`` are automatically allowed.
|
|
1541
1542
|
:param aws_account_id: The AWS account ID.
|
|
1542
|
-
:param credentials: The credentials Amazon
|
|
1543
|
+
:param credentials: The credentials Amazon Quick Sight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
|
|
1543
1544
|
:param data_source_id: An ID for the data source. This ID is unique per AWS Region for each AWS account.
|
|
1544
|
-
:param data_source_parameters: The parameters that Amazon
|
|
1545
|
+
:param data_source_parameters: The parameters that Amazon Quick Sight uses to connect to your underlying source.
|
|
1545
1546
|
:param error_info: Error information from the last update or the creation of the data source.
|
|
1546
1547
|
:param folder_arns:
|
|
1547
1548
|
:param permissions: A list of resource permissions on the data source.
|
|
1548
|
-
:param ssl_properties: Secure Socket Layer (SSL) properties that apply when Amazon
|
|
1549
|
+
:param ssl_properties: Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.
|
|
1549
1550
|
:param tags: Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
|
|
1550
|
-
:param vpc_connection_properties: Use this parameter only when you want Amazon
|
|
1551
|
+
:param vpc_connection_properties: Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.
|
|
1551
1552
|
|
|
1552
1553
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html
|
|
1553
1554
|
:exampleMetadata: fixture=_generated
|
|
@@ -2133,7 +2134,7 @@ class CfnDataSourceProps:
|
|
|
2133
2134
|
def credentials(
|
|
2134
2135
|
self,
|
|
2135
2136
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.DataSourceCredentialsProperty"]]:
|
|
2136
|
-
'''The credentials Amazon
|
|
2137
|
+
'''The credentials Amazon Quick Sight that uses to connect to your underlying source.
|
|
2137
2138
|
|
|
2138
2139
|
Currently, only credentials based on user name and password are supported.
|
|
2139
2140
|
|
|
@@ -2157,7 +2158,7 @@ class CfnDataSourceProps:
|
|
|
2157
2158
|
def data_source_parameters(
|
|
2158
2159
|
self,
|
|
2159
2160
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.DataSourceParametersProperty"]]:
|
|
2160
|
-
'''The parameters that Amazon
|
|
2161
|
+
'''The parameters that Amazon Quick Sight uses to connect to your underlying source.
|
|
2161
2162
|
|
|
2162
2163
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-datasourceparameters
|
|
2163
2164
|
'''
|
|
@@ -2198,7 +2199,7 @@ class CfnDataSourceProps:
|
|
|
2198
2199
|
def ssl_properties(
|
|
2199
2200
|
self,
|
|
2200
2201
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.SslPropertiesProperty"]]:
|
|
2201
|
-
'''Secure Socket Layer (SSL) properties that apply when Amazon
|
|
2202
|
+
'''Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.
|
|
2202
2203
|
|
|
2203
2204
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-sslproperties
|
|
2204
2205
|
'''
|
|
@@ -2218,7 +2219,7 @@ class CfnDataSourceProps:
|
|
|
2218
2219
|
def vpc_connection_properties(
|
|
2219
2220
|
self,
|
|
2220
2221
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.VpcConnectionPropertiesProperty"]]:
|
|
2221
|
-
'''Use this parameter only when you want Amazon
|
|
2222
|
+
'''Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.
|
|
2222
2223
|
|
|
2223
2224
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-datasource.html#cfn-quicksight-datasource-vpcconnectionproperties
|
|
2224
2225
|
'''
|
|
@@ -2553,12 +2554,12 @@ class CfnTemplateProps:
|
|
|
2553
2554
|
) -> None:
|
|
2554
2555
|
'''Properties for defining a ``CfnTemplate``.
|
|
2555
2556
|
|
|
2556
|
-
:param aws_account_id: The ID for the AWS account that the group is in. You use the ID for the AWS account that contains your Amazon
|
|
2557
|
+
:param aws_account_id: The ID for the AWS account that the group is in. You use the ID for the AWS account that contains your Amazon Quick Sight account.
|
|
2557
2558
|
:param template_id: An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.
|
|
2558
2559
|
:param definition:
|
|
2559
2560
|
:param name: A display name for the template.
|
|
2560
2561
|
:param permissions: A list of resource permissions to be set on the template.
|
|
2561
|
-
:param source_entity: The entity that you are using as a source when you create the template. In ``SourceEntity`` , you specify the type of object you're using as source: ``SourceTemplate`` for a template or ``SourceAnalysis`` for an analysis. Both of these require an Amazon Resource Name (ARN). For ``SourceTemplate`` , specify the ARN of the source template. For ``SourceAnalysis`` , specify the ARN of the source analysis. The ``SourceTemplate`` ARN can contain any AWS account and any
|
|
2562
|
+
:param source_entity: The entity that you are using as a source when you create the template. In ``SourceEntity`` , you specify the type of object you're using as source: ``SourceTemplate`` for a template or ``SourceAnalysis`` for an analysis. Both of these require an Amazon Resource Name (ARN). For ``SourceTemplate`` , specify the ARN of the source template. For ``SourceAnalysis`` , specify the ARN of the source analysis. The ``SourceTemplate`` ARN can contain any AWS account and any Quick Sight-supported AWS Region . Use the ``DataSetReferences`` entity within ``SourceTemplate`` or ``SourceAnalysis`` to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. Either a ``SourceEntity`` or a ``Definition`` must be provided in order for the request to be valid.
|
|
2562
2563
|
:param tags: Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
|
|
2563
2564
|
:param validation_strategy: The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to ``LENIENT`` , validation is skipped for specific errors.
|
|
2564
2565
|
:param version_description: A description of the current template version being created. This API operation creates the first version of the template. Every time ``UpdateTemplate`` is called, a new version is created. Each version of the template maintains a description of the version in the ``VersionDescription`` field.
|
|
@@ -2604,7 +2605,7 @@ class CfnTemplateProps:
|
|
|
2604
2605
|
def aws_account_id(self) -> builtins.str:
|
|
2605
2606
|
'''The ID for the AWS account that the group is in.
|
|
2606
2607
|
|
|
2607
|
-
You use the ID for the AWS account that contains your Amazon
|
|
2608
|
+
You use the ID for the AWS account that contains your Amazon Quick Sight account.
|
|
2608
2609
|
|
|
2609
2610
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-awsaccountid
|
|
2610
2611
|
'''
|
|
@@ -2660,7 +2661,7 @@ class CfnTemplateProps:
|
|
|
2660
2661
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.TemplateSourceEntityProperty"]]:
|
|
2661
2662
|
'''The entity that you are using as a source when you create the template.
|
|
2662
2663
|
|
|
2663
|
-
In ``SourceEntity`` , you specify the type of object you're using as source: ``SourceTemplate`` for a template or ``SourceAnalysis`` for an analysis. Both of these require an Amazon Resource Name (ARN). For ``SourceTemplate`` , specify the ARN of the source template. For ``SourceAnalysis`` , specify the ARN of the source analysis. The ``SourceTemplate`` ARN can contain any AWS account and any
|
|
2664
|
+
In ``SourceEntity`` , you specify the type of object you're using as source: ``SourceTemplate`` for a template or ``SourceAnalysis`` for an analysis. Both of these require an Amazon Resource Name (ARN). For ``SourceTemplate`` , specify the ARN of the source template. For ``SourceAnalysis`` , specify the ARN of the source analysis. The ``SourceTemplate`` ARN can contain any AWS account and any Quick Sight-supported AWS Region .
|
|
2664
2665
|
|
|
2665
2666
|
Use the ``DataSetReferences`` entity within ``SourceTemplate`` or ``SourceAnalysis`` to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
|
|
2666
2667
|
|
|
@@ -2746,7 +2747,7 @@ class CfnThemeProps:
|
|
|
2746
2747
|
'''Properties for defining a ``CfnTheme``.
|
|
2747
2748
|
|
|
2748
2749
|
:param aws_account_id: The ID of the AWS account where you want to store the new theme.
|
|
2749
|
-
:param base_theme_id: The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon
|
|
2750
|
+
:param base_theme_id: The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon Quick Sight. For a list of the starting themes, use ``ListThemes`` or choose *Themes* from within an analysis.
|
|
2750
2751
|
:param configuration: The theme configuration, which contains the theme display properties.
|
|
2751
2752
|
:param name: A display name for the theme.
|
|
2752
2753
|
:param theme_id: An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.
|
|
@@ -2867,7 +2868,7 @@ class CfnThemeProps:
|
|
|
2867
2868
|
def base_theme_id(self) -> builtins.str:
|
|
2868
2869
|
'''The ID of the theme that a custom theme will inherit from.
|
|
2869
2870
|
|
|
2870
|
-
All themes inherit from one of the starting themes defined by Amazon
|
|
2871
|
+
All themes inherit from one of the starting themes defined by Amazon Quick Sight. For a list of the starting themes, use ``ListThemes`` or choose *Themes* from within an analysis.
|
|
2871
2872
|
|
|
2872
2873
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html#cfn-quicksight-theme-basethemeid
|
|
2873
2874
|
'''
|
|
@@ -4873,7 +4874,7 @@ class CfnAnalysis(
|
|
|
4873
4874
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
4874
4875
|
:param analysis_id: The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
|
|
4875
4876
|
:param aws_account_id: The ID of the AWS account where you are creating an analysis.
|
|
4876
|
-
:param name: A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon
|
|
4877
|
+
:param name: A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon Quick Sight console.
|
|
4877
4878
|
:param definition:
|
|
4878
4879
|
:param errors: Errors associated with the analysis.
|
|
4879
4880
|
:param folder_arns:
|
|
@@ -4883,7 +4884,7 @@ class CfnAnalysis(
|
|
|
4883
4884
|
:param source_entity: A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets. Either a ``SourceEntity`` or a ``Definition`` must be provided in order for the request to be valid.
|
|
4884
4885
|
:param status: Status associated with the analysis.
|
|
4885
4886
|
:param tags: Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
|
|
4886
|
-
:param theme_arn: The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon
|
|
4887
|
+
:param theme_arn: The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon Quick Sight console, make sure that you have access to it.
|
|
4887
4888
|
:param validation_strategy: The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to ``LENIENT`` , validation is skipped for specific errors.
|
|
4888
4889
|
'''
|
|
4889
4890
|
if __debug__:
|
|
@@ -5599,9 +5600,9 @@ class CfnAnalysis(
|
|
|
5599
5600
|
:param analysis_defaults:
|
|
5600
5601
|
:param calculated_fields: An array of calculated field definitions for the analysis.
|
|
5601
5602
|
:param column_configurations: An array of analysis-level column configurations. Column configurations can be used to set default formatting for a column to be used throughout an analysis.
|
|
5602
|
-
:param filter_groups: Filter definitions for an analysis. For more information, see `Filtering Data in Amazon
|
|
5603
|
+
:param filter_groups: Filter definitions for an analysis. For more information, see `Filtering Data in Amazon Quick Sight <https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
5603
5604
|
:param options: An array of option definitions for an analysis.
|
|
5604
|
-
:param parameter_declarations: An array of parameter declarations for an analysis. Parameters are named variables that can transfer a value for use by an action or an object. For more information, see `Parameters in Amazon
|
|
5605
|
+
:param parameter_declarations: An array of parameter declarations for an analysis. Parameters are named variables that can transfer a value for use by an action or an object. For more information, see `Parameters in Amazon Quick Sight <https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
5605
5606
|
:param query_execution_options:
|
|
5606
5607
|
:param sheets: An array of sheet definitions for an analysis. Each ``SheetDefinition`` provides detailed information about a sheet within this analysis.
|
|
5607
5608
|
:param static_files: The static files for the definition.
|
|
@@ -5701,7 +5702,7 @@ class CfnAnalysis(
|
|
|
5701
5702
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.FilterGroupProperty"]]]]:
|
|
5702
5703
|
'''Filter definitions for an analysis.
|
|
5703
5704
|
|
|
5704
|
-
For more information, see `Filtering Data in Amazon
|
|
5705
|
+
For more information, see `Filtering Data in Amazon Quick Sight <https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
5705
5706
|
|
|
5706
5707
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html#cfn-quicksight-analysis-analysisdefinition-filtergroups
|
|
5707
5708
|
'''
|
|
@@ -5727,7 +5728,7 @@ class CfnAnalysis(
|
|
|
5727
5728
|
|
|
5728
5729
|
Parameters are named variables that can transfer a value for use by an action or an object.
|
|
5729
5730
|
|
|
5730
|
-
For more information, see `Parameters in Amazon
|
|
5731
|
+
For more information, see `Parameters in Amazon Quick Sight <https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
5731
5732
|
|
|
5732
5733
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html#cfn-quicksight-analysis-analysisdefinition-parameterdeclarations
|
|
5733
5734
|
'''
|
|
@@ -8197,7 +8198,7 @@ class CfnAnalysis(
|
|
|
8197
8198
|
- Horizontal stacked 100% bar chart
|
|
8198
8199
|
- Vertical stacked 100% bar chart
|
|
8199
8200
|
|
|
8200
|
-
For more information, see `Using bar charts <https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html>`_ in the *Amazon
|
|
8201
|
+
For more information, see `Using bar charts <https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
8201
8202
|
|
|
8202
8203
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
8203
8204
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -10040,7 +10041,7 @@ class CfnAnalysis(
|
|
|
10040
10041
|
) -> None:
|
|
10041
10042
|
'''A box plot.
|
|
10042
10043
|
|
|
10043
|
-
For more information, see `Using box plots <https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html>`_ in the *Amazon
|
|
10044
|
+
For more information, see `Using box plots <https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
10044
10045
|
|
|
10045
10046
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
10046
10047
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -10938,8 +10939,8 @@ class CfnAnalysis(
|
|
|
10938
10939
|
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
|
|
10939
10940
|
|
|
10940
10941
|
:param custom_filter_configuration: A custom filter that filters based on a single value. This filter can be partially matched.
|
|
10941
|
-
:param custom_filter_list_configuration: A list of custom filter values. In the
|
|
10942
|
-
:param filter_list_configuration: A list of filter configurations. In the
|
|
10942
|
+
:param custom_filter_list_configuration: A list of custom filter values. In the Quick Sight console, this filter type is called a custom filter list.
|
|
10943
|
+
:param filter_list_configuration: A list of filter configurations. In the Quick Sight console, this filter type is called a filter list.
|
|
10943
10944
|
|
|
10944
10945
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoryfilterconfiguration.html
|
|
10945
10946
|
:exampleMetadata: fixture=_generated
|
|
@@ -11010,7 +11011,7 @@ class CfnAnalysis(
|
|
|
11010
11011
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.CustomFilterListConfigurationProperty"]]:
|
|
11011
11012
|
'''A list of custom filter values.
|
|
11012
11013
|
|
|
11013
|
-
In the
|
|
11014
|
+
In the Quick Sight console, this filter type is called a custom filter list.
|
|
11014
11015
|
|
|
11015
11016
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoryfilterconfiguration.html#cfn-quicksight-analysis-categoryfilterconfiguration-customfilterlistconfiguration
|
|
11016
11017
|
'''
|
|
@@ -11023,7 +11024,7 @@ class CfnAnalysis(
|
|
|
11023
11024
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.FilterListConfigurationProperty"]]:
|
|
11024
11025
|
'''A list of filter configurations.
|
|
11025
11026
|
|
|
11026
|
-
In the
|
|
11027
|
+
In the Quick Sight console, this filter type is called a filter list.
|
|
11027
11028
|
|
|
11028
11029
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-categoryfilterconfiguration.html#cfn-quicksight-analysis-categoryfilterconfiguration-filterlistconfiguration
|
|
11029
11030
|
'''
|
|
@@ -11062,7 +11063,7 @@ class CfnAnalysis(
|
|
|
11062
11063
|
) -> None:
|
|
11063
11064
|
'''A ``CategoryFilter`` filters text values.
|
|
11064
11065
|
|
|
11065
|
-
For more information, see `Adding text filters <https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html>`_ in the *Amazon
|
|
11066
|
+
For more information, see `Adding text filters <https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
11066
11067
|
|
|
11067
11068
|
:param column: The column that the filter is applied to.
|
|
11068
11069
|
:param configuration: The configuration for a ``CategoryFilter`` .
|
|
@@ -13725,7 +13726,7 @@ class CfnAnalysis(
|
|
|
13725
13726
|
|
|
13726
13727
|
The ``ComboChartVisual`` includes stacked bar combo charts and clustered bar combo charts
|
|
13727
13728
|
|
|
13728
|
-
For more information, see `Using combo charts <https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html>`_ in the *Amazon
|
|
13729
|
+
For more information, see `Using combo charts <https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
13729
13730
|
|
|
13730
13731
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
13731
13732
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -15830,7 +15831,7 @@ class CfnAnalysis(
|
|
|
15830
15831
|
) -> None:
|
|
15831
15832
|
'''A visual that contains custom content.
|
|
15832
15833
|
|
|
15833
|
-
For more information, see `Using custom visual content <https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html>`_ in the *Amazon
|
|
15834
|
+
For more information, see `Using custom visual content <https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
15834
15835
|
|
|
15835
15836
|
:param data_set_identifier: The dataset that is used to create the custom content visual. You can't create a visual without a dataset.
|
|
15836
15837
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
@@ -21982,7 +21983,7 @@ class CfnAnalysis(
|
|
|
21982
21983
|
|
|
21983
21984
|
This option isn't available for pie charts.
|
|
21984
21985
|
|
|
21985
|
-
:param label_visibility: Determines the visibility of the label in a donut chart. In the
|
|
21986
|
+
:param label_visibility: Determines the visibility of the label in a donut chart. In the Quick Sight console, this option is called ``'Show total'`` .
|
|
21986
21987
|
|
|
21987
21988
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-donutcenteroptions.html
|
|
21988
21989
|
:exampleMetadata: fixture=_generated
|
|
@@ -22008,7 +22009,7 @@ class CfnAnalysis(
|
|
|
22008
22009
|
def label_visibility(self) -> typing.Optional[builtins.str]:
|
|
22009
22010
|
'''Determines the visibility of the label in a donut chart.
|
|
22010
22011
|
|
|
22011
|
-
In the
|
|
22012
|
+
In the Quick Sight console, this option is called ``'Show total'`` .
|
|
22012
22013
|
|
|
22013
22014
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-donutcenteroptions.html#cfn-quicksight-analysis-donutcenteroptions-labelvisibility
|
|
22014
22015
|
'''
|
|
@@ -22479,7 +22480,7 @@ class CfnAnalysis(
|
|
|
22479
22480
|
) -> None:
|
|
22480
22481
|
'''An empty visual.
|
|
22481
22482
|
|
|
22482
|
-
Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the
|
|
22483
|
+
Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the Quick Sight console is considered an ``EmptyVisual`` until a visual type is selected.
|
|
22483
22484
|
|
|
22484
22485
|
:param data_set_identifier: The data set that is used in the empty visual. Every visual requires a dataset to render.
|
|
22485
22486
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
@@ -24134,7 +24135,7 @@ class CfnAnalysis(
|
|
|
24134
24135
|
) -> None:
|
|
24135
24136
|
'''A filled map.
|
|
24136
24137
|
|
|
24137
|
-
For more information, see `Creating filled maps <https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html>`_ in the *Amazon
|
|
24138
|
+
For more information, see `Creating filled maps <https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
24138
24139
|
|
|
24139
24140
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
24140
24141
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -25255,7 +25256,7 @@ class CfnAnalysis(
|
|
|
25255
25256
|
) -> None:
|
|
25256
25257
|
'''A grouping of individual filters. Filter groups are applied to the same group of visuals.
|
|
25257
25258
|
|
|
25258
|
-
For more information, see `Adding filter conditions (group filters) with AND and OR operators <https://docs.aws.amazon.com/quicksight/latest/user/add-a-compound-filter.html>`_ in the *Amazon
|
|
25259
|
+
For more information, see `Adding filter conditions (group filters) with AND and OR operators <https://docs.aws.amazon.com/quicksight/latest/user/add-a-compound-filter.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
25259
25260
|
|
|
25260
25261
|
:param cross_dataset: The filter new feature which can apply filter group to all data sets. Choose one of the following options:. - ``ALL_DATASETS`` - ``SINGLE_DATASET``
|
|
25261
25262
|
:param filter_group_id: The value that uniquely identifies a ``FilterGroup`` within a dashboard, template, or analysis.
|
|
@@ -25869,7 +25870,7 @@ class CfnAnalysis(
|
|
|
25869
25870
|
|
|
25870
25871
|
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
|
|
25871
25872
|
|
|
25872
|
-
:param category_filter: A ``CategoryFilter`` filters text values. For more information, see `Adding text filters <https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html>`_ in the *Amazon
|
|
25873
|
+
:param category_filter: A ``CategoryFilter`` filters text values. For more information, see `Adding text filters <https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
25873
25874
|
:param nested_filter: A ``NestedFilter`` filters data with a subset of data that is defined by the nested inner filter.
|
|
25874
25875
|
:param numeric_equality_filter: A ``NumericEqualityFilter`` filters numeric values that equal or do not equal a given numeric value.
|
|
25875
25876
|
:param numeric_range_filter: A ``NumericRangeFilter`` filters numeric values that are either inside or outside a given numeric range.
|
|
@@ -25919,7 +25920,7 @@ class CfnAnalysis(
|
|
|
25919
25920
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.CategoryFilterProperty"]]:
|
|
25920
25921
|
'''A ``CategoryFilter`` filters text values.
|
|
25921
25922
|
|
|
25922
|
-
For more information, see `Adding text filters <https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html>`_ in the *Amazon
|
|
25923
|
+
For more information, see `Adding text filters <https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
25923
25924
|
|
|
25924
25925
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filter.html#cfn-quicksight-analysis-filter-categoryfilter
|
|
25925
25926
|
'''
|
|
@@ -29080,7 +29081,7 @@ class CfnAnalysis(
|
|
|
29080
29081
|
) -> None:
|
|
29081
29082
|
'''A funnel chart.
|
|
29082
29083
|
|
|
29083
|
-
For more information, see `Using funnel charts <https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html>`_ in the *Amazon
|
|
29084
|
+
For more information, see `Using funnel charts <https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
29084
29085
|
|
|
29085
29086
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
29086
29087
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -30179,7 +30180,7 @@ class CfnAnalysis(
|
|
|
30179
30180
|
) -> None:
|
|
30180
30181
|
'''A gauge chart.
|
|
30181
30182
|
|
|
30182
|
-
For more information, see `Using gauge charts <https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html>`_ in the *Amazon
|
|
30183
|
+
For more information, see `Using gauge charts <https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
30183
30184
|
|
|
30184
30185
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
30185
30186
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -33130,7 +33131,7 @@ class CfnAnalysis(
|
|
|
33130
33131
|
) -> None:
|
|
33131
33132
|
'''A geospatial map or a points on map visual.
|
|
33132
33133
|
|
|
33133
|
-
For more information, see `Creating point maps <https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html>`_ in the *Amazon
|
|
33134
|
+
For more information, see `Creating point maps <https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
33134
33135
|
|
|
33135
33136
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
33136
33137
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -35073,7 +35074,7 @@ class CfnAnalysis(
|
|
|
35073
35074
|
) -> None:
|
|
35074
35075
|
'''The options that determine the sizing of the canvas used in a grid layout.
|
|
35075
35076
|
|
|
35076
|
-
:param resize_option: This value determines the layout behavior when the viewport is resized. - ``FIXED`` : A fixed width will be used when optimizing the layout. In the
|
|
35077
|
+
:param resize_option: This value determines the layout behavior when the viewport is resized. - ``FIXED`` : A fixed width will be used when optimizing the layout. In the Quick Sight console, this option is called ``Classic`` . - ``RESPONSIVE`` : The width of the canvas will be responsive and optimized to the view port. In the Quick Sight console, this option is called ``Tiled`` .
|
|
35077
35078
|
:param optimized_view_port_width: The width that the view port will be optimized for when the layout renders.
|
|
35078
35079
|
|
|
35079
35080
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gridlayoutscreencanvassizeoptions.html
|
|
@@ -35106,8 +35107,8 @@ class CfnAnalysis(
|
|
|
35106
35107
|
def resize_option(self) -> builtins.str:
|
|
35107
35108
|
'''This value determines the layout behavior when the viewport is resized.
|
|
35108
35109
|
|
|
35109
|
-
- ``FIXED`` : A fixed width will be used when optimizing the layout. In the
|
|
35110
|
-
- ``RESPONSIVE`` : The width of the canvas will be responsive and optimized to the view port. In the
|
|
35110
|
+
- ``FIXED`` : A fixed width will be used when optimizing the layout. In the Quick Sight console, this option is called ``Classic`` .
|
|
35111
|
+
- ``RESPONSIVE`` : The width of the canvas will be responsive and optimized to the view port. In the Quick Sight console, this option is called ``Tiled`` .
|
|
35111
35112
|
|
|
35112
35113
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-gridlayoutscreencanvassizeoptions.html#cfn-quicksight-analysis-gridlayoutscreencanvassizeoptions-resizeoption
|
|
35113
35114
|
'''
|
|
@@ -35917,7 +35918,7 @@ class CfnAnalysis(
|
|
|
35917
35918
|
) -> None:
|
|
35918
35919
|
'''A heat map.
|
|
35919
35920
|
|
|
35920
|
-
For more information, see `Using heat maps <https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html>`_ in the *Amazon
|
|
35921
|
+
For more information, see `Using heat maps <https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
35921
35922
|
|
|
35922
35923
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
35923
35924
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -37008,7 +37009,7 @@ class CfnAnalysis(
|
|
|
37008
37009
|
) -> None:
|
|
37009
37010
|
'''A histogram.
|
|
37010
37011
|
|
|
37011
|
-
For more information, see `Using histograms <https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html>`_ in the *Amazon
|
|
37012
|
+
For more information, see `Using histograms <https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
37012
37013
|
|
|
37013
37014
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
37014
37015
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -38038,7 +38039,7 @@ class CfnAnalysis(
|
|
|
38038
38039
|
) -> None:
|
|
38039
38040
|
'''An insight visual.
|
|
38040
38041
|
|
|
38041
|
-
For more information, see `Working with insights <https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html>`_ in the *Amazon
|
|
38042
|
+
For more information, see `Working with insights <https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
38042
38043
|
|
|
38043
38044
|
:param data_set_identifier: The dataset that is used in the insight visual.
|
|
38044
38045
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
@@ -40290,7 +40291,7 @@ class CfnAnalysis(
|
|
|
40290
40291
|
) -> None:
|
|
40291
40292
|
'''A key performance indicator (KPI).
|
|
40292
40293
|
|
|
40293
|
-
For more information, see `Using KPIs <https://docs.aws.amazon.com/quicksight/latest/user/kpi.html>`_ in the *Amazon
|
|
40294
|
+
For more information, see `Using KPIs <https://docs.aws.amazon.com/quicksight/latest/user/kpi.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
40294
40295
|
|
|
40295
40296
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
40296
40297
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -41480,7 +41481,7 @@ class CfnAnalysis(
|
|
|
41480
41481
|
) -> None:
|
|
41481
41482
|
'''A ``Layout`` defines the placement of elements within a sheet.
|
|
41482
41483
|
|
|
41483
|
-
For more information, see `Types of layout <https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html>`_ in the *Amazon
|
|
41484
|
+
For more information, see `Types of layout <https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
41484
41485
|
|
|
41485
41486
|
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
|
|
41486
41487
|
|
|
@@ -43205,7 +43206,7 @@ class CfnAnalysis(
|
|
|
43205
43206
|
) -> None:
|
|
43206
43207
|
'''A line chart.
|
|
43207
43208
|
|
|
43208
|
-
For more information, see `Using line charts <https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html>`_ in the *Amazon
|
|
43209
|
+
For more information, see `Using line charts <https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
43209
43210
|
|
|
43210
43211
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
43211
43212
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -48248,7 +48249,7 @@ class CfnAnalysis(
|
|
|
48248
48249
|
) -> None:
|
|
48249
48250
|
'''The declaration definition of a parameter.
|
|
48250
48251
|
|
|
48251
|
-
For more information, see `Parameters in Amazon
|
|
48252
|
+
For more information, see `Parameters in Amazon Quick Sight <https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
48252
48253
|
|
|
48253
48254
|
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
|
|
48254
48255
|
|
|
@@ -49470,7 +49471,7 @@ class CfnAnalysis(
|
|
|
49470
49471
|
integer_parameters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnAnalysis.IntegerParameterProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
49471
49472
|
string_parameters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnAnalysis.StringParameterProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
49472
49473
|
) -> None:
|
|
49473
|
-
'''A list of
|
|
49474
|
+
'''A list of Quick Sight parameters and the list's override values.
|
|
49474
49475
|
|
|
49475
49476
|
:param date_time_parameters: The parameters that have a data type of date-time.
|
|
49476
49477
|
:param decimal_parameters: The parameters that have a data type of decimal.
|
|
@@ -50676,9 +50677,9 @@ class CfnAnalysis(
|
|
|
50676
50677
|
- Pie charts
|
|
50677
50678
|
- Donut charts
|
|
50678
50679
|
|
|
50679
|
-
For more information, see `Using pie charts <https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html>`_ in the *Amazon
|
|
50680
|
+
For more information, see `Using pie charts <https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
50680
50681
|
|
|
50681
|
-
For more information, see `Using donut charts <https://docs.aws.amazon.com/quicksight/latest/user/donut-chart.html>`_ in the *Amazon
|
|
50682
|
+
For more information, see `Using donut charts <https://docs.aws.amazon.com/quicksight/latest/user/donut-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
50682
50683
|
|
|
50683
50684
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
50684
50685
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -53242,7 +53243,7 @@ class CfnAnalysis(
|
|
|
53242
53243
|
) -> None:
|
|
53243
53244
|
'''A pivot table.
|
|
53244
53245
|
|
|
53245
|
-
For more information, see `Using pivot tables <https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html>`_ in the *Amazon
|
|
53246
|
+
For more information, see `Using pivot tables <https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
53246
53247
|
|
|
53247
53248
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
53248
53249
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -54055,7 +54056,7 @@ class CfnAnalysis(
|
|
|
54055
54056
|
title: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnAnalysis.VisualTitleLabelOptionsProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
54056
54057
|
visual_content_alt_text: typing.Optional[builtins.str] = None,
|
|
54057
54058
|
) -> None:
|
|
54058
|
-
'''A flexible visualization type that allows engineers to create new custom charts in
|
|
54059
|
+
'''A flexible visualization type that allows engineers to create new custom charts in Quick Sight.
|
|
54059
54060
|
|
|
54060
54061
|
:param plugin_arn: The Amazon Resource Name (ARN) that reflects the plugin and version.
|
|
54061
54062
|
:param visual_id: The ID of the visual that you want to use.
|
|
@@ -57251,7 +57252,7 @@ class CfnAnalysis(
|
|
|
57251
57252
|
'''Permission for the resource.
|
|
57252
57253
|
|
|
57253
57254
|
:param actions: The IAM action to grant or revoke permissions on.
|
|
57254
|
-
:param principal: The Amazon Resource Name (ARN) of the principal. This can be one of the following:. - The ARN of an Amazon
|
|
57255
|
+
:param principal: The Amazon Resource Name (ARN) of the principal. This can be one of the following:. - The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is common.) - The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) - The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
|
|
57255
57256
|
:param resource:
|
|
57256
57257
|
|
|
57257
57258
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-resourcepermission.html
|
|
@@ -57297,9 +57298,9 @@ class CfnAnalysis(
|
|
|
57297
57298
|
def principal(self) -> builtins.str:
|
|
57298
57299
|
'''The Amazon Resource Name (ARN) of the principal. This can be one of the following:.
|
|
57299
57300
|
|
|
57300
|
-
- The ARN of an Amazon
|
|
57301
|
-
- The ARN of an Amazon
|
|
57302
|
-
- The ARN of an AWS account root: This is an IAM ARN rather than a
|
|
57301
|
+
- The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is common.)
|
|
57302
|
+
- The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
|
|
57303
|
+
- The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
|
|
57303
57304
|
|
|
57304
57305
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-resourcepermission.html#cfn-quicksight-analysis-resourcepermission-principal
|
|
57305
57306
|
'''
|
|
@@ -57968,7 +57969,7 @@ class CfnAnalysis(
|
|
|
57968
57969
|
) -> None:
|
|
57969
57970
|
'''A sankey diagram.
|
|
57970
57971
|
|
|
57971
|
-
For more information, see `Using Sankey diagrams <https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html>`_ in the *Amazon
|
|
57972
|
+
For more information, see `Using Sankey diagrams <https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
57972
57973
|
|
|
57973
57974
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
57974
57975
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -58719,7 +58720,7 @@ class CfnAnalysis(
|
|
|
58719
58720
|
) -> None:
|
|
58720
58721
|
'''A scatter plot.
|
|
58721
58722
|
|
|
58722
|
-
For more information, see `Using scatter plots <https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html>`_ in the *Amazon
|
|
58723
|
+
For more information, see `Using scatter plots <https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
58723
58724
|
|
|
58724
58725
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
58725
58726
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -60405,11 +60406,11 @@ class CfnAnalysis(
|
|
|
60405
60406
|
:param sheet_id: The unique identifier of a sheet.
|
|
60406
60407
|
:param content_type: The layout content type of the sheet. Choose one of the following options:. - ``PAGINATED`` : Creates a sheet for a paginated report. - ``INTERACTIVE`` : Creates a sheet for an interactive dashboard.
|
|
60407
60408
|
:param description: A description of the sheet.
|
|
60408
|
-
:param filter_controls: The list of filter controls that are on a sheet. For more information, see `Adding filter controls to analysis sheets <https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html>`_ in the *Amazon
|
|
60409
|
+
:param filter_controls: The list of filter controls that are on a sheet. For more information, see `Adding filter controls to analysis sheets <https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
60409
60410
|
:param images: A list of images on a sheet.
|
|
60410
|
-
:param layouts: Layouts define how the components of a sheet are arranged. For more information, see `Types of layout <https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html>`_ in the *Amazon
|
|
60411
|
+
:param layouts: Layouts define how the components of a sheet are arranged. For more information, see `Types of layout <https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
60411
60412
|
:param name: The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
|
|
60412
|
-
:param parameter_controls: The list of parameter controls that are on a sheet. For more information, see `Using a Control with a Parameter in Amazon
|
|
60413
|
+
:param parameter_controls: The list of parameter controls that are on a sheet. For more information, see `Using a Control with a Parameter in Amazon Quick Sight <https://docs.aws.amazon.com/quicksight/latest/user/parameters-controls.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
60413
60414
|
:param sheet_control_layouts: The control layouts of the sheet.
|
|
60414
60415
|
:param text_boxes: The text boxes that are on a sheet.
|
|
60415
60416
|
:param title: The title of the sheet.
|
|
@@ -60499,7 +60500,7 @@ class CfnAnalysis(
|
|
|
60499
60500
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.FilterControlProperty"]]]]:
|
|
60500
60501
|
'''The list of filter controls that are on a sheet.
|
|
60501
60502
|
|
|
60502
|
-
For more information, see `Adding filter controls to analysis sheets <https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html>`_ in the *Amazon
|
|
60503
|
+
For more information, see `Adding filter controls to analysis sheets <https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
60503
60504
|
|
|
60504
60505
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetdefinition.html#cfn-quicksight-analysis-sheetdefinition-filtercontrols
|
|
60505
60506
|
'''
|
|
@@ -60523,7 +60524,7 @@ class CfnAnalysis(
|
|
|
60523
60524
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.LayoutProperty"]]]]:
|
|
60524
60525
|
'''Layouts define how the components of a sheet are arranged.
|
|
60525
60526
|
|
|
60526
|
-
For more information, see `Types of layout <https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html>`_ in the *Amazon
|
|
60527
|
+
For more information, see `Types of layout <https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
60527
60528
|
|
|
60528
60529
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetdefinition.html#cfn-quicksight-analysis-sheetdefinition-layouts
|
|
60529
60530
|
'''
|
|
@@ -60547,7 +60548,7 @@ class CfnAnalysis(
|
|
|
60547
60548
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.ParameterControlProperty"]]]]:
|
|
60548
60549
|
'''The list of parameter controls that are on a sheet.
|
|
60549
60550
|
|
|
60550
|
-
For more information, see `Using a Control with a Parameter in Amazon
|
|
60551
|
+
For more information, see `Using a Control with a Parameter in Amazon Quick Sight <https://docs.aws.amazon.com/quicksight/latest/user/parameters-controls.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
60551
60552
|
|
|
60552
60553
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheetdefinition.html#cfn-quicksight-analysis-sheetdefinition-parametercontrols
|
|
60553
60554
|
'''
|
|
@@ -61275,11 +61276,11 @@ class CfnAnalysis(
|
|
|
61275
61276
|
name: typing.Optional[builtins.str] = None,
|
|
61276
61277
|
sheet_id: typing.Optional[builtins.str] = None,
|
|
61277
61278
|
) -> None:
|
|
61278
|
-
'''A *sheet* , which is an object that contains a set of visuals that are viewed together on one page in
|
|
61279
|
+
'''A *sheet* , which is an object that contains a set of visuals that are viewed together on one page in Quick Sight.
|
|
61279
61280
|
|
|
61280
61281
|
Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.
|
|
61281
61282
|
|
|
61282
|
-
:param name: The name of a sheet. This name is displayed on the sheet's tab in the
|
|
61283
|
+
:param name: The name of a sheet. This name is displayed on the sheet's tab in the Quick Sight console.
|
|
61283
61284
|
:param sheet_id: The unique identifier associated with a sheet.
|
|
61284
61285
|
|
|
61285
61286
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheet.html
|
|
@@ -61310,7 +61311,7 @@ class CfnAnalysis(
|
|
|
61310
61311
|
def name(self) -> typing.Optional[builtins.str]:
|
|
61311
61312
|
'''The name of a sheet.
|
|
61312
61313
|
|
|
61313
|
-
This name is displayed on the sheet's tab in the
|
|
61314
|
+
This name is displayed on the sheet's tab in the Quick Sight console.
|
|
61314
61315
|
|
|
61315
61316
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheet.html#cfn-quicksight-analysis-sheet-name
|
|
61316
61317
|
'''
|
|
@@ -66607,7 +66608,7 @@ class CfnAnalysis(
|
|
|
66607
66608
|
) -> None:
|
|
66608
66609
|
'''A table visual.
|
|
66609
66610
|
|
|
66610
|
-
For more information, see `Using tables as visuals <https://docs.aws.amazon.com/quicksight/latest/user/tabular.html>`_ in the *Amazon
|
|
66611
|
+
For more information, see `Using tables as visuals <https://docs.aws.amazon.com/quicksight/latest/user/tabular.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
66611
66612
|
|
|
66612
66613
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
66613
66614
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -70702,7 +70703,7 @@ class CfnAnalysis(
|
|
|
70702
70703
|
) -> None:
|
|
70703
70704
|
'''A tree map.
|
|
70704
70705
|
|
|
70705
|
-
For more information, see `Using tree maps <https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html>`_ in the *Amazon
|
|
70706
|
+
For more information, see `Using tree maps <https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
70706
70707
|
|
|
70707
70708
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
70708
70709
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -72288,31 +72289,31 @@ class CfnAnalysis(
|
|
|
72288
72289
|
|
|
72289
72290
|
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
|
|
72290
72291
|
|
|
72291
|
-
:param bar_chart_visual: A bar chart. For more information, see `Using bar charts <https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html>`_ in the *Amazon
|
|
72292
|
-
:param box_plot_visual: A box plot. For more information, see `Using box plots <https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html>`_ in the *Amazon
|
|
72293
|
-
:param combo_chart_visual: A combo chart. For more information, see `Using combo charts <https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html>`_ in the *Amazon
|
|
72294
|
-
:param custom_content_visual: A visual that contains custom content. For more information, see `Using custom visual content <https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html>`_ in the *Amazon
|
|
72292
|
+
:param bar_chart_visual: A bar chart. For more information, see `Using bar charts <https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72293
|
+
:param box_plot_visual: A box plot. For more information, see `Using box plots <https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72294
|
+
:param combo_chart_visual: A combo chart. For more information, see `Using combo charts <https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72295
|
+
:param custom_content_visual: A visual that contains custom content. For more information, see `Using custom visual content <https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72295
72296
|
:param empty_visual: An empty visual.
|
|
72296
|
-
:param filled_map_visual: A filled map. For more information, see `Creating filled maps <https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html>`_ in the *Amazon
|
|
72297
|
-
:param funnel_chart_visual: A funnel chart. For more information, see `Using funnel charts <https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html>`_ in the *Amazon
|
|
72298
|
-
:param gauge_chart_visual: A gauge chart. For more information, see `Using gauge charts <https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html>`_ in the *Amazon
|
|
72299
|
-
:param geospatial_map_visual: A geospatial map or a points on map visual. For more information, see `Creating point maps <https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html>`_ in the *Amazon
|
|
72300
|
-
:param heat_map_visual: A heat map. For more information, see `Using heat maps <https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html>`_ in the *Amazon
|
|
72301
|
-
:param histogram_visual: A histogram. For more information, see `Using histograms <https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html>`_ in the *Amazon
|
|
72302
|
-
:param insight_visual: An insight visual. For more information, see `Working with insights <https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html>`_ in the *Amazon
|
|
72303
|
-
:param kpi_visual: A key performance indicator (KPI). For more information, see `Using KPIs <https://docs.aws.amazon.com/quicksight/latest/user/kpi.html>`_ in the *Amazon
|
|
72297
|
+
:param filled_map_visual: A filled map. For more information, see `Creating filled maps <https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72298
|
+
:param funnel_chart_visual: A funnel chart. For more information, see `Using funnel charts <https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72299
|
+
:param gauge_chart_visual: A gauge chart. For more information, see `Using gauge charts <https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72300
|
+
:param geospatial_map_visual: A geospatial map or a points on map visual. For more information, see `Creating point maps <https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72301
|
+
:param heat_map_visual: A heat map. For more information, see `Using heat maps <https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72302
|
+
:param histogram_visual: A histogram. For more information, see `Using histograms <https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72303
|
+
:param insight_visual: An insight visual. For more information, see `Working with insights <https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72304
|
+
:param kpi_visual: A key performance indicator (KPI). For more information, see `Using KPIs <https://docs.aws.amazon.com/quicksight/latest/user/kpi.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72304
72305
|
:param layer_map_visual: The properties for a layer map visual.
|
|
72305
|
-
:param line_chart_visual: A line chart. For more information, see `Using line charts <https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html>`_ in the *Amazon
|
|
72306
|
-
:param pie_chart_visual: A pie or donut chart. For more information, see `Using pie charts <https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html>`_ in the *Amazon
|
|
72307
|
-
:param pivot_table_visual: A pivot table. For more information, see `Using pivot tables <https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html>`_ in the *Amazon
|
|
72306
|
+
:param line_chart_visual: A line chart. For more information, see `Using line charts <https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72307
|
+
:param pie_chart_visual: A pie or donut chart. For more information, see `Using pie charts <https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72308
|
+
:param pivot_table_visual: A pivot table. For more information, see `Using pivot tables <https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72308
72309
|
:param plugin_visual: The custom plugin visual type.
|
|
72309
|
-
:param radar_chart_visual: A radar chart visual. For more information, see `Using radar charts <https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html>`_ in the *Amazon
|
|
72310
|
-
:param sankey_diagram_visual: A sankey diagram. For more information, see `Using Sankey diagrams <https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html>`_ in the *Amazon
|
|
72311
|
-
:param scatter_plot_visual: A scatter plot. For more information, see `Using scatter plots <https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html>`_ in the *Amazon
|
|
72312
|
-
:param table_visual: A table visual. For more information, see `Using tables as visuals <https://docs.aws.amazon.com/quicksight/latest/user/tabular.html>`_ in the *Amazon
|
|
72313
|
-
:param tree_map_visual: A tree map. For more information, see `Using tree maps <https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html>`_ in the *Amazon
|
|
72314
|
-
:param waterfall_visual: A waterfall chart. For more information, see `Using waterfall charts <https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html>`_ in the *Amazon
|
|
72315
|
-
:param word_cloud_visual: A word cloud. For more information, see `Using word clouds <https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html>`_ in the *Amazon
|
|
72310
|
+
:param radar_chart_visual: A radar chart visual. For more information, see `Using radar charts <https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72311
|
+
:param sankey_diagram_visual: A sankey diagram. For more information, see `Using Sankey diagrams <https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72312
|
+
:param scatter_plot_visual: A scatter plot. For more information, see `Using scatter plots <https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72313
|
+
:param table_visual: A table visual. For more information, see `Using tables as visuals <https://docs.aws.amazon.com/quicksight/latest/user/tabular.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72314
|
+
:param tree_map_visual: A tree map. For more information, see `Using tree maps <https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72315
|
+
:param waterfall_visual: A waterfall chart. For more information, see `Using waterfall charts <https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72316
|
+
:param word_cloud_visual: A word cloud. For more information, see `Using word clouds <https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72316
72317
|
|
|
72317
72318
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html
|
|
72318
72319
|
:exampleMetadata: fixture=_generated
|
|
@@ -72406,7 +72407,7 @@ class CfnAnalysis(
|
|
|
72406
72407
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.BarChartVisualProperty"]]:
|
|
72407
72408
|
'''A bar chart.
|
|
72408
72409
|
|
|
72409
|
-
For more information, see `Using bar charts <https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html>`_ in the *Amazon
|
|
72410
|
+
For more information, see `Using bar charts <https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72410
72411
|
|
|
72411
72412
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-barchartvisual
|
|
72412
72413
|
'''
|
|
@@ -72419,7 +72420,7 @@ class CfnAnalysis(
|
|
|
72419
72420
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.BoxPlotVisualProperty"]]:
|
|
72420
72421
|
'''A box plot.
|
|
72421
72422
|
|
|
72422
|
-
For more information, see `Using box plots <https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html>`_ in the *Amazon
|
|
72423
|
+
For more information, see `Using box plots <https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72423
72424
|
|
|
72424
72425
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-boxplotvisual
|
|
72425
72426
|
'''
|
|
@@ -72432,7 +72433,7 @@ class CfnAnalysis(
|
|
|
72432
72433
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.ComboChartVisualProperty"]]:
|
|
72433
72434
|
'''A combo chart.
|
|
72434
72435
|
|
|
72435
|
-
For more information, see `Using combo charts <https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html>`_ in the *Amazon
|
|
72436
|
+
For more information, see `Using combo charts <https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72436
72437
|
|
|
72437
72438
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-combochartvisual
|
|
72438
72439
|
'''
|
|
@@ -72445,7 +72446,7 @@ class CfnAnalysis(
|
|
|
72445
72446
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.CustomContentVisualProperty"]]:
|
|
72446
72447
|
'''A visual that contains custom content.
|
|
72447
72448
|
|
|
72448
|
-
For more information, see `Using custom visual content <https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html>`_ in the *Amazon
|
|
72449
|
+
For more information, see `Using custom visual content <https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72449
72450
|
|
|
72450
72451
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-customcontentvisual
|
|
72451
72452
|
'''
|
|
@@ -72469,7 +72470,7 @@ class CfnAnalysis(
|
|
|
72469
72470
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.FilledMapVisualProperty"]]:
|
|
72470
72471
|
'''A filled map.
|
|
72471
72472
|
|
|
72472
|
-
For more information, see `Creating filled maps <https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html>`_ in the *Amazon
|
|
72473
|
+
For more information, see `Creating filled maps <https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72473
72474
|
|
|
72474
72475
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-filledmapvisual
|
|
72475
72476
|
'''
|
|
@@ -72482,7 +72483,7 @@ class CfnAnalysis(
|
|
|
72482
72483
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.FunnelChartVisualProperty"]]:
|
|
72483
72484
|
'''A funnel chart.
|
|
72484
72485
|
|
|
72485
|
-
For more information, see `Using funnel charts <https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html>`_ in the *Amazon
|
|
72486
|
+
For more information, see `Using funnel charts <https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72486
72487
|
|
|
72487
72488
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-funnelchartvisual
|
|
72488
72489
|
'''
|
|
@@ -72495,7 +72496,7 @@ class CfnAnalysis(
|
|
|
72495
72496
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.GaugeChartVisualProperty"]]:
|
|
72496
72497
|
'''A gauge chart.
|
|
72497
72498
|
|
|
72498
|
-
For more information, see `Using gauge charts <https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html>`_ in the *Amazon
|
|
72499
|
+
For more information, see `Using gauge charts <https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72499
72500
|
|
|
72500
72501
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-gaugechartvisual
|
|
72501
72502
|
'''
|
|
@@ -72508,7 +72509,7 @@ class CfnAnalysis(
|
|
|
72508
72509
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.GeospatialMapVisualProperty"]]:
|
|
72509
72510
|
'''A geospatial map or a points on map visual.
|
|
72510
72511
|
|
|
72511
|
-
For more information, see `Creating point maps <https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html>`_ in the *Amazon
|
|
72512
|
+
For more information, see `Creating point maps <https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72512
72513
|
|
|
72513
72514
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-geospatialmapvisual
|
|
72514
72515
|
'''
|
|
@@ -72521,7 +72522,7 @@ class CfnAnalysis(
|
|
|
72521
72522
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.HeatMapVisualProperty"]]:
|
|
72522
72523
|
'''A heat map.
|
|
72523
72524
|
|
|
72524
|
-
For more information, see `Using heat maps <https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html>`_ in the *Amazon
|
|
72525
|
+
For more information, see `Using heat maps <https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72525
72526
|
|
|
72526
72527
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-heatmapvisual
|
|
72527
72528
|
'''
|
|
@@ -72534,7 +72535,7 @@ class CfnAnalysis(
|
|
|
72534
72535
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.HistogramVisualProperty"]]:
|
|
72535
72536
|
'''A histogram.
|
|
72536
72537
|
|
|
72537
|
-
For more information, see `Using histograms <https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html>`_ in the *Amazon
|
|
72538
|
+
For more information, see `Using histograms <https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72538
72539
|
|
|
72539
72540
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-histogramvisual
|
|
72540
72541
|
'''
|
|
@@ -72547,7 +72548,7 @@ class CfnAnalysis(
|
|
|
72547
72548
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.InsightVisualProperty"]]:
|
|
72548
72549
|
'''An insight visual.
|
|
72549
72550
|
|
|
72550
|
-
For more information, see `Working with insights <https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html>`_ in the *Amazon
|
|
72551
|
+
For more information, see `Working with insights <https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72551
72552
|
|
|
72552
72553
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-insightvisual
|
|
72553
72554
|
'''
|
|
@@ -72560,7 +72561,7 @@ class CfnAnalysis(
|
|
|
72560
72561
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.KPIVisualProperty"]]:
|
|
72561
72562
|
'''A key performance indicator (KPI).
|
|
72562
72563
|
|
|
72563
|
-
For more information, see `Using KPIs <https://docs.aws.amazon.com/quicksight/latest/user/kpi.html>`_ in the *Amazon
|
|
72564
|
+
For more information, see `Using KPIs <https://docs.aws.amazon.com/quicksight/latest/user/kpi.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72564
72565
|
|
|
72565
72566
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-kpivisual
|
|
72566
72567
|
'''
|
|
@@ -72584,7 +72585,7 @@ class CfnAnalysis(
|
|
|
72584
72585
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.LineChartVisualProperty"]]:
|
|
72585
72586
|
'''A line chart.
|
|
72586
72587
|
|
|
72587
|
-
For more information, see `Using line charts <https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html>`_ in the *Amazon
|
|
72588
|
+
For more information, see `Using line charts <https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72588
72589
|
|
|
72589
72590
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-linechartvisual
|
|
72590
72591
|
'''
|
|
@@ -72597,7 +72598,7 @@ class CfnAnalysis(
|
|
|
72597
72598
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.PieChartVisualProperty"]]:
|
|
72598
72599
|
'''A pie or donut chart.
|
|
72599
72600
|
|
|
72600
|
-
For more information, see `Using pie charts <https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html>`_ in the *Amazon
|
|
72601
|
+
For more information, see `Using pie charts <https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72601
72602
|
|
|
72602
72603
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-piechartvisual
|
|
72603
72604
|
'''
|
|
@@ -72610,7 +72611,7 @@ class CfnAnalysis(
|
|
|
72610
72611
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.PivotTableVisualProperty"]]:
|
|
72611
72612
|
'''A pivot table.
|
|
72612
72613
|
|
|
72613
|
-
For more information, see `Using pivot tables <https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html>`_ in the *Amazon
|
|
72614
|
+
For more information, see `Using pivot tables <https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72614
72615
|
|
|
72615
72616
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-pivottablevisual
|
|
72616
72617
|
'''
|
|
@@ -72634,7 +72635,7 @@ class CfnAnalysis(
|
|
|
72634
72635
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.RadarChartVisualProperty"]]:
|
|
72635
72636
|
'''A radar chart visual.
|
|
72636
72637
|
|
|
72637
|
-
For more information, see `Using radar charts <https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html>`_ in the *Amazon
|
|
72638
|
+
For more information, see `Using radar charts <https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72638
72639
|
|
|
72639
72640
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-radarchartvisual
|
|
72640
72641
|
'''
|
|
@@ -72647,7 +72648,7 @@ class CfnAnalysis(
|
|
|
72647
72648
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.SankeyDiagramVisualProperty"]]:
|
|
72648
72649
|
'''A sankey diagram.
|
|
72649
72650
|
|
|
72650
|
-
For more information, see `Using Sankey diagrams <https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html>`_ in the *Amazon
|
|
72651
|
+
For more information, see `Using Sankey diagrams <https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72651
72652
|
|
|
72652
72653
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-sankeydiagramvisual
|
|
72653
72654
|
'''
|
|
@@ -72660,7 +72661,7 @@ class CfnAnalysis(
|
|
|
72660
72661
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.ScatterPlotVisualProperty"]]:
|
|
72661
72662
|
'''A scatter plot.
|
|
72662
72663
|
|
|
72663
|
-
For more information, see `Using scatter plots <https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html>`_ in the *Amazon
|
|
72664
|
+
For more information, see `Using scatter plots <https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72664
72665
|
|
|
72665
72666
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-scatterplotvisual
|
|
72666
72667
|
'''
|
|
@@ -72673,7 +72674,7 @@ class CfnAnalysis(
|
|
|
72673
72674
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.TableVisualProperty"]]:
|
|
72674
72675
|
'''A table visual.
|
|
72675
72676
|
|
|
72676
|
-
For more information, see `Using tables as visuals <https://docs.aws.amazon.com/quicksight/latest/user/tabular.html>`_ in the *Amazon
|
|
72677
|
+
For more information, see `Using tables as visuals <https://docs.aws.amazon.com/quicksight/latest/user/tabular.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72677
72678
|
|
|
72678
72679
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-tablevisual
|
|
72679
72680
|
'''
|
|
@@ -72686,7 +72687,7 @@ class CfnAnalysis(
|
|
|
72686
72687
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.TreeMapVisualProperty"]]:
|
|
72687
72688
|
'''A tree map.
|
|
72688
72689
|
|
|
72689
|
-
For more information, see `Using tree maps <https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html>`_ in the *Amazon
|
|
72690
|
+
For more information, see `Using tree maps <https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72690
72691
|
|
|
72691
72692
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-treemapvisual
|
|
72692
72693
|
'''
|
|
@@ -72699,7 +72700,7 @@ class CfnAnalysis(
|
|
|
72699
72700
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.WaterfallVisualProperty"]]:
|
|
72700
72701
|
'''A waterfall chart.
|
|
72701
72702
|
|
|
72702
|
-
For more information, see `Using waterfall charts <https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html>`_ in the *Amazon
|
|
72703
|
+
For more information, see `Using waterfall charts <https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72703
72704
|
|
|
72704
72705
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-waterfallvisual
|
|
72705
72706
|
'''
|
|
@@ -72712,7 +72713,7 @@ class CfnAnalysis(
|
|
|
72712
72713
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAnalysis.WordCloudVisualProperty"]]:
|
|
72713
72714
|
'''A word cloud.
|
|
72714
72715
|
|
|
72715
|
-
For more information, see `Using word clouds <https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html>`_ in the *Amazon
|
|
72716
|
+
For more information, see `Using word clouds <https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
72716
72717
|
|
|
72717
72718
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-visual.html#cfn-quicksight-analysis-visual-wordcloudvisual
|
|
72718
72719
|
'''
|
|
@@ -73600,7 +73601,7 @@ class CfnAnalysis(
|
|
|
73600
73601
|
) -> None:
|
|
73601
73602
|
'''A waterfall chart.
|
|
73602
73603
|
|
|
73603
|
-
For more information, see `Using waterfall charts <https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html>`_ in the *Amazon
|
|
73604
|
+
For more information, see `Using waterfall charts <https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
73604
73605
|
|
|
73605
73606
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
73606
73607
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -74408,7 +74409,7 @@ class CfnAnalysis(
|
|
|
74408
74409
|
) -> None:
|
|
74409
74410
|
'''A word cloud.
|
|
74410
74411
|
|
|
74411
|
-
For more information, see `Using word clouds <https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html>`_ in the *Amazon
|
|
74412
|
+
For more information, see `Using word clouds <https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
74412
74413
|
|
|
74413
74414
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
74414
74415
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -74854,7 +74855,7 @@ class CfnCustomPermissions(
|
|
|
74854
74855
|
subscribe_dashboard_email_reports: typing.Optional[builtins.str] = None,
|
|
74855
74856
|
view_account_spice_capacity: typing.Optional[builtins.str] = None,
|
|
74856
74857
|
) -> None:
|
|
74857
|
-
'''A set of actions that correspond to Amazon
|
|
74858
|
+
'''A set of actions that correspond to Amazon Quick Sight permissions.
|
|
74858
74859
|
|
|
74859
74860
|
:param add_or_run_anomaly_detection_for_analyses: The ability to add or run anomaly detection.
|
|
74860
74861
|
:param analysis: The ability to perform analysis-related actions.
|
|
@@ -75249,7 +75250,7 @@ class CfnDashboard(
|
|
|
75249
75250
|
):
|
|
75250
75251
|
'''Creates a dashboard from a template. To first create a template, see the ``CreateTemplate`` API operation.
|
|
75251
75252
|
|
|
75252
|
-
A dashboard is an entity in
|
|
75253
|
+
A dashboard is an entity in Quick Suite that identifies Quick Suite reports, created from analyses. You can share Quick Suite dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account .
|
|
75253
75254
|
|
|
75254
75255
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html
|
|
75255
75256
|
:cloudformationResource: AWS::QuickSight::Dashboard
|
|
@@ -75287,7 +75288,7 @@ class CfnDashboard(
|
|
|
75287
75288
|
:param aws_account_id: The ID of the AWS account where you want to create the dashboard.
|
|
75288
75289
|
:param dashboard_id: The ID for the dashboard, also added to the IAM policy.
|
|
75289
75290
|
:param name: The display name of the dashboard.
|
|
75290
|
-
:param dashboard_publish_options: Options for publishing the dashboard when you create it:. - ``AvailabilityStatus`` for ``AdHocFilteringOption`` - This status can be either ``ENABLED`` or ``DISABLED`` . When this is set to ``DISABLED`` , Amazon
|
|
75291
|
+
:param dashboard_publish_options: Options for publishing the dashboard when you create it:. - ``AvailabilityStatus`` for ``AdHocFilteringOption`` - This status can be either ``ENABLED`` or ``DISABLED`` . When this is set to ``DISABLED`` , Amazon Quick Sight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ``ENABLED`` by default. - ``AvailabilityStatus`` for ``ExportToCSVOption`` - This status can be either ``ENABLED`` or ``DISABLED`` . The visual option to export data to .CSV format isn't enabled when this is set to ``DISABLED`` . This option is ``ENABLED`` by default. - ``VisibilityState`` for ``SheetControlsOption`` - This visibility state can be either ``COLLAPSED`` or ``EXPANDED`` . This option is ``COLLAPSED`` by default. - ``AvailabilityStatus`` for ``QuickSuiteActionsOption`` - This status can be either ``ENABLED`` or ``DISABLED`` . Features related to Actions in Amazon Quick Suite on dashboards are disabled when this is set to ``DISABLED`` . This option is ``DISABLED`` by default. - ``AvailabilityStatus`` for ``ExecutiveSummaryOption`` - This status can be either ``ENABLED`` or ``DISABLED`` . The option to build an executive summary is disabled when this is set to ``DISABLED`` . This option is ``ENABLED`` by default. - ``AvailabilityStatus`` for ``DataStoriesSharingOption`` - This status can be either ``ENABLED`` or ``DISABLED`` . The option to share a data story is disabled when this is set to ``DISABLED`` . This option is ``ENABLED`` by default.
|
|
75291
75292
|
:param definition:
|
|
75292
75293
|
:param folder_arns:
|
|
75293
75294
|
:param link_entities: A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
|
|
@@ -78338,7 +78339,7 @@ class CfnDashboard(
|
|
|
78338
78339
|
- Horizontal stacked 100% bar chart
|
|
78339
78340
|
- Vertical stacked 100% bar chart
|
|
78340
78341
|
|
|
78341
|
-
For more information, see `Using bar charts <https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html>`_ in the *Amazon
|
|
78342
|
+
For more information, see `Using bar charts <https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
78342
78343
|
|
|
78343
78344
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
78344
78345
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -80181,7 +80182,7 @@ class CfnDashboard(
|
|
|
80181
80182
|
) -> None:
|
|
80182
80183
|
'''A box plot.
|
|
80183
80184
|
|
|
80184
|
-
For more information, see `Using box plots <https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html>`_ in the *Amazon
|
|
80185
|
+
For more information, see `Using box plots <https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
80185
80186
|
|
|
80186
80187
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
80187
80188
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -81079,8 +81080,8 @@ class CfnDashboard(
|
|
|
81079
81080
|
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
|
|
81080
81081
|
|
|
81081
81082
|
:param custom_filter_configuration: A custom filter that filters based on a single value. This filter can be partially matched.
|
|
81082
|
-
:param custom_filter_list_configuration: A list of custom filter values. In the
|
|
81083
|
-
:param filter_list_configuration: A list of filter configurations. In the
|
|
81083
|
+
:param custom_filter_list_configuration: A list of custom filter values. In the Quick Sight console, this filter type is called a custom filter list.
|
|
81084
|
+
:param filter_list_configuration: A list of filter configurations. In the Quick Sight console, this filter type is called a filter list.
|
|
81084
81085
|
|
|
81085
81086
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoryfilterconfiguration.html
|
|
81086
81087
|
:exampleMetadata: fixture=_generated
|
|
@@ -81151,7 +81152,7 @@ class CfnDashboard(
|
|
|
81151
81152
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.CustomFilterListConfigurationProperty"]]:
|
|
81152
81153
|
'''A list of custom filter values.
|
|
81153
81154
|
|
|
81154
|
-
In the
|
|
81155
|
+
In the Quick Sight console, this filter type is called a custom filter list.
|
|
81155
81156
|
|
|
81156
81157
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoryfilterconfiguration.html#cfn-quicksight-dashboard-categoryfilterconfiguration-customfilterlistconfiguration
|
|
81157
81158
|
'''
|
|
@@ -81164,7 +81165,7 @@ class CfnDashboard(
|
|
|
81164
81165
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.FilterListConfigurationProperty"]]:
|
|
81165
81166
|
'''A list of filter configurations.
|
|
81166
81167
|
|
|
81167
|
-
In the
|
|
81168
|
+
In the Quick Sight console, this filter type is called a filter list.
|
|
81168
81169
|
|
|
81169
81170
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-categoryfilterconfiguration.html#cfn-quicksight-dashboard-categoryfilterconfiguration-filterlistconfiguration
|
|
81170
81171
|
'''
|
|
@@ -81203,7 +81204,7 @@ class CfnDashboard(
|
|
|
81203
81204
|
) -> None:
|
|
81204
81205
|
'''A ``CategoryFilter`` filters text values.
|
|
81205
81206
|
|
|
81206
|
-
For more information, see `Adding text filters <https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html>`_ in the *Amazon
|
|
81207
|
+
For more information, see `Adding text filters <https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
81207
81208
|
|
|
81208
81209
|
:param column: The column that the filter is applied to.
|
|
81209
81210
|
:param configuration: The configuration for a ``CategoryFilter`` .
|
|
@@ -83866,7 +83867,7 @@ class CfnDashboard(
|
|
|
83866
83867
|
|
|
83867
83868
|
The ``ComboChartVisual`` includes stacked bar combo charts and clustered bar combo charts
|
|
83868
83869
|
|
|
83869
|
-
For more information, see `Using combo charts <https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html>`_ in the *Amazon
|
|
83870
|
+
For more information, see `Using combo charts <https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
83870
83871
|
|
|
83871
83872
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
83872
83873
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -85971,7 +85972,7 @@ class CfnDashboard(
|
|
|
85971
85972
|
) -> None:
|
|
85972
85973
|
'''A visual that contains custom content.
|
|
85973
85974
|
|
|
85974
|
-
For more information, see `Using custom visual content <https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html>`_ in the *Amazon
|
|
85975
|
+
For more information, see `Using custom visual content <https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
85975
85976
|
|
|
85976
85977
|
:param data_set_identifier: The dataset that is used to create the custom content visual. You can't create a visual without a dataset.
|
|
85977
85978
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
@@ -86800,6 +86801,7 @@ class CfnDashboard(
|
|
|
86800
86801
|
"executive_summary_option": "executiveSummaryOption",
|
|
86801
86802
|
"export_to_csv_option": "exportToCsvOption",
|
|
86802
86803
|
"export_with_hidden_fields_option": "exportWithHiddenFieldsOption",
|
|
86804
|
+
"quick_suite_actions_option": "quickSuiteActionsOption",
|
|
86803
86805
|
"sheet_controls_option": "sheetControlsOption",
|
|
86804
86806
|
"sheet_layout_element_maximization_option": "sheetLayoutElementMaximizationOption",
|
|
86805
86807
|
"visual_axis_sort_option": "visualAxisSortOption",
|
|
@@ -86820,6 +86822,7 @@ class CfnDashboard(
|
|
|
86820
86822
|
executive_summary_option: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDashboard.ExecutiveSummaryOptionProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
86821
86823
|
export_to_csv_option: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDashboard.ExportToCSVOptionProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
86822
86824
|
export_with_hidden_fields_option: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDashboard.ExportWithHiddenFieldsOptionProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
86825
|
+
quick_suite_actions_option: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDashboard.QuickSuiteActionsOptionProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
86823
86826
|
sheet_controls_option: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDashboard.SheetControlsOptionProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
86824
86827
|
sheet_layout_element_maximization_option: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDashboard.SheetLayoutElementMaximizationOptionProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
86825
86828
|
visual_axis_sort_option: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDashboard.VisualAxisSortOptionProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
@@ -86832,11 +86835,12 @@ class CfnDashboard(
|
|
|
86832
86835
|
:param data_point_drill_up_down_option: The drill-down options of data points in a dashboard.
|
|
86833
86836
|
:param data_point_menu_label_option: The data point menu label options of a dashboard.
|
|
86834
86837
|
:param data_point_tooltip_option: The data point tool tip options of a dashboard.
|
|
86835
|
-
:param data_qa_enabled_option: Adds Q&A capabilities to an
|
|
86838
|
+
:param data_qa_enabled_option: Adds Q&A capabilities to an Quick Sight dashboard. If no topic is linked, Dashboard Q&A uses the data values that are rendered on the dashboard. End users can use Dashboard Q&A to ask for different slices of the data that they see on the dashboard. If a topic is linked, Topic Q&A is used.
|
|
86836
86839
|
:param data_stories_sharing_option: Data stories sharing option.
|
|
86837
86840
|
:param executive_summary_option: Executive summary option.
|
|
86838
86841
|
:param export_to_csv_option: Export to .csv option.
|
|
86839
86842
|
:param export_with_hidden_fields_option: Determines if hidden fields are exported with a dashboard.
|
|
86843
|
+
:param quick_suite_actions_option: Determines if Actions in Amazon Quick Suite are enabled in a dashboard.
|
|
86840
86844
|
:param sheet_controls_option: Sheet controls option.
|
|
86841
86845
|
:param sheet_layout_element_maximization_option: The sheet layout maximization options of a dashbaord.
|
|
86842
86846
|
:param visual_axis_sort_option: The axis sort options of a dashboard.
|
|
@@ -86880,6 +86884,9 @@ class CfnDashboard(
|
|
|
86880
86884
|
export_with_hidden_fields_option=quicksight.CfnDashboard.ExportWithHiddenFieldsOptionProperty(
|
|
86881
86885
|
availability_status="availabilityStatus"
|
|
86882
86886
|
),
|
|
86887
|
+
quick_suite_actions_option=quicksight.CfnDashboard.QuickSuiteActionsOptionProperty(
|
|
86888
|
+
availability_status="availabilityStatus"
|
|
86889
|
+
),
|
|
86883
86890
|
sheet_controls_option=quicksight.CfnDashboard.SheetControlsOptionProperty(
|
|
86884
86891
|
visibility_state="visibilityState"
|
|
86885
86892
|
),
|
|
@@ -86910,6 +86917,7 @@ class CfnDashboard(
|
|
|
86910
86917
|
check_type(argname="argument executive_summary_option", value=executive_summary_option, expected_type=type_hints["executive_summary_option"])
|
|
86911
86918
|
check_type(argname="argument export_to_csv_option", value=export_to_csv_option, expected_type=type_hints["export_to_csv_option"])
|
|
86912
86919
|
check_type(argname="argument export_with_hidden_fields_option", value=export_with_hidden_fields_option, expected_type=type_hints["export_with_hidden_fields_option"])
|
|
86920
|
+
check_type(argname="argument quick_suite_actions_option", value=quick_suite_actions_option, expected_type=type_hints["quick_suite_actions_option"])
|
|
86913
86921
|
check_type(argname="argument sheet_controls_option", value=sheet_controls_option, expected_type=type_hints["sheet_controls_option"])
|
|
86914
86922
|
check_type(argname="argument sheet_layout_element_maximization_option", value=sheet_layout_element_maximization_option, expected_type=type_hints["sheet_layout_element_maximization_option"])
|
|
86915
86923
|
check_type(argname="argument visual_axis_sort_option", value=visual_axis_sort_option, expected_type=type_hints["visual_axis_sort_option"])
|
|
@@ -86934,6 +86942,8 @@ class CfnDashboard(
|
|
|
86934
86942
|
self._values["export_to_csv_option"] = export_to_csv_option
|
|
86935
86943
|
if export_with_hidden_fields_option is not None:
|
|
86936
86944
|
self._values["export_with_hidden_fields_option"] = export_with_hidden_fields_option
|
|
86945
|
+
if quick_suite_actions_option is not None:
|
|
86946
|
+
self._values["quick_suite_actions_option"] = quick_suite_actions_option
|
|
86937
86947
|
if sheet_controls_option is not None:
|
|
86938
86948
|
self._values["sheet_controls_option"] = sheet_controls_option
|
|
86939
86949
|
if sheet_layout_element_maximization_option is not None:
|
|
@@ -86993,7 +87003,7 @@ class CfnDashboard(
|
|
|
86993
87003
|
def data_qa_enabled_option(
|
|
86994
87004
|
self,
|
|
86995
87005
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.DataQAEnabledOptionProperty"]]:
|
|
86996
|
-
'''Adds Q&A capabilities to an
|
|
87006
|
+
'''Adds Q&A capabilities to an Quick Sight dashboard.
|
|
86997
87007
|
|
|
86998
87008
|
If no topic is linked, Dashboard Q&A uses the data values that are rendered on the dashboard. End users can use Dashboard Q&A to ask for different slices of the data that they see on the dashboard. If a topic is linked, Topic Q&A is used.
|
|
86999
87009
|
|
|
@@ -87046,6 +87056,17 @@ class CfnDashboard(
|
|
|
87046
87056
|
result = self._values.get("export_with_hidden_fields_option")
|
|
87047
87057
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.ExportWithHiddenFieldsOptionProperty"]], result)
|
|
87048
87058
|
|
|
87059
|
+
@builtins.property
|
|
87060
|
+
def quick_suite_actions_option(
|
|
87061
|
+
self,
|
|
87062
|
+
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.QuickSuiteActionsOptionProperty"]]:
|
|
87063
|
+
'''Determines if Actions in Amazon Quick Suite are enabled in a dashboard.
|
|
87064
|
+
|
|
87065
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-quicksuiteactionsoption
|
|
87066
|
+
'''
|
|
87067
|
+
result = self._values.get("quick_suite_actions_option")
|
|
87068
|
+
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.QuickSuiteActionsOptionProperty"]], result)
|
|
87069
|
+
|
|
87049
87070
|
@builtins.property
|
|
87050
87071
|
def sheet_controls_option(
|
|
87051
87072
|
self,
|
|
@@ -87286,9 +87307,9 @@ class CfnDashboard(
|
|
|
87286
87307
|
:param analysis_defaults:
|
|
87287
87308
|
:param calculated_fields: An array of calculated field definitions for the dashboard.
|
|
87288
87309
|
:param column_configurations: An array of dashboard-level column configurations. Column configurations are used to set the default formatting for a column that is used throughout a dashboard.
|
|
87289
|
-
:param filter_groups: The filter definitions for a dashboard. For more information, see `Filtering Data in Amazon
|
|
87310
|
+
:param filter_groups: The filter definitions for a dashboard. For more information, see `Filtering Data in Amazon Quick Sight <https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
87290
87311
|
:param options: An array of option definitions for a dashboard.
|
|
87291
|
-
:param parameter_declarations: The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object. For more information, see `Parameters in Amazon
|
|
87312
|
+
:param parameter_declarations: The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object. For more information, see `Parameters in Amazon Quick Sight <https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
87292
87313
|
:param sheets: An array of sheet definitions for a dashboard.
|
|
87293
87314
|
:param static_files: The static files for the definition.
|
|
87294
87315
|
|
|
@@ -87384,7 +87405,7 @@ class CfnDashboard(
|
|
|
87384
87405
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnDashboard.FilterGroupProperty"]]]]:
|
|
87385
87406
|
'''The filter definitions for a dashboard.
|
|
87386
87407
|
|
|
87387
|
-
For more information, see `Filtering Data in Amazon
|
|
87408
|
+
For more information, see `Filtering Data in Amazon Quick Sight <https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
87388
87409
|
|
|
87389
87410
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversiondefinition.html#cfn-quicksight-dashboard-dashboardversiondefinition-filtergroups
|
|
87390
87411
|
'''
|
|
@@ -87410,7 +87431,7 @@ class CfnDashboard(
|
|
|
87410
87431
|
|
|
87411
87432
|
Parameters are named variables that can transfer a value for use by an action or an object.
|
|
87412
87433
|
|
|
87413
|
-
For more information, see `Parameters in Amazon
|
|
87434
|
+
For more information, see `Parameters in Amazon Quick Sight <https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
87414
87435
|
|
|
87415
87436
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardversiondefinition.html#cfn-quicksight-dashboard-dashboardversiondefinition-parameterdeclarations
|
|
87416
87437
|
'''
|
|
@@ -93429,7 +93450,7 @@ class CfnDashboard(
|
|
|
93429
93450
|
|
|
93430
93451
|
This option isn't available for pie charts.
|
|
93431
93452
|
|
|
93432
|
-
:param label_visibility: Determines the visibility of the label in a donut chart. In the
|
|
93453
|
+
:param label_visibility: Determines the visibility of the label in a donut chart. In the Quick Sight console, this option is called ``'Show total'`` .
|
|
93433
93454
|
|
|
93434
93455
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-donutcenteroptions.html
|
|
93435
93456
|
:exampleMetadata: fixture=_generated
|
|
@@ -93455,7 +93476,7 @@ class CfnDashboard(
|
|
|
93455
93476
|
def label_visibility(self) -> typing.Optional[builtins.str]:
|
|
93456
93477
|
'''Determines the visibility of the label in a donut chart.
|
|
93457
93478
|
|
|
93458
|
-
In the
|
|
93479
|
+
In the Quick Sight console, this option is called ``'Show total'`` .
|
|
93459
93480
|
|
|
93460
93481
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-donutcenteroptions.html#cfn-quicksight-dashboard-donutcenteroptions-labelvisibility
|
|
93461
93482
|
'''
|
|
@@ -93926,7 +93947,7 @@ class CfnDashboard(
|
|
|
93926
93947
|
) -> None:
|
|
93927
93948
|
'''An empty visual.
|
|
93928
93949
|
|
|
93929
|
-
Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the
|
|
93950
|
+
Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the Quick Sight console is considered an ``EmptyVisual`` until a visual type is selected.
|
|
93930
93951
|
|
|
93931
93952
|
:param data_set_identifier: The data set that is used in the empty visual. Every visual requires a dataset to render.
|
|
93932
93953
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
@@ -95801,7 +95822,7 @@ class CfnDashboard(
|
|
|
95801
95822
|
) -> None:
|
|
95802
95823
|
'''A filled map.
|
|
95803
95824
|
|
|
95804
|
-
For more information, see `Creating filled maps <https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html>`_ in the *Amazon
|
|
95825
|
+
For more information, see `Creating filled maps <https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
95805
95826
|
|
|
95806
95827
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
95807
95828
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -96922,7 +96943,7 @@ class CfnDashboard(
|
|
|
96922
96943
|
) -> None:
|
|
96923
96944
|
'''A grouping of individual filters. Filter groups are applied to the same group of visuals.
|
|
96924
96945
|
|
|
96925
|
-
For more information, see `Adding filter conditions (group filters) with AND and OR operators <https://docs.aws.amazon.com/quicksight/latest/user/add-a-compound-filter.html>`_ in the *Amazon
|
|
96946
|
+
For more information, see `Adding filter conditions (group filters) with AND and OR operators <https://docs.aws.amazon.com/quicksight/latest/user/add-a-compound-filter.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
96926
96947
|
|
|
96927
96948
|
:param cross_dataset: The filter new feature which can apply filter group to all data sets. Choose one of the following options:. - ``ALL_DATASETS`` - ``SINGLE_DATASET``
|
|
96928
96949
|
:param filter_group_id: The value that uniquely identifies a ``FilterGroup`` within a dashboard, template, or analysis.
|
|
@@ -97536,7 +97557,7 @@ class CfnDashboard(
|
|
|
97536
97557
|
|
|
97537
97558
|
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
|
|
97538
97559
|
|
|
97539
|
-
:param category_filter: A ``CategoryFilter`` filters text values. For more information, see `Adding text filters <https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html>`_ in the *Amazon
|
|
97560
|
+
:param category_filter: A ``CategoryFilter`` filters text values. For more information, see `Adding text filters <https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
97540
97561
|
:param nested_filter: A ``NestedFilter`` filters data with a subset of data that is defined by the nested inner filter.
|
|
97541
97562
|
:param numeric_equality_filter: A ``NumericEqualityFilter`` filters numeric values that equal or do not equal a given numeric value.
|
|
97542
97563
|
:param numeric_range_filter: A ``NumericRangeFilter`` filters numeric values that are either inside or outside a given numeric range.
|
|
@@ -97586,7 +97607,7 @@ class CfnDashboard(
|
|
|
97586
97607
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.CategoryFilterProperty"]]:
|
|
97587
97608
|
'''A ``CategoryFilter`` filters text values.
|
|
97588
97609
|
|
|
97589
|
-
For more information, see `Adding text filters <https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html>`_ in the *Amazon
|
|
97610
|
+
For more information, see `Adding text filters <https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
97590
97611
|
|
|
97591
97612
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filter.html#cfn-quicksight-dashboard-filter-categoryfilter
|
|
97592
97613
|
'''
|
|
@@ -100747,7 +100768,7 @@ class CfnDashboard(
|
|
|
100747
100768
|
) -> None:
|
|
100748
100769
|
'''A funnel chart.
|
|
100749
100770
|
|
|
100750
|
-
For more information, see `Using funnel charts <https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html>`_ in the *Amazon
|
|
100771
|
+
For more information, see `Using funnel charts <https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
100751
100772
|
|
|
100752
100773
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
100753
100774
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -101846,7 +101867,7 @@ class CfnDashboard(
|
|
|
101846
101867
|
) -> None:
|
|
101847
101868
|
'''A gauge chart.
|
|
101848
101869
|
|
|
101849
|
-
For more information, see `Using gauge charts <https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html>`_ in the *Amazon
|
|
101870
|
+
For more information, see `Using gauge charts <https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
101850
101871
|
|
|
101851
101872
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
101852
101873
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -104797,7 +104818,7 @@ class CfnDashboard(
|
|
|
104797
104818
|
) -> None:
|
|
104798
104819
|
'''A geospatial map or a points on map visual.
|
|
104799
104820
|
|
|
104800
|
-
For more information, see `Creating point maps <https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html>`_ in the *Amazon
|
|
104821
|
+
For more information, see `Creating point maps <https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
104801
104822
|
|
|
104802
104823
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
104803
104824
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -106740,7 +106761,7 @@ class CfnDashboard(
|
|
|
106740
106761
|
) -> None:
|
|
106741
106762
|
'''The options that determine the sizing of the canvas used in a grid layout.
|
|
106742
106763
|
|
|
106743
|
-
:param resize_option: This value determines the layout behavior when the viewport is resized. - ``FIXED`` : A fixed width will be used when optimizing the layout. In the
|
|
106764
|
+
:param resize_option: This value determines the layout behavior when the viewport is resized. - ``FIXED`` : A fixed width will be used when optimizing the layout. In the Quick Sight console, this option is called ``Classic`` . - ``RESPONSIVE`` : The width of the canvas will be responsive and optimized to the view port. In the Quick Sight console, this option is called ``Tiled`` .
|
|
106744
106765
|
:param optimized_view_port_width: The width that the view port will be optimized for when the layout renders.
|
|
106745
106766
|
|
|
106746
106767
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutscreencanvassizeoptions.html
|
|
@@ -106773,8 +106794,8 @@ class CfnDashboard(
|
|
|
106773
106794
|
def resize_option(self) -> builtins.str:
|
|
106774
106795
|
'''This value determines the layout behavior when the viewport is resized.
|
|
106775
106796
|
|
|
106776
|
-
- ``FIXED`` : A fixed width will be used when optimizing the layout. In the
|
|
106777
|
-
- ``RESPONSIVE`` : The width of the canvas will be responsive and optimized to the view port. In the
|
|
106797
|
+
- ``FIXED`` : A fixed width will be used when optimizing the layout. In the Quick Sight console, this option is called ``Classic`` .
|
|
106798
|
+
- ``RESPONSIVE`` : The width of the canvas will be responsive and optimized to the view port. In the Quick Sight console, this option is called ``Tiled`` .
|
|
106778
106799
|
|
|
106779
106800
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-gridlayoutscreencanvassizeoptions.html#cfn-quicksight-dashboard-gridlayoutscreencanvassizeoptions-resizeoption
|
|
106780
106801
|
'''
|
|
@@ -107584,7 +107605,7 @@ class CfnDashboard(
|
|
|
107584
107605
|
) -> None:
|
|
107585
107606
|
'''A heat map.
|
|
107586
107607
|
|
|
107587
|
-
For more information, see `Using heat maps <https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html>`_ in the *Amazon
|
|
107608
|
+
For more information, see `Using heat maps <https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
107588
107609
|
|
|
107589
107610
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
107590
107611
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -108675,7 +108696,7 @@ class CfnDashboard(
|
|
|
108675
108696
|
) -> None:
|
|
108676
108697
|
'''A histogram.
|
|
108677
108698
|
|
|
108678
|
-
For more information, see `Using histograms <https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html>`_ in the *Amazon
|
|
108699
|
+
For more information, see `Using histograms <https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
108679
108700
|
|
|
108680
108701
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
108681
108702
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -109705,7 +109726,7 @@ class CfnDashboard(
|
|
|
109705
109726
|
) -> None:
|
|
109706
109727
|
'''An insight visual.
|
|
109707
109728
|
|
|
109708
|
-
For more information, see `Working with insights <https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html>`_ in the *Amazon
|
|
109729
|
+
For more information, see `Working with insights <https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
109709
109730
|
|
|
109710
109731
|
:param data_set_identifier: The dataset that is used in the insight visual.
|
|
109711
109732
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
@@ -111957,7 +111978,7 @@ class CfnDashboard(
|
|
|
111957
111978
|
) -> None:
|
|
111958
111979
|
'''A key performance indicator (KPI).
|
|
111959
111980
|
|
|
111960
|
-
For more information, see `Using KPIs <https://docs.aws.amazon.com/quicksight/latest/user/kpi.html>`_ in the *Amazon
|
|
111981
|
+
For more information, see `Using KPIs <https://docs.aws.amazon.com/quicksight/latest/user/kpi.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
111961
111982
|
|
|
111962
111983
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
111963
111984
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -113147,7 +113168,7 @@ class CfnDashboard(
|
|
|
113147
113168
|
) -> None:
|
|
113148
113169
|
'''A ``Layout`` defines the placement of elements within a sheet.
|
|
113149
113170
|
|
|
113150
|
-
For more information, see `Types of layout <https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html>`_ in the *Amazon
|
|
113171
|
+
For more information, see `Types of layout <https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
113151
113172
|
|
|
113152
113173
|
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
|
|
113153
113174
|
|
|
@@ -114872,7 +114893,7 @@ class CfnDashboard(
|
|
|
114872
114893
|
) -> None:
|
|
114873
114894
|
'''A line chart.
|
|
114874
114895
|
|
|
114875
|
-
For more information, see `Using line charts <https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html>`_ in the *Amazon
|
|
114896
|
+
For more information, see `Using line charts <https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
114876
114897
|
|
|
114877
114898
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
114878
114899
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -119978,7 +119999,7 @@ class CfnDashboard(
|
|
|
119978
119999
|
) -> None:
|
|
119979
120000
|
'''The declaration definition of a parameter.
|
|
119980
120001
|
|
|
119981
|
-
For more information, see `Parameters in Amazon
|
|
120002
|
+
For more information, see `Parameters in Amazon Quick Sight <https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
119982
120003
|
|
|
119983
120004
|
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
|
|
119984
120005
|
|
|
@@ -121200,7 +121221,7 @@ class CfnDashboard(
|
|
|
121200
121221
|
integer_parameters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDashboard.IntegerParameterProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
121201
121222
|
string_parameters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDashboard.StringParameterProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
121202
121223
|
) -> None:
|
|
121203
|
-
'''A list of
|
|
121224
|
+
'''A list of Quick Sight parameters and the list's override values.
|
|
121204
121225
|
|
|
121205
121226
|
:param date_time_parameters: The parameters that have a data type of date-time.
|
|
121206
121227
|
:param decimal_parameters: The parameters that have a data type of decimal.
|
|
@@ -122406,9 +122427,9 @@ class CfnDashboard(
|
|
|
122406
122427
|
- Pie charts
|
|
122407
122428
|
- Donut charts
|
|
122408
122429
|
|
|
122409
|
-
For more information, see `Using pie charts <https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html>`_ in the *Amazon
|
|
122430
|
+
For more information, see `Using pie charts <https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
122410
122431
|
|
|
122411
|
-
For more information, see `Using donut charts <https://docs.aws.amazon.com/quicksight/latest/user/donut-chart.html>`_ in the *Amazon
|
|
122432
|
+
For more information, see `Using donut charts <https://docs.aws.amazon.com/quicksight/latest/user/donut-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
122412
122433
|
|
|
122413
122434
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
122414
122435
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -124972,7 +124993,7 @@ class CfnDashboard(
|
|
|
124972
124993
|
) -> None:
|
|
124973
124994
|
'''A pivot table.
|
|
124974
124995
|
|
|
124975
|
-
For more information, see `Using pivot tables <https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html>`_ in the *Amazon
|
|
124996
|
+
For more information, see `Using pivot tables <https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
124976
124997
|
|
|
124977
124998
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
124978
124999
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -125785,7 +125806,7 @@ class CfnDashboard(
|
|
|
125785
125806
|
title: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDashboard.VisualTitleLabelOptionsProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
125786
125807
|
visual_content_alt_text: typing.Optional[builtins.str] = None,
|
|
125787
125808
|
) -> None:
|
|
125788
|
-
'''A flexible visualization type that allows engineers to create new custom charts in
|
|
125809
|
+
'''A flexible visualization type that allows engineers to create new custom charts in Quick Sight.
|
|
125789
125810
|
|
|
125790
125811
|
:param plugin_arn: The Amazon Resource Name (ARN) that reflects the plugin and version.
|
|
125791
125812
|
:param visual_id: The ID of the visual that you want to use.
|
|
@@ -126336,6 +126357,61 @@ class CfnDashboard(
|
|
|
126336
126357
|
k + "=" + repr(v) for k, v in self._values.items()
|
|
126337
126358
|
)
|
|
126338
126359
|
|
|
126360
|
+
@jsii.data_type(
|
|
126361
|
+
jsii_type="aws-cdk-lib.aws_quicksight.CfnDashboard.QuickSuiteActionsOptionProperty",
|
|
126362
|
+
jsii_struct_bases=[],
|
|
126363
|
+
name_mapping={"availability_status": "availabilityStatus"},
|
|
126364
|
+
)
|
|
126365
|
+
class QuickSuiteActionsOptionProperty:
|
|
126366
|
+
def __init__(
|
|
126367
|
+
self,
|
|
126368
|
+
*,
|
|
126369
|
+
availability_status: typing.Optional[builtins.str] = None,
|
|
126370
|
+
) -> None:
|
|
126371
|
+
'''Determines if Actions in Amazon Quick Suite are enabled in a dashboard..
|
|
126372
|
+
|
|
126373
|
+
:param availability_status: Availability status.
|
|
126374
|
+
|
|
126375
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-quicksuiteactionsoption.html
|
|
126376
|
+
:exampleMetadata: fixture=_generated
|
|
126377
|
+
|
|
126378
|
+
Example::
|
|
126379
|
+
|
|
126380
|
+
# The code below shows an example of how to instantiate this type.
|
|
126381
|
+
# The values are placeholders you should change.
|
|
126382
|
+
from aws_cdk import aws_quicksight as quicksight
|
|
126383
|
+
|
|
126384
|
+
quick_suite_actions_option_property = quicksight.CfnDashboard.QuickSuiteActionsOptionProperty(
|
|
126385
|
+
availability_status="availabilityStatus"
|
|
126386
|
+
)
|
|
126387
|
+
'''
|
|
126388
|
+
if __debug__:
|
|
126389
|
+
type_hints = typing.get_type_hints(_typecheckingstub__9c8b3e1bc413fb8347a340dd8ee206f937d0c39bdda82fbb3961908543f7b81c)
|
|
126390
|
+
check_type(argname="argument availability_status", value=availability_status, expected_type=type_hints["availability_status"])
|
|
126391
|
+
self._values: typing.Dict[builtins.str, typing.Any] = {}
|
|
126392
|
+
if availability_status is not None:
|
|
126393
|
+
self._values["availability_status"] = availability_status
|
|
126394
|
+
|
|
126395
|
+
@builtins.property
|
|
126396
|
+
def availability_status(self) -> typing.Optional[builtins.str]:
|
|
126397
|
+
'''Availability status.
|
|
126398
|
+
|
|
126399
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-quicksuiteactionsoption.html#cfn-quicksight-dashboard-quicksuiteactionsoption-availabilitystatus
|
|
126400
|
+
'''
|
|
126401
|
+
result = self._values.get("availability_status")
|
|
126402
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
126403
|
+
|
|
126404
|
+
def __eq__(self, rhs: typing.Any) -> builtins.bool:
|
|
126405
|
+
return isinstance(rhs, self.__class__) and rhs._values == self._values
|
|
126406
|
+
|
|
126407
|
+
def __ne__(self, rhs: typing.Any) -> builtins.bool:
|
|
126408
|
+
return not (rhs == self)
|
|
126409
|
+
|
|
126410
|
+
def __repr__(self) -> str:
|
|
126411
|
+
return "QuickSuiteActionsOptionProperty(%s)" % ", ".join(
|
|
126412
|
+
k + "=" + repr(v) for k, v in self._values.items()
|
|
126413
|
+
)
|
|
126414
|
+
|
|
126339
126415
|
@jsii.data_type(
|
|
126340
126416
|
jsii_type="aws-cdk-lib.aws_quicksight.CfnDashboard.RadarChartAggregatedFieldWellsProperty",
|
|
126341
126417
|
jsii_struct_bases=[],
|
|
@@ -128926,7 +129002,7 @@ class CfnDashboard(
|
|
|
128926
129002
|
'''Permission for the resource.
|
|
128927
129003
|
|
|
128928
129004
|
:param actions: The IAM action to grant or revoke permissions on.
|
|
128929
|
-
:param principal: The Amazon Resource Name (ARN) of the principal. This can be one of the following:. - The ARN of an Amazon
|
|
129005
|
+
:param principal: The Amazon Resource Name (ARN) of the principal. This can be one of the following:. - The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is common.) - The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) - The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
|
|
128930
129006
|
:param resource:
|
|
128931
129007
|
|
|
128932
129008
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-resourcepermission.html
|
|
@@ -128972,9 +129048,9 @@ class CfnDashboard(
|
|
|
128972
129048
|
def principal(self) -> builtins.str:
|
|
128973
129049
|
'''The Amazon Resource Name (ARN) of the principal. This can be one of the following:.
|
|
128974
129050
|
|
|
128975
|
-
- The ARN of an Amazon
|
|
128976
|
-
- The ARN of an Amazon
|
|
128977
|
-
- The ARN of an AWS account root: This is an IAM ARN rather than a
|
|
129051
|
+
- The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is common.)
|
|
129052
|
+
- The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
|
|
129053
|
+
- The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
|
|
128978
129054
|
|
|
128979
129055
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-resourcepermission.html#cfn-quicksight-dashboard-resourcepermission-principal
|
|
128980
129056
|
'''
|
|
@@ -129643,7 +129719,7 @@ class CfnDashboard(
|
|
|
129643
129719
|
) -> None:
|
|
129644
129720
|
'''A sankey diagram.
|
|
129645
129721
|
|
|
129646
|
-
For more information, see `Using Sankey diagrams <https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html>`_ in the *Amazon
|
|
129722
|
+
For more information, see `Using Sankey diagrams <https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
129647
129723
|
|
|
129648
129724
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
129649
129725
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -130394,7 +130470,7 @@ class CfnDashboard(
|
|
|
130394
130470
|
) -> None:
|
|
130395
130471
|
'''A scatter plot.
|
|
130396
130472
|
|
|
130397
|
-
For more information, see `Using scatter plots <https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html>`_ in the *Amazon
|
|
130473
|
+
For more information, see `Using scatter plots <https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
130398
130474
|
|
|
130399
130475
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
130400
130476
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -132135,11 +132211,11 @@ class CfnDashboard(
|
|
|
132135
132211
|
:param sheet_id: The unique identifier of a sheet.
|
|
132136
132212
|
:param content_type: The layout content type of the sheet. Choose one of the following options:. - ``PAGINATED`` : Creates a sheet for a paginated report. - ``INTERACTIVE`` : Creates a sheet for an interactive dashboard.
|
|
132137
132213
|
:param description: A description of the sheet.
|
|
132138
|
-
:param filter_controls: The list of filter controls that are on a sheet. For more information, see `Adding filter controls to analysis sheets <https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html>`_ in the *Amazon
|
|
132214
|
+
:param filter_controls: The list of filter controls that are on a sheet. For more information, see `Adding filter controls to analysis sheets <https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
132139
132215
|
:param images: A list of images on a sheet.
|
|
132140
|
-
:param layouts: Layouts define how the components of a sheet are arranged. For more information, see `Types of layout <https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html>`_ in the *Amazon
|
|
132216
|
+
:param layouts: Layouts define how the components of a sheet are arranged. For more information, see `Types of layout <https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
132141
132217
|
:param name: The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
|
|
132142
|
-
:param parameter_controls: The list of parameter controls that are on a sheet. For more information, see `Using a Control with a Parameter in Amazon
|
|
132218
|
+
:param parameter_controls: The list of parameter controls that are on a sheet. For more information, see `Using a Control with a Parameter in Amazon Quick Sight <https://docs.aws.amazon.com/quicksight/latest/user/parameters-controls.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
132143
132219
|
:param sheet_control_layouts: The control layouts of the sheet.
|
|
132144
132220
|
:param text_boxes: The text boxes that are on a sheet.
|
|
132145
132221
|
:param title: The title of the sheet.
|
|
@@ -132229,7 +132305,7 @@ class CfnDashboard(
|
|
|
132229
132305
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnDashboard.FilterControlProperty"]]]]:
|
|
132230
132306
|
'''The list of filter controls that are on a sheet.
|
|
132231
132307
|
|
|
132232
|
-
For more information, see `Adding filter controls to analysis sheets <https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html>`_ in the *Amazon
|
|
132308
|
+
For more information, see `Adding filter controls to analysis sheets <https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
132233
132309
|
|
|
132234
132310
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-sheetdefinition-filtercontrols
|
|
132235
132311
|
'''
|
|
@@ -132253,7 +132329,7 @@ class CfnDashboard(
|
|
|
132253
132329
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnDashboard.LayoutProperty"]]]]:
|
|
132254
132330
|
'''Layouts define how the components of a sheet are arranged.
|
|
132255
132331
|
|
|
132256
|
-
For more information, see `Types of layout <https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html>`_ in the *Amazon
|
|
132332
|
+
For more information, see `Types of layout <https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
132257
132333
|
|
|
132258
132334
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-sheetdefinition-layouts
|
|
132259
132335
|
'''
|
|
@@ -132277,7 +132353,7 @@ class CfnDashboard(
|
|
|
132277
132353
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnDashboard.ParameterControlProperty"]]]]:
|
|
132278
132354
|
'''The list of parameter controls that are on a sheet.
|
|
132279
132355
|
|
|
132280
|
-
For more information, see `Using a Control with a Parameter in Amazon
|
|
132356
|
+
For more information, see `Using a Control with a Parameter in Amazon Quick Sight <https://docs.aws.amazon.com/quicksight/latest/user/parameters-controls.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
132281
132357
|
|
|
132282
132358
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheetdefinition.html#cfn-quicksight-dashboard-sheetdefinition-parametercontrols
|
|
132283
132359
|
'''
|
|
@@ -133060,11 +133136,11 @@ class CfnDashboard(
|
|
|
133060
133136
|
name: typing.Optional[builtins.str] = None,
|
|
133061
133137
|
sheet_id: typing.Optional[builtins.str] = None,
|
|
133062
133138
|
) -> None:
|
|
133063
|
-
'''A *sheet* , which is an object that contains a set of visuals that are viewed together on one page in
|
|
133139
|
+
'''A *sheet* , which is an object that contains a set of visuals that are viewed together on one page in Quick Sight.
|
|
133064
133140
|
|
|
133065
133141
|
Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.
|
|
133066
133142
|
|
|
133067
|
-
:param name: The name of a sheet. This name is displayed on the sheet's tab in the
|
|
133143
|
+
:param name: The name of a sheet. This name is displayed on the sheet's tab in the Quick Sight console.
|
|
133068
133144
|
:param sheet_id: The unique identifier associated with a sheet.
|
|
133069
133145
|
|
|
133070
133146
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheet.html
|
|
@@ -133095,7 +133171,7 @@ class CfnDashboard(
|
|
|
133095
133171
|
def name(self) -> typing.Optional[builtins.str]:
|
|
133096
133172
|
'''The name of a sheet.
|
|
133097
133173
|
|
|
133098
|
-
This name is displayed on the sheet's tab in the
|
|
133174
|
+
This name is displayed on the sheet's tab in the Quick Sight console.
|
|
133099
133175
|
|
|
133100
133176
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheet.html#cfn-quicksight-dashboard-sheet-name
|
|
133101
133177
|
'''
|
|
@@ -138392,7 +138468,7 @@ class CfnDashboard(
|
|
|
138392
138468
|
) -> None:
|
|
138393
138469
|
'''A table visual.
|
|
138394
138470
|
|
|
138395
|
-
For more information, see `Using tables as visuals <https://docs.aws.amazon.com/quicksight/latest/user/tabular.html>`_ in the *Amazon
|
|
138471
|
+
For more information, see `Using tables as visuals <https://docs.aws.amazon.com/quicksight/latest/user/tabular.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
138396
138472
|
|
|
138397
138473
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
138398
138474
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -142487,7 +142563,7 @@ class CfnDashboard(
|
|
|
142487
142563
|
) -> None:
|
|
142488
142564
|
'''A tree map.
|
|
142489
142565
|
|
|
142490
|
-
For more information, see `Using tree maps <https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html>`_ in the *Amazon
|
|
142566
|
+
For more information, see `Using tree maps <https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
142491
142567
|
|
|
142492
142568
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
142493
142569
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -144128,31 +144204,31 @@ class CfnDashboard(
|
|
|
144128
144204
|
|
|
144129
144205
|
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
|
|
144130
144206
|
|
|
144131
|
-
:param bar_chart_visual: A bar chart. For more information, see `Using bar charts <https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html>`_ in the *Amazon
|
|
144132
|
-
:param box_plot_visual: A box plot. For more information, see `Using box plots <https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html>`_ in the *Amazon
|
|
144133
|
-
:param combo_chart_visual: A combo chart. For more information, see `Using combo charts <https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html>`_ in the *Amazon
|
|
144134
|
-
:param custom_content_visual: A visual that contains custom content. For more information, see `Using custom visual content <https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html>`_ in the *Amazon
|
|
144207
|
+
:param bar_chart_visual: A bar chart. For more information, see `Using bar charts <https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144208
|
+
:param box_plot_visual: A box plot. For more information, see `Using box plots <https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144209
|
+
:param combo_chart_visual: A combo chart. For more information, see `Using combo charts <https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144210
|
+
:param custom_content_visual: A visual that contains custom content. For more information, see `Using custom visual content <https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144135
144211
|
:param empty_visual: An empty visual.
|
|
144136
|
-
:param filled_map_visual: A filled map. For more information, see `Creating filled maps <https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html>`_ in the *Amazon
|
|
144137
|
-
:param funnel_chart_visual: A funnel chart. For more information, see `Using funnel charts <https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html>`_ in the *Amazon
|
|
144138
|
-
:param gauge_chart_visual: A gauge chart. For more information, see `Using gauge charts <https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html>`_ in the *Amazon
|
|
144139
|
-
:param geospatial_map_visual: A geospatial map or a points on map visual. For more information, see `Creating point maps <https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html>`_ in the *Amazon
|
|
144140
|
-
:param heat_map_visual: A heat map. For more information, see `Using heat maps <https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html>`_ in the *Amazon
|
|
144141
|
-
:param histogram_visual: A histogram. For more information, see `Using histograms <https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html>`_ in the *Amazon
|
|
144142
|
-
:param insight_visual: An insight visual. For more information, see `Working with insights <https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html>`_ in the *Amazon
|
|
144143
|
-
:param kpi_visual: A key performance indicator (KPI). For more information, see `Using KPIs <https://docs.aws.amazon.com/quicksight/latest/user/kpi.html>`_ in the *Amazon
|
|
144212
|
+
:param filled_map_visual: A filled map. For more information, see `Creating filled maps <https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144213
|
+
:param funnel_chart_visual: A funnel chart. For more information, see `Using funnel charts <https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144214
|
+
:param gauge_chart_visual: A gauge chart. For more information, see `Using gauge charts <https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144215
|
+
:param geospatial_map_visual: A geospatial map or a points on map visual. For more information, see `Creating point maps <https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144216
|
+
:param heat_map_visual: A heat map. For more information, see `Using heat maps <https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144217
|
+
:param histogram_visual: A histogram. For more information, see `Using histograms <https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144218
|
+
:param insight_visual: An insight visual. For more information, see `Working with insights <https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144219
|
+
:param kpi_visual: A key performance indicator (KPI). For more information, see `Using KPIs <https://docs.aws.amazon.com/quicksight/latest/user/kpi.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144144
144220
|
:param layer_map_visual: The properties for a layer map visual.
|
|
144145
|
-
:param line_chart_visual: A line chart. For more information, see `Using line charts <https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html>`_ in the *Amazon
|
|
144146
|
-
:param pie_chart_visual: A pie or donut chart. For more information, see `Using pie charts <https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html>`_ in the *Amazon
|
|
144147
|
-
:param pivot_table_visual: A pivot table. For more information, see `Using pivot tables <https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html>`_ in the *Amazon
|
|
144221
|
+
:param line_chart_visual: A line chart. For more information, see `Using line charts <https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144222
|
+
:param pie_chart_visual: A pie or donut chart. For more information, see `Using pie charts <https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144223
|
+
:param pivot_table_visual: A pivot table. For more information, see `Using pivot tables <https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144148
144224
|
:param plugin_visual: The custom plugin visual type.
|
|
144149
|
-
:param radar_chart_visual: A radar chart visual. For more information, see `Using radar charts <https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html>`_ in the *Amazon
|
|
144150
|
-
:param sankey_diagram_visual: A sankey diagram. For more information, see `Using Sankey diagrams <https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html>`_ in the *Amazon
|
|
144151
|
-
:param scatter_plot_visual: A scatter plot. For more information, see `Using scatter plots <https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html>`_ in the *Amazon
|
|
144152
|
-
:param table_visual: A table visual. For more information, see `Using tables as visuals <https://docs.aws.amazon.com/quicksight/latest/user/tabular.html>`_ in the *Amazon
|
|
144153
|
-
:param tree_map_visual: A tree map. For more information, see `Using tree maps <https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html>`_ in the *Amazon
|
|
144154
|
-
:param waterfall_visual: A waterfall chart. For more information, see `Using waterfall charts <https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html>`_ in the *Amazon
|
|
144155
|
-
:param word_cloud_visual: A word cloud. For more information, see `Using word clouds <https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html>`_ in the *Amazon
|
|
144225
|
+
:param radar_chart_visual: A radar chart visual. For more information, see `Using radar charts <https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144226
|
+
:param sankey_diagram_visual: A sankey diagram. For more information, see `Using Sankey diagrams <https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144227
|
+
:param scatter_plot_visual: A scatter plot. For more information, see `Using scatter plots <https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144228
|
+
:param table_visual: A table visual. For more information, see `Using tables as visuals <https://docs.aws.amazon.com/quicksight/latest/user/tabular.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144229
|
+
:param tree_map_visual: A tree map. For more information, see `Using tree maps <https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144230
|
+
:param waterfall_visual: A waterfall chart. For more information, see `Using waterfall charts <https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144231
|
+
:param word_cloud_visual: A word cloud. For more information, see `Using word clouds <https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144156
144232
|
|
|
144157
144233
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html
|
|
144158
144234
|
:exampleMetadata: fixture=_generated
|
|
@@ -144246,7 +144322,7 @@ class CfnDashboard(
|
|
|
144246
144322
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.BarChartVisualProperty"]]:
|
|
144247
144323
|
'''A bar chart.
|
|
144248
144324
|
|
|
144249
|
-
For more information, see `Using bar charts <https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html>`_ in the *Amazon
|
|
144325
|
+
For more information, see `Using bar charts <https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144250
144326
|
|
|
144251
144327
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-barchartvisual
|
|
144252
144328
|
'''
|
|
@@ -144259,7 +144335,7 @@ class CfnDashboard(
|
|
|
144259
144335
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.BoxPlotVisualProperty"]]:
|
|
144260
144336
|
'''A box plot.
|
|
144261
144337
|
|
|
144262
|
-
For more information, see `Using box plots <https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html>`_ in the *Amazon
|
|
144338
|
+
For more information, see `Using box plots <https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144263
144339
|
|
|
144264
144340
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-boxplotvisual
|
|
144265
144341
|
'''
|
|
@@ -144272,7 +144348,7 @@ class CfnDashboard(
|
|
|
144272
144348
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.ComboChartVisualProperty"]]:
|
|
144273
144349
|
'''A combo chart.
|
|
144274
144350
|
|
|
144275
|
-
For more information, see `Using combo charts <https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html>`_ in the *Amazon
|
|
144351
|
+
For more information, see `Using combo charts <https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144276
144352
|
|
|
144277
144353
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-combochartvisual
|
|
144278
144354
|
'''
|
|
@@ -144285,7 +144361,7 @@ class CfnDashboard(
|
|
|
144285
144361
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.CustomContentVisualProperty"]]:
|
|
144286
144362
|
'''A visual that contains custom content.
|
|
144287
144363
|
|
|
144288
|
-
For more information, see `Using custom visual content <https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html>`_ in the *Amazon
|
|
144364
|
+
For more information, see `Using custom visual content <https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144289
144365
|
|
|
144290
144366
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-customcontentvisual
|
|
144291
144367
|
'''
|
|
@@ -144309,7 +144385,7 @@ class CfnDashboard(
|
|
|
144309
144385
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.FilledMapVisualProperty"]]:
|
|
144310
144386
|
'''A filled map.
|
|
144311
144387
|
|
|
144312
|
-
For more information, see `Creating filled maps <https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html>`_ in the *Amazon
|
|
144388
|
+
For more information, see `Creating filled maps <https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144313
144389
|
|
|
144314
144390
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-filledmapvisual
|
|
144315
144391
|
'''
|
|
@@ -144322,7 +144398,7 @@ class CfnDashboard(
|
|
|
144322
144398
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.FunnelChartVisualProperty"]]:
|
|
144323
144399
|
'''A funnel chart.
|
|
144324
144400
|
|
|
144325
|
-
For more information, see `Using funnel charts <https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html>`_ in the *Amazon
|
|
144401
|
+
For more information, see `Using funnel charts <https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144326
144402
|
|
|
144327
144403
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-funnelchartvisual
|
|
144328
144404
|
'''
|
|
@@ -144335,7 +144411,7 @@ class CfnDashboard(
|
|
|
144335
144411
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.GaugeChartVisualProperty"]]:
|
|
144336
144412
|
'''A gauge chart.
|
|
144337
144413
|
|
|
144338
|
-
For more information, see `Using gauge charts <https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html>`_ in the *Amazon
|
|
144414
|
+
For more information, see `Using gauge charts <https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144339
144415
|
|
|
144340
144416
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-gaugechartvisual
|
|
144341
144417
|
'''
|
|
@@ -144348,7 +144424,7 @@ class CfnDashboard(
|
|
|
144348
144424
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.GeospatialMapVisualProperty"]]:
|
|
144349
144425
|
'''A geospatial map or a points on map visual.
|
|
144350
144426
|
|
|
144351
|
-
For more information, see `Creating point maps <https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html>`_ in the *Amazon
|
|
144427
|
+
For more information, see `Creating point maps <https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144352
144428
|
|
|
144353
144429
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-geospatialmapvisual
|
|
144354
144430
|
'''
|
|
@@ -144361,7 +144437,7 @@ class CfnDashboard(
|
|
|
144361
144437
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.HeatMapVisualProperty"]]:
|
|
144362
144438
|
'''A heat map.
|
|
144363
144439
|
|
|
144364
|
-
For more information, see `Using heat maps <https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html>`_ in the *Amazon
|
|
144440
|
+
For more information, see `Using heat maps <https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144365
144441
|
|
|
144366
144442
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-heatmapvisual
|
|
144367
144443
|
'''
|
|
@@ -144374,7 +144450,7 @@ class CfnDashboard(
|
|
|
144374
144450
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.HistogramVisualProperty"]]:
|
|
144375
144451
|
'''A histogram.
|
|
144376
144452
|
|
|
144377
|
-
For more information, see `Using histograms <https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html>`_ in the *Amazon
|
|
144453
|
+
For more information, see `Using histograms <https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144378
144454
|
|
|
144379
144455
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-histogramvisual
|
|
144380
144456
|
'''
|
|
@@ -144387,7 +144463,7 @@ class CfnDashboard(
|
|
|
144387
144463
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.InsightVisualProperty"]]:
|
|
144388
144464
|
'''An insight visual.
|
|
144389
144465
|
|
|
144390
|
-
For more information, see `Working with insights <https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html>`_ in the *Amazon
|
|
144466
|
+
For more information, see `Working with insights <https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144391
144467
|
|
|
144392
144468
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-insightvisual
|
|
144393
144469
|
'''
|
|
@@ -144400,7 +144476,7 @@ class CfnDashboard(
|
|
|
144400
144476
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.KPIVisualProperty"]]:
|
|
144401
144477
|
'''A key performance indicator (KPI).
|
|
144402
144478
|
|
|
144403
|
-
For more information, see `Using KPIs <https://docs.aws.amazon.com/quicksight/latest/user/kpi.html>`_ in the *Amazon
|
|
144479
|
+
For more information, see `Using KPIs <https://docs.aws.amazon.com/quicksight/latest/user/kpi.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144404
144480
|
|
|
144405
144481
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-kpivisual
|
|
144406
144482
|
'''
|
|
@@ -144424,7 +144500,7 @@ class CfnDashboard(
|
|
|
144424
144500
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.LineChartVisualProperty"]]:
|
|
144425
144501
|
'''A line chart.
|
|
144426
144502
|
|
|
144427
|
-
For more information, see `Using line charts <https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html>`_ in the *Amazon
|
|
144503
|
+
For more information, see `Using line charts <https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144428
144504
|
|
|
144429
144505
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-linechartvisual
|
|
144430
144506
|
'''
|
|
@@ -144437,7 +144513,7 @@ class CfnDashboard(
|
|
|
144437
144513
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.PieChartVisualProperty"]]:
|
|
144438
144514
|
'''A pie or donut chart.
|
|
144439
144515
|
|
|
144440
|
-
For more information, see `Using pie charts <https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html>`_ in the *Amazon
|
|
144516
|
+
For more information, see `Using pie charts <https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144441
144517
|
|
|
144442
144518
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-piechartvisual
|
|
144443
144519
|
'''
|
|
@@ -144450,7 +144526,7 @@ class CfnDashboard(
|
|
|
144450
144526
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.PivotTableVisualProperty"]]:
|
|
144451
144527
|
'''A pivot table.
|
|
144452
144528
|
|
|
144453
|
-
For more information, see `Using pivot tables <https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html>`_ in the *Amazon
|
|
144529
|
+
For more information, see `Using pivot tables <https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144454
144530
|
|
|
144455
144531
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-pivottablevisual
|
|
144456
144532
|
'''
|
|
@@ -144474,7 +144550,7 @@ class CfnDashboard(
|
|
|
144474
144550
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.RadarChartVisualProperty"]]:
|
|
144475
144551
|
'''A radar chart visual.
|
|
144476
144552
|
|
|
144477
|
-
For more information, see `Using radar charts <https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html>`_ in the *Amazon
|
|
144553
|
+
For more information, see `Using radar charts <https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144478
144554
|
|
|
144479
144555
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-radarchartvisual
|
|
144480
144556
|
'''
|
|
@@ -144487,7 +144563,7 @@ class CfnDashboard(
|
|
|
144487
144563
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.SankeyDiagramVisualProperty"]]:
|
|
144488
144564
|
'''A sankey diagram.
|
|
144489
144565
|
|
|
144490
|
-
For more information, see `Using Sankey diagrams <https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html>`_ in the *Amazon
|
|
144566
|
+
For more information, see `Using Sankey diagrams <https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144491
144567
|
|
|
144492
144568
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-sankeydiagramvisual
|
|
144493
144569
|
'''
|
|
@@ -144500,7 +144576,7 @@ class CfnDashboard(
|
|
|
144500
144576
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.ScatterPlotVisualProperty"]]:
|
|
144501
144577
|
'''A scatter plot.
|
|
144502
144578
|
|
|
144503
|
-
For more information, see `Using scatter plots <https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html>`_ in the *Amazon
|
|
144579
|
+
For more information, see `Using scatter plots <https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144504
144580
|
|
|
144505
144581
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-scatterplotvisual
|
|
144506
144582
|
'''
|
|
@@ -144513,7 +144589,7 @@ class CfnDashboard(
|
|
|
144513
144589
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.TableVisualProperty"]]:
|
|
144514
144590
|
'''A table visual.
|
|
144515
144591
|
|
|
144516
|
-
For more information, see `Using tables as visuals <https://docs.aws.amazon.com/quicksight/latest/user/tabular.html>`_ in the *Amazon
|
|
144592
|
+
For more information, see `Using tables as visuals <https://docs.aws.amazon.com/quicksight/latest/user/tabular.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144517
144593
|
|
|
144518
144594
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-tablevisual
|
|
144519
144595
|
'''
|
|
@@ -144526,7 +144602,7 @@ class CfnDashboard(
|
|
|
144526
144602
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.TreeMapVisualProperty"]]:
|
|
144527
144603
|
'''A tree map.
|
|
144528
144604
|
|
|
144529
|
-
For more information, see `Using tree maps <https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html>`_ in the *Amazon
|
|
144605
|
+
For more information, see `Using tree maps <https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144530
144606
|
|
|
144531
144607
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-treemapvisual
|
|
144532
144608
|
'''
|
|
@@ -144539,7 +144615,7 @@ class CfnDashboard(
|
|
|
144539
144615
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.WaterfallVisualProperty"]]:
|
|
144540
144616
|
'''A waterfall chart.
|
|
144541
144617
|
|
|
144542
|
-
For more information, see `Using waterfall charts <https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html>`_ in the *Amazon
|
|
144618
|
+
For more information, see `Using waterfall charts <https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144543
144619
|
|
|
144544
144620
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-waterfallvisual
|
|
144545
144621
|
'''
|
|
@@ -144552,7 +144628,7 @@ class CfnDashboard(
|
|
|
144552
144628
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDashboard.WordCloudVisualProperty"]]:
|
|
144553
144629
|
'''A word cloud.
|
|
144554
144630
|
|
|
144555
|
-
For more information, see `Using word clouds <https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html>`_ in the *Amazon
|
|
144631
|
+
For more information, see `Using word clouds <https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
144556
144632
|
|
|
144557
144633
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-visual.html#cfn-quicksight-dashboard-visual-wordcloudvisual
|
|
144558
144634
|
'''
|
|
@@ -145440,7 +145516,7 @@ class CfnDashboard(
|
|
|
145440
145516
|
) -> None:
|
|
145441
145517
|
'''A waterfall chart.
|
|
145442
145518
|
|
|
145443
|
-
For more information, see `Using waterfall charts <https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html>`_ in the *Amazon
|
|
145519
|
+
For more information, see `Using waterfall charts <https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
145444
145520
|
|
|
145445
145521
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
145446
145522
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -146248,7 +146324,7 @@ class CfnDashboard(
|
|
|
146248
146324
|
) -> None:
|
|
146249
146325
|
'''A word cloud.
|
|
146250
146326
|
|
|
146251
|
-
For more information, see `Using word clouds <https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html>`_ in the *Amazon
|
|
146327
|
+
For more information, see `Using word clouds <https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
146252
146328
|
|
|
146253
146329
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
146254
146330
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -146745,7 +146821,7 @@ class CfnDataSet(
|
|
|
146745
146821
|
:param scope: Scope in which this resource is defined.
|
|
146746
146822
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
146747
146823
|
:param aws_account_id: The AWS account ID.
|
|
146748
|
-
:param column_groups: Groupings of columns that work together in certain Amazon
|
|
146824
|
+
:param column_groups: Groupings of columns that work together in certain Amazon Quick Sight features. Currently, only geospatial hierarchy is supported.
|
|
146749
146825
|
:param column_level_permission_rules: A set of one or more definitions of a ``ColumnLevelPermissionRule`` .
|
|
146750
146826
|
:param data_set_id: An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
|
|
146751
146827
|
:param dataset_parameters: The parameters that are declared in a dataset.
|
|
@@ -146908,7 +146984,7 @@ class CfnDataSet(
|
|
|
146908
146984
|
def column_groups(
|
|
146909
146985
|
self,
|
|
146910
146986
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnDataSet.ColumnGroupProperty"]]]]:
|
|
146911
|
-
'''Groupings of columns that work together in certain Amazon
|
|
146987
|
+
'''Groupings of columns that work together in certain Amazon Quick Sight features.'''
|
|
146912
146988
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnDataSet.ColumnGroupProperty"]]]], jsii.get(self, "columnGroups"))
|
|
146913
146989
|
|
|
146914
146990
|
@column_groups.setter
|
|
@@ -147233,7 +147309,7 @@ class CfnDataSet(
|
|
|
147233
147309
|
) -> None:
|
|
147234
147310
|
'''A calculated column for a dataset.
|
|
147235
147311
|
|
|
147236
|
-
:param column_id: A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column,
|
|
147312
|
+
:param column_id: A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Quick Sight preserves the existing calculated column.
|
|
147237
147313
|
:param column_name: Column name.
|
|
147238
147314
|
:param expression: An expression that defines the calculated column.
|
|
147239
147315
|
|
|
@@ -147267,7 +147343,7 @@ class CfnDataSet(
|
|
|
147267
147343
|
def column_id(self) -> builtins.str:
|
|
147268
147344
|
'''A unique ID to identify a calculated column.
|
|
147269
147345
|
|
|
147270
|
-
During a dataset update, if the column ID of a calculated column matches that of an existing calculated column,
|
|
147346
|
+
During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Quick Sight preserves the existing calculated column.
|
|
147271
147347
|
|
|
147272
147348
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-calculatedcolumn.html#cfn-quicksight-dataset-calculatedcolumn-columnid
|
|
147273
147349
|
'''
|
|
@@ -147329,7 +147405,7 @@ class CfnDataSet(
|
|
|
147329
147405
|
|
|
147330
147406
|
:param new_column_type: New column data type.
|
|
147331
147407
|
:param column_name: Column name.
|
|
147332
|
-
:param format: When casting a column from string to datetime type, you can supply a string in a format supported by
|
|
147408
|
+
:param format: When casting a column from string to datetime type, you can supply a string in a format supported by Quick Sight to denote the source data format.
|
|
147333
147409
|
:param sub_type: The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.
|
|
147334
147410
|
|
|
147335
147411
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-castcolumntypeoperation.html
|
|
@@ -147387,7 +147463,7 @@ class CfnDataSet(
|
|
|
147387
147463
|
|
|
147388
147464
|
@builtins.property
|
|
147389
147465
|
def format(self) -> typing.Optional[builtins.str]:
|
|
147390
|
-
'''When casting a column from string to datetime type, you can supply a string in a format supported by
|
|
147466
|
+
'''When casting a column from string to datetime type, you can supply a string in a format supported by Quick Sight to denote the source data format.
|
|
147391
147467
|
|
|
147392
147468
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-castcolumntypeoperation.html#cfn-quicksight-dataset-castcolumntypeoperation-format
|
|
147393
147469
|
'''
|
|
@@ -147478,7 +147554,7 @@ class CfnDataSet(
|
|
|
147478
147554
|
*,
|
|
147479
147555
|
geo_spatial_column_group: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDataSet.GeoSpatialColumnGroupProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
147480
147556
|
) -> None:
|
|
147481
|
-
'''Groupings of columns that work together in certain
|
|
147557
|
+
'''Groupings of columns that work together in certain Quick Sight features.
|
|
147482
147558
|
|
|
147483
147559
|
This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
|
|
147484
147560
|
|
|
@@ -147549,7 +147625,7 @@ class CfnDataSet(
|
|
|
147549
147625
|
Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.
|
|
147550
147626
|
|
|
147551
147627
|
:param column_names: An array of column names.
|
|
147552
|
-
:param principals: An array of Amazon Resource Names (ARNs) for
|
|
147628
|
+
:param principals: An array of Amazon Resource Names (ARNs) for Quick Suite users or groups.
|
|
147553
147629
|
|
|
147554
147630
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columnlevelpermissionrule.html
|
|
147555
147631
|
:exampleMetadata: fixture=_generated
|
|
@@ -147586,7 +147662,7 @@ class CfnDataSet(
|
|
|
147586
147662
|
|
|
147587
147663
|
@builtins.property
|
|
147588
147664
|
def principals(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
147589
|
-
'''An array of Amazon Resource Names (ARNs) for
|
|
147665
|
+
'''An array of Amazon Resource Names (ARNs) for Quick Suite users or groups.
|
|
147590
147666
|
|
|
147591
147667
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columnlevelpermissionrule.html#cfn-quicksight-dataset-columnlevelpermissionrule-principals
|
|
147592
147668
|
'''
|
|
@@ -147967,7 +148043,7 @@ class CfnDataSet(
|
|
|
147967
148043
|
'''The usage configuration to apply to child datasets that reference this dataset as a source.
|
|
147968
148044
|
|
|
147969
148045
|
:param disable_use_as_direct_query_source: An option that controls whether a child dataset of a direct query can use this dataset as a source. Default: - false
|
|
147970
|
-
:param disable_use_as_imported_source: An option that controls whether a child dataset that's stored in
|
|
148046
|
+
:param disable_use_as_imported_source: An option that controls whether a child dataset that's stored in Quick Sight can use this dataset as a source. Default: - false
|
|
147971
148047
|
|
|
147972
148048
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetusageconfiguration.html
|
|
147973
148049
|
:exampleMetadata: fixture=_generated
|
|
@@ -148010,7 +148086,7 @@ class CfnDataSet(
|
|
|
148010
148086
|
def disable_use_as_imported_source(
|
|
148011
148087
|
self,
|
|
148012
148088
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
148013
|
-
'''An option that controls whether a child dataset that's stored in
|
|
148089
|
+
'''An option that controls whether a child dataset that's stored in Quick Sight can use this dataset as a source.
|
|
148014
148090
|
|
|
148015
148091
|
:default: - false
|
|
148016
148092
|
|
|
@@ -149337,7 +149413,7 @@ class CfnDataSet(
|
|
|
149337
149413
|
) -> None:
|
|
149338
149414
|
'''Properties associated with the columns participating in a join.
|
|
149339
149415
|
|
|
149340
|
-
:param unique_key: A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by
|
|
149416
|
+
:param unique_key: A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Quick Suite to optimize query performance.
|
|
149341
149417
|
|
|
149342
149418
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinkeyproperties.html
|
|
149343
149419
|
:exampleMetadata: fixture=_generated
|
|
@@ -149365,7 +149441,7 @@ class CfnDataSet(
|
|
|
149365
149441
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
149366
149442
|
'''A value that indicates that a row in a table is uniquely identified by the columns in a join key.
|
|
149367
149443
|
|
|
149368
|
-
This is used by
|
|
149444
|
+
This is used by Quick Suite to optimize query performance.
|
|
149369
149445
|
|
|
149370
149446
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinkeyproperties.html#cfn-quicksight-dataset-joinkeyproperties-uniquekey
|
|
149371
149447
|
'''
|
|
@@ -150719,7 +150795,7 @@ class CfnDataSet(
|
|
|
150719
150795
|
'''Permission for the resource.
|
|
150720
150796
|
|
|
150721
150797
|
:param actions: The IAM action to grant or revoke permisions on.
|
|
150722
|
-
:param principal: The Amazon Resource Name (ARN) of the principal. This can be one of the following:. - The ARN of an Amazon
|
|
150798
|
+
:param principal: The Amazon Resource Name (ARN) of the principal. This can be one of the following:. - The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is common.) - The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) - The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
|
|
150723
150799
|
|
|
150724
150800
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-resourcepermission.html
|
|
150725
150801
|
:exampleMetadata: fixture=_generated
|
|
@@ -150758,9 +150834,9 @@ class CfnDataSet(
|
|
|
150758
150834
|
def principal(self) -> builtins.str:
|
|
150759
150835
|
'''The Amazon Resource Name (ARN) of the principal. This can be one of the following:.
|
|
150760
150836
|
|
|
150761
|
-
- The ARN of an Amazon
|
|
150762
|
-
- The ARN of an Amazon
|
|
150763
|
-
- The ARN of an AWS account root: This is an IAM ARN rather than a
|
|
150837
|
+
- The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is common.)
|
|
150838
|
+
- The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
|
|
150839
|
+
- The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
|
|
150764
150840
|
|
|
150765
150841
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-resourcepermission.html#cfn-quicksight-dataset-resourcepermission-principal
|
|
150766
150842
|
'''
|
|
@@ -150802,7 +150878,7 @@ class CfnDataSet(
|
|
|
150802
150878
|
) -> None:
|
|
150803
150879
|
'''Information about a dataset that contains permissions for row-level security (RLS).
|
|
150804
150880
|
|
|
150805
|
-
The permissions dataset maps fields to users or groups. For more information, see `Using Row-Level Security (RLS) to Restrict Access to a Dataset <https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html>`_ in the *
|
|
150881
|
+
The permissions dataset maps fields to users or groups. For more information, see `Using Row-Level Security (RLS) to Restrict Access to a Dataset <https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html>`_ in the *Quick Sight User Guide* .
|
|
150806
150882
|
|
|
150807
150883
|
The option to deny permissions by setting ``PermissionPolicy`` to ``DENY_ACCESS`` is not supported for new RLS datasets.
|
|
150808
150884
|
|
|
@@ -152505,15 +152581,15 @@ class CfnDataSource(
|
|
|
152505
152581
|
:param type: The type of the data source. To return a list of all data sources, use ``ListDataSources`` . Use ``AMAZON_ELASTICSEARCH`` for Amazon OpenSearch Service.
|
|
152506
152582
|
:param alternate_data_source_parameters: A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the ``DataSourceParameters`` structure that's in the request with the structures in the ``AlternateDataSourceParameters`` allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the ``AlternateDataSourceParameters`` list is null, the ``Credentials`` originally used with this ``DataSourceParameters`` are automatically allowed.
|
|
152507
152583
|
:param aws_account_id: The AWS account ID.
|
|
152508
|
-
:param credentials: The credentials Amazon
|
|
152584
|
+
:param credentials: The credentials Amazon Quick Sight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
|
|
152509
152585
|
:param data_source_id: An ID for the data source. This ID is unique per AWS Region for each AWS account.
|
|
152510
|
-
:param data_source_parameters: The parameters that Amazon
|
|
152586
|
+
:param data_source_parameters: The parameters that Amazon Quick Sight uses to connect to your underlying source.
|
|
152511
152587
|
:param error_info: Error information from the last update or the creation of the data source.
|
|
152512
152588
|
:param folder_arns:
|
|
152513
152589
|
:param permissions: A list of resource permissions on the data source.
|
|
152514
|
-
:param ssl_properties: Secure Socket Layer (SSL) properties that apply when Amazon
|
|
152590
|
+
:param ssl_properties: Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.
|
|
152515
152591
|
:param tags: Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
|
|
152516
|
-
:param vpc_connection_properties: Use this parameter only when you want Amazon
|
|
152592
|
+
:param vpc_connection_properties: Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.
|
|
152517
152593
|
'''
|
|
152518
152594
|
if __debug__:
|
|
152519
152595
|
type_hints = typing.get_type_hints(_typecheckingstub__374b42679a82ae47079989dc56d79f0d0b7c439a3c9f7e6d2725ab4c7c4ad6fd)
|
|
@@ -152685,7 +152761,7 @@ class CfnDataSource(
|
|
|
152685
152761
|
def credentials(
|
|
152686
152762
|
self,
|
|
152687
152763
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.DataSourceCredentialsProperty"]]:
|
|
152688
|
-
'''The credentials Amazon
|
|
152764
|
+
'''The credentials Amazon Quick Sight that uses to connect to your underlying source.'''
|
|
152689
152765
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.DataSourceCredentialsProperty"]], jsii.get(self, "credentials"))
|
|
152690
152766
|
|
|
152691
152767
|
@credentials.setter
|
|
@@ -152716,7 +152792,7 @@ class CfnDataSource(
|
|
|
152716
152792
|
def data_source_parameters(
|
|
152717
152793
|
self,
|
|
152718
152794
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.DataSourceParametersProperty"]]:
|
|
152719
|
-
'''The parameters that Amazon
|
|
152795
|
+
'''The parameters that Amazon Quick Sight uses to connect to your underlying source.'''
|
|
152720
152796
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.DataSourceParametersProperty"]], jsii.get(self, "dataSourceParameters"))
|
|
152721
152797
|
|
|
152722
152798
|
@data_source_parameters.setter
|
|
@@ -152782,7 +152858,7 @@ class CfnDataSource(
|
|
|
152782
152858
|
def ssl_properties(
|
|
152783
152859
|
self,
|
|
152784
152860
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.SslPropertiesProperty"]]:
|
|
152785
|
-
'''Secure Socket Layer (SSL) properties that apply when Amazon
|
|
152861
|
+
'''Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.'''
|
|
152786
152862
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.SslPropertiesProperty"]], jsii.get(self, "sslProperties"))
|
|
152787
152863
|
|
|
152788
152864
|
@ssl_properties.setter
|
|
@@ -152813,7 +152889,7 @@ class CfnDataSource(
|
|
|
152813
152889
|
def vpc_connection_properties(
|
|
152814
152890
|
self,
|
|
152815
152891
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.VpcConnectionPropertiesProperty"]]:
|
|
152816
|
-
'''Use this parameter only when you want Amazon
|
|
152892
|
+
'''Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.'''
|
|
152817
152893
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.VpcConnectionPropertiesProperty"]], jsii.get(self, "vpcConnectionProperties"))
|
|
152818
152894
|
|
|
152819
152895
|
@vpc_connection_properties.setter
|
|
@@ -152949,7 +153025,7 @@ class CfnDataSource(
|
|
|
152949
153025
|
) -> None:
|
|
152950
153026
|
'''Parameters for Amazon Athena.
|
|
152951
153027
|
|
|
152952
|
-
:param identity_center_configuration: An optional parameter that configures IAM Identity Center authentication to grant
|
|
153028
|
+
:param identity_center_configuration: An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup. This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
|
|
152953
153029
|
:param role_arn: Use the ``RoleArn`` structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use ``RoleArn`` to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
|
|
152954
153030
|
:param work_group: The workgroup that Amazon Athena uses.
|
|
152955
153031
|
|
|
@@ -152987,9 +153063,9 @@ class CfnDataSource(
|
|
|
152987
153063
|
def identity_center_configuration(
|
|
152988
153064
|
self,
|
|
152989
153065
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.IdentityCenterConfigurationProperty"]]:
|
|
152990
|
-
'''An optional parameter that configures IAM Identity Center authentication to grant
|
|
153066
|
+
'''An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
|
|
152991
153067
|
|
|
152992
|
-
This parameter can only be specified if your
|
|
153068
|
+
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
|
|
152993
153069
|
|
|
152994
153070
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-athenaparameters.html#cfn-quicksight-datasource-athenaparameters-identitycenterconfiguration
|
|
152995
153071
|
'''
|
|
@@ -153817,7 +153893,7 @@ class CfnDataSource(
|
|
|
153817
153893
|
teradata_parameters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDataSource.TeradataParametersProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
153818
153894
|
trino_parameters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDataSource.TrinoParametersProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
153819
153895
|
) -> None:
|
|
153820
|
-
'''The parameters that
|
|
153896
|
+
'''The parameters that Quick Sight uses to connect to your underlying data source.
|
|
153821
153897
|
|
|
153822
153898
|
This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
|
|
153823
153899
|
|
|
@@ -155181,14 +155257,14 @@ class CfnDataSource(
|
|
|
155181
155257
|
database_groups: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
155182
155258
|
database_user: typing.Optional[builtins.str] = None,
|
|
155183
155259
|
) -> None:
|
|
155184
|
-
'''A structure that grants
|
|
155260
|
+
'''A structure that grants Quick Sight access to your cluster and make a call to the ``redshift:GetClusterCredentials`` API.
|
|
155185
155261
|
|
|
155186
155262
|
For more information on the ``redshift:GetClusterCredentials`` API, see ```GetClusterCredentials`` <https://docs.aws.amazon.com/redshift/latest/APIReference/API_GetClusterCredentials.html>`_ .
|
|
155187
155263
|
|
|
155188
|
-
:param role_arn: Use the ``RoleArn`` structure to allow
|
|
155189
|
-
:param auto_create_database_user: Automatically creates a database user. If your database doesn't have a ``DatabaseUser`` , set this parameter to ``True`` . If there is no ``DatabaseUser`` ,
|
|
155190
|
-
:param database_groups: A list of groups whose permissions will be granted to
|
|
155191
|
-
:param database_user: The user whose permissions and group memberships will be used by
|
|
155264
|
+
:param role_arn: Use the ``RoleArn`` structure to allow Quick Sight to call ``redshift:GetClusterCredentials`` on your cluster. The calling principal must have ``iam:PassRole`` access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
|
|
155265
|
+
:param auto_create_database_user: Automatically creates a database user. If your database doesn't have a ``DatabaseUser`` , set this parameter to ``True`` . If there is no ``DatabaseUser`` , Quick Sight can't connect to your cluster. The ``RoleArn`` that you use for this operation must grant access to ``redshift:CreateClusterUser`` to successfully create the user. Default: - false
|
|
155266
|
+
:param database_groups: A list of groups whose permissions will be granted to Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight by the ``DatabaseUser`` . If you choose to include this parameter, the ``RoleArn`` must grant access to ``redshift:JoinGroup`` .
|
|
155267
|
+
:param database_user: The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight is granted the same permissions that the user has. If the user doesn't exist, set the value of ``AutoCreateDatabaseUser`` to ``True`` to create a new user with PUBLIC permissions.
|
|
155192
155268
|
|
|
155193
155269
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html
|
|
155194
155270
|
:exampleMetadata: fixture=_generated
|
|
@@ -155226,9 +155302,9 @@ class CfnDataSource(
|
|
|
155226
155302
|
|
|
155227
155303
|
@builtins.property
|
|
155228
155304
|
def role_arn(self) -> builtins.str:
|
|
155229
|
-
'''Use the ``RoleArn`` structure to allow
|
|
155305
|
+
'''Use the ``RoleArn`` structure to allow Quick Sight to call ``redshift:GetClusterCredentials`` on your cluster.
|
|
155230
155306
|
|
|
155231
|
-
The calling principal must have ``iam:PassRole`` access to pass the role to
|
|
155307
|
+
The calling principal must have ``iam:PassRole`` access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
|
|
155232
155308
|
|
|
155233
155309
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html#cfn-quicksight-datasource-redshiftiamparameters-rolearn
|
|
155234
155310
|
'''
|
|
@@ -155242,7 +155318,7 @@ class CfnDataSource(
|
|
|
155242
155318
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
155243
155319
|
'''Automatically creates a database user.
|
|
155244
155320
|
|
|
155245
|
-
If your database doesn't have a ``DatabaseUser`` , set this parameter to ``True`` . If there is no ``DatabaseUser`` ,
|
|
155321
|
+
If your database doesn't have a ``DatabaseUser`` , set this parameter to ``True`` . If there is no ``DatabaseUser`` , Quick Sight can't connect to your cluster. The ``RoleArn`` that you use for this operation must grant access to ``redshift:CreateClusterUser`` to successfully create the user.
|
|
155246
155322
|
|
|
155247
155323
|
:default: - false
|
|
155248
155324
|
|
|
@@ -155253,9 +155329,9 @@ class CfnDataSource(
|
|
|
155253
155329
|
|
|
155254
155330
|
@builtins.property
|
|
155255
155331
|
def database_groups(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
155256
|
-
'''A list of groups whose permissions will be granted to
|
|
155332
|
+
'''A list of groups whose permissions will be granted to Quick Sight to access the cluster.
|
|
155257
155333
|
|
|
155258
|
-
These permissions are combined with the permissions granted to
|
|
155334
|
+
These permissions are combined with the permissions granted to Quick Sight by the ``DatabaseUser`` . If you choose to include this parameter, the ``RoleArn`` must grant access to ``redshift:JoinGroup`` .
|
|
155259
155335
|
|
|
155260
155336
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html#cfn-quicksight-datasource-redshiftiamparameters-databasegroups
|
|
155261
155337
|
'''
|
|
@@ -155264,9 +155340,9 @@ class CfnDataSource(
|
|
|
155264
155340
|
|
|
155265
155341
|
@builtins.property
|
|
155266
155342
|
def database_user(self) -> typing.Optional[builtins.str]:
|
|
155267
|
-
'''The user whose permissions and group memberships will be used by
|
|
155343
|
+
'''The user whose permissions and group memberships will be used by Quick Sight to access the cluster.
|
|
155268
155344
|
|
|
155269
|
-
If this user already exists in your database, Amazon
|
|
155345
|
+
If this user already exists in your database, Amazon Quick Sight is granted the same permissions that the user has. If the user doesn't exist, set the value of ``AutoCreateDatabaseUser`` to ``True`` to create a new user with PUBLIC permissions.
|
|
155270
155346
|
|
|
155271
155347
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftiamparameters.html#cfn-quicksight-datasource-redshiftiamparameters-databaseuser
|
|
155272
155348
|
'''
|
|
@@ -155314,8 +155390,8 @@ class CfnDataSource(
|
|
|
155314
155390
|
:param database: Database.
|
|
155315
155391
|
:param cluster_id: Cluster ID. This field can be blank if the ``Host`` and ``Port`` are provided.
|
|
155316
155392
|
:param host: Host. This field can be blank if ``ClusterId`` is provided.
|
|
155317
|
-
:param iam_parameters: An optional parameter that uses IAM authentication to grant
|
|
155318
|
-
:param identity_center_configuration: An optional parameter that configures IAM Identity Center authentication to grant
|
|
155393
|
+
:param iam_parameters: An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of `DataSourceCredentials <https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DataSourceCredentials.html>`_ .
|
|
155394
|
+
:param identity_center_configuration: An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster. This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
|
|
155319
155395
|
:param port: Port. This field can be blank if the ``ClusterId`` is provided. Default: - 0
|
|
155320
155396
|
|
|
155321
155397
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html
|
|
@@ -155405,7 +155481,7 @@ class CfnDataSource(
|
|
|
155405
155481
|
def iam_parameters(
|
|
155406
155482
|
self,
|
|
155407
155483
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.RedshiftIAMParametersProperty"]]:
|
|
155408
|
-
'''An optional parameter that uses IAM authentication to grant
|
|
155484
|
+
'''An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster.
|
|
155409
155485
|
|
|
155410
155486
|
This parameter can be used instead of `DataSourceCredentials <https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DataSourceCredentials.html>`_ .
|
|
155411
155487
|
|
|
@@ -155418,9 +155494,9 @@ class CfnDataSource(
|
|
|
155418
155494
|
def identity_center_configuration(
|
|
155419
155495
|
self,
|
|
155420
155496
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.IdentityCenterConfigurationProperty"]]:
|
|
155421
|
-
'''An optional parameter that configures IAM Identity Center authentication to grant
|
|
155497
|
+
'''An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
|
|
155422
155498
|
|
|
155423
|
-
This parameter can only be specified if your
|
|
155499
|
+
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
|
|
155424
155500
|
|
|
155425
155501
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-redshiftparameters.html#cfn-quicksight-datasource-redshiftparameters-identitycenterconfiguration
|
|
155426
155502
|
'''
|
|
@@ -155471,7 +155547,7 @@ class CfnDataSource(
|
|
|
155471
155547
|
'''Permission for the resource.
|
|
155472
155548
|
|
|
155473
155549
|
:param actions: The IAM action to grant or revoke permissions on.
|
|
155474
|
-
:param principal: The Amazon Resource Name (ARN) of the principal. This can be one of the following:. - The ARN of an Amazon
|
|
155550
|
+
:param principal: The Amazon Resource Name (ARN) of the principal. This can be one of the following:. - The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is common.) - The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) - The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
|
|
155475
155551
|
:param resource:
|
|
155476
155552
|
|
|
155477
155553
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-resourcepermission.html
|
|
@@ -155517,9 +155593,9 @@ class CfnDataSource(
|
|
|
155517
155593
|
def principal(self) -> builtins.str:
|
|
155518
155594
|
'''The Amazon Resource Name (ARN) of the principal. This can be one of the following:.
|
|
155519
155595
|
|
|
155520
|
-
- The ARN of an Amazon
|
|
155521
|
-
- The ARN of an Amazon
|
|
155522
|
-
- The ARN of an AWS account root: This is an IAM ARN rather than a
|
|
155596
|
+
- The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is common.)
|
|
155597
|
+
- The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
|
|
155598
|
+
- The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
|
|
155523
155599
|
|
|
155524
155600
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-resourcepermission.html#cfn-quicksight-datasource-resourcepermission-principal
|
|
155525
155601
|
'''
|
|
@@ -155563,7 +155639,7 @@ class CfnDataSource(
|
|
|
155563
155639
|
) -> None:
|
|
155564
155640
|
'''The parameters for S3.
|
|
155565
155641
|
|
|
155566
|
-
:param manifest_file_location: Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into
|
|
155642
|
+
:param manifest_file_location: Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Quick Sight.
|
|
155567
155643
|
:param role_arn: Use the ``RoleArn`` structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use ``RoleArn`` to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
|
|
155568
155644
|
|
|
155569
155645
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-s3parameters.html
|
|
@@ -155601,7 +155677,7 @@ class CfnDataSource(
|
|
|
155601
155677
|
) -> typing.Union[_IResolvable_da3f097b, "CfnDataSource.ManifestFileLocationProperty"]:
|
|
155602
155678
|
'''Location of the Amazon S3 manifest file.
|
|
155603
155679
|
|
|
155604
|
-
This is NULL if the manifest file was uploaded into
|
|
155680
|
+
This is NULL if the manifest file was uploaded into Quick Sight.
|
|
155605
155681
|
|
|
155606
155682
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-s3parameters.html#cfn-quicksight-datasource-s3parameters-manifestfilelocation
|
|
155607
155683
|
'''
|
|
@@ -155661,7 +155737,7 @@ class CfnDataSource(
|
|
|
155661
155737
|
:param warehouse: Warehouse.
|
|
155662
155738
|
:param authentication_type: The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
|
|
155663
155739
|
:param database_access_control_role: The database access control role.
|
|
155664
|
-
:param o_auth_parameters: An object that contains information needed to create a data source connection between an
|
|
155740
|
+
:param o_auth_parameters: An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
|
|
155665
155741
|
|
|
155666
155742
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-snowflakeparameters.html
|
|
155667
155743
|
:exampleMetadata: fixture=_generated
|
|
@@ -155766,7 +155842,7 @@ class CfnDataSource(
|
|
|
155766
155842
|
def o_auth_parameters(
|
|
155767
155843
|
self,
|
|
155768
155844
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.OAuthParametersProperty"]]:
|
|
155769
|
-
'''An object that contains information needed to create a data source connection between an
|
|
155845
|
+
'''An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
|
|
155770
155846
|
|
|
155771
155847
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-snowflakeparameters.html#cfn-quicksight-datasource-snowflakeparameters-oauthparameters
|
|
155772
155848
|
'''
|
|
@@ -155951,7 +156027,7 @@ class CfnDataSource(
|
|
|
155951
156027
|
*,
|
|
155952
156028
|
disable_ssl: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
155953
156029
|
) -> None:
|
|
155954
|
-
'''Secure Socket Layer (SSL) properties that apply when
|
|
156030
|
+
'''Secure Socket Layer (SSL) properties that apply when Quick Sight connects to your underlying data source.
|
|
155955
156031
|
|
|
155956
156032
|
:param disable_ssl: A Boolean option to control whether SSL should be disabled. Default: - false
|
|
155957
156033
|
|
|
@@ -156031,7 +156107,7 @@ class CfnDataSource(
|
|
|
156031
156107
|
:param port: The port for the Starburst data source. Default: - 0
|
|
156032
156108
|
:param authentication_type: The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
|
|
156033
156109
|
:param database_access_control_role: The database access control role.
|
|
156034
|
-
:param o_auth_parameters: An object that contains information needed to create a data source connection between an
|
|
156110
|
+
:param o_auth_parameters: An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
|
|
156035
156111
|
:param product_type: The product type for the Starburst data source.
|
|
156036
156112
|
|
|
156037
156113
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-starburstparameters.html
|
|
@@ -156143,7 +156219,7 @@ class CfnDataSource(
|
|
|
156143
156219
|
def o_auth_parameters(
|
|
156144
156220
|
self,
|
|
156145
156221
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.OAuthParametersProperty"]]:
|
|
156146
|
-
'''An object that contains information needed to create a data source connection between an
|
|
156222
|
+
'''An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
|
|
156147
156223
|
|
|
156148
156224
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-starburstparameters.html#cfn-quicksight-datasource-starburstparameters-oauthparameters
|
|
156149
156225
|
'''
|
|
@@ -156739,7 +156815,7 @@ class CfnRefreshSchedule(
|
|
|
156739
156815
|
metaclass=jsii.JSIIMeta,
|
|
156740
156816
|
jsii_type="aws-cdk-lib.aws_quicksight.CfnRefreshSchedule",
|
|
156741
156817
|
):
|
|
156742
|
-
'''Creates a refresh schedule for a dataset in
|
|
156818
|
+
'''Creates a refresh schedule for a dataset in Quick Suite .
|
|
156743
156819
|
|
|
156744
156820
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-refreshschedule.html
|
|
156745
156821
|
:cloudformationResource: AWS::QuickSight::RefreshSchedule
|
|
@@ -156986,7 +157062,7 @@ class CfnRefreshSchedule(
|
|
|
156986
157062
|
) -> None:
|
|
156987
157063
|
'''A summary of a configured refresh schedule for a dataset.
|
|
156988
157064
|
|
|
156989
|
-
:param refresh_type: The type of refresh that a dataset undergoes. Valid values are as follows:. - ``FULL_REFRESH`` : A complete refresh of a dataset. - ``INCREMENTAL_REFRESH`` : A partial refresh of some rows of a dataset, based on the time window specified. For more information on full and incremental refreshes, see `Refreshing SPICE data <https://docs.aws.amazon.com/quicksight/latest/user/refreshing-imported-data.html>`_ in the *
|
|
157065
|
+
:param refresh_type: The type of refresh that a dataset undergoes. Valid values are as follows:. - ``FULL_REFRESH`` : A complete refresh of a dataset. - ``INCREMENTAL_REFRESH`` : A partial refresh of some rows of a dataset, based on the time window specified. For more information on full and incremental refreshes, see `Refreshing SPICE data <https://docs.aws.amazon.com/quicksight/latest/user/refreshing-imported-data.html>`_ in the *Quick Suite User Guide* .
|
|
156990
157066
|
:param schedule_frequency: The frequency for the refresh schedule.
|
|
156991
157067
|
:param schedule_id: An identifier for the refresh schedule.
|
|
156992
157068
|
:param start_after_date_time: Time after which the refresh schedule can be started, expressed in ``YYYY-MM-DDTHH:MM:SS`` format.
|
|
@@ -157038,7 +157114,7 @@ class CfnRefreshSchedule(
|
|
|
157038
157114
|
- ``FULL_REFRESH`` : A complete refresh of a dataset.
|
|
157039
157115
|
- ``INCREMENTAL_REFRESH`` : A partial refresh of some rows of a dataset, based on the time window specified.
|
|
157040
157116
|
|
|
157041
|
-
For more information on full and incremental refreshes, see `Refreshing SPICE data <https://docs.aws.amazon.com/quicksight/latest/user/refreshing-imported-data.html>`_ in the *
|
|
157117
|
+
For more information on full and incremental refreshes, see `Refreshing SPICE data <https://docs.aws.amazon.com/quicksight/latest/user/refreshing-imported-data.html>`_ in the *Quick Suite User Guide* .
|
|
157042
157118
|
|
|
157043
157119
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-refreshschedule-refreshschedulemap.html#cfn-quicksight-refreshschedule-refreshschedulemap-refreshtype
|
|
157044
157120
|
'''
|
|
@@ -157215,11 +157291,11 @@ class CfnTemplate(
|
|
|
157215
157291
|
metaclass=jsii.JSIIMeta,
|
|
157216
157292
|
jsii_type="aws-cdk-lib.aws_quicksight.CfnTemplate",
|
|
157217
157293
|
):
|
|
157218
|
-
'''Creates a template from an existing
|
|
157294
|
+
'''Creates a template from an existing Quick Suite analysis or template.
|
|
157219
157295
|
|
|
157220
157296
|
You can use the resulting template to create a dashboard.
|
|
157221
157297
|
|
|
157222
|
-
A *template* is an entity in
|
|
157298
|
+
A *template* is an entity in Quick Suite that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
|
|
157223
157299
|
|
|
157224
157300
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html
|
|
157225
157301
|
:cloudformationResource: AWS::QuickSight::Template
|
|
@@ -157248,12 +157324,12 @@ class CfnTemplate(
|
|
|
157248
157324
|
'''
|
|
157249
157325
|
:param scope: Scope in which this resource is defined.
|
|
157250
157326
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
157251
|
-
:param aws_account_id: The ID for the AWS account that the group is in. You use the ID for the AWS account that contains your Amazon
|
|
157327
|
+
:param aws_account_id: The ID for the AWS account that the group is in. You use the ID for the AWS account that contains your Amazon Quick Sight account.
|
|
157252
157328
|
:param template_id: An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.
|
|
157253
157329
|
:param definition:
|
|
157254
157330
|
:param name: A display name for the template.
|
|
157255
157331
|
:param permissions: A list of resource permissions to be set on the template.
|
|
157256
|
-
:param source_entity: The entity that you are using as a source when you create the template. In ``SourceEntity`` , you specify the type of object you're using as source: ``SourceTemplate`` for a template or ``SourceAnalysis`` for an analysis. Both of these require an Amazon Resource Name (ARN). For ``SourceTemplate`` , specify the ARN of the source template. For ``SourceAnalysis`` , specify the ARN of the source analysis. The ``SourceTemplate`` ARN can contain any AWS account and any
|
|
157332
|
+
:param source_entity: The entity that you are using as a source when you create the template. In ``SourceEntity`` , you specify the type of object you're using as source: ``SourceTemplate`` for a template or ``SourceAnalysis`` for an analysis. Both of these require an Amazon Resource Name (ARN). For ``SourceTemplate`` , specify the ARN of the source template. For ``SourceAnalysis`` , specify the ARN of the source analysis. The ``SourceTemplate`` ARN can contain any AWS account and any Quick Sight-supported AWS Region . Use the ``DataSetReferences`` entity within ``SourceTemplate`` or ``SourceAnalysis`` to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. Either a ``SourceEntity`` or a ``Definition`` must be provided in order for the request to be valid.
|
|
157257
157333
|
:param tags: Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
|
|
157258
157334
|
:param validation_strategy: The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to ``LENIENT`` , validation is skipped for specific errors.
|
|
157259
157335
|
:param version_description: A description of the current template version being created. This API operation creates the first version of the template. Every time ``UpdateTemplate`` is called, a new version is created. Each version of the template maintains a description of the version in the ``VersionDescription`` field.
|
|
@@ -160091,7 +160167,7 @@ class CfnTemplate(
|
|
|
160091
160167
|
- Horizontal stacked 100% bar chart
|
|
160092
160168
|
- Vertical stacked 100% bar chart
|
|
160093
160169
|
|
|
160094
|
-
For more information, see `Using bar charts <https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html>`_ in the *Amazon
|
|
160170
|
+
For more information, see `Using bar charts <https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
160095
160171
|
|
|
160096
160172
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
160097
160173
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -161934,7 +162010,7 @@ class CfnTemplate(
|
|
|
161934
162010
|
) -> None:
|
|
161935
162011
|
'''A box plot.
|
|
161936
162012
|
|
|
161937
|
-
For more information, see `Using box plots <https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html>`_ in the *Amazon
|
|
162013
|
+
For more information, see `Using box plots <https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
161938
162014
|
|
|
161939
162015
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
161940
162016
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -162832,8 +162908,8 @@ class CfnTemplate(
|
|
|
162832
162908
|
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
|
|
162833
162909
|
|
|
162834
162910
|
:param custom_filter_configuration: A custom filter that filters based on a single value. This filter can be partially matched.
|
|
162835
|
-
:param custom_filter_list_configuration: A list of custom filter values. In the
|
|
162836
|
-
:param filter_list_configuration: A list of filter configurations. In the
|
|
162911
|
+
:param custom_filter_list_configuration: A list of custom filter values. In the Quick Sight console, this filter type is called a custom filter list.
|
|
162912
|
+
:param filter_list_configuration: A list of filter configurations. In the Quick Sight console, this filter type is called a filter list.
|
|
162837
162913
|
|
|
162838
162914
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilterconfiguration.html
|
|
162839
162915
|
:exampleMetadata: fixture=_generated
|
|
@@ -162904,7 +162980,7 @@ class CfnTemplate(
|
|
|
162904
162980
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.CustomFilterListConfigurationProperty"]]:
|
|
162905
162981
|
'''A list of custom filter values.
|
|
162906
162982
|
|
|
162907
|
-
In the
|
|
162983
|
+
In the Quick Sight console, this filter type is called a custom filter list.
|
|
162908
162984
|
|
|
162909
162985
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilterconfiguration.html#cfn-quicksight-template-categoryfilterconfiguration-customfilterlistconfiguration
|
|
162910
162986
|
'''
|
|
@@ -162917,7 +162993,7 @@ class CfnTemplate(
|
|
|
162917
162993
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.FilterListConfigurationProperty"]]:
|
|
162918
162994
|
'''A list of filter configurations.
|
|
162919
162995
|
|
|
162920
|
-
In the
|
|
162996
|
+
In the Quick Sight console, this filter type is called a filter list.
|
|
162921
162997
|
|
|
162922
162998
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-categoryfilterconfiguration.html#cfn-quicksight-template-categoryfilterconfiguration-filterlistconfiguration
|
|
162923
162999
|
'''
|
|
@@ -162956,7 +163032,7 @@ class CfnTemplate(
|
|
|
162956
163032
|
) -> None:
|
|
162957
163033
|
'''A ``CategoryFilter`` filters text values.
|
|
162958
163034
|
|
|
162959
|
-
For more information, see `Adding text filters <https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html>`_ in the *Amazon
|
|
163035
|
+
For more information, see `Adding text filters <https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
162960
163036
|
|
|
162961
163037
|
:param column: The column that the filter is applied to.
|
|
162962
163038
|
:param configuration: The configuration for a ``CategoryFilter`` .
|
|
@@ -165842,7 +165918,7 @@ class CfnTemplate(
|
|
|
165842
165918
|
|
|
165843
165919
|
The ``ComboChartVisual`` includes stacked bar combo charts and clustered bar combo charts
|
|
165844
165920
|
|
|
165845
|
-
For more information, see `Using combo charts <https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html>`_ in the *Amazon
|
|
165921
|
+
For more information, see `Using combo charts <https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
165846
165922
|
|
|
165847
165923
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
165848
165924
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -167947,7 +168023,7 @@ class CfnTemplate(
|
|
|
167947
168023
|
) -> None:
|
|
167948
168024
|
'''A visual that contains custom content.
|
|
167949
168025
|
|
|
167950
|
-
For more information, see `Using custom visual content <https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html>`_ in the *Amazon
|
|
168026
|
+
For more information, see `Using custom visual content <https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
167951
168027
|
|
|
167952
168028
|
:param data_set_identifier: The dataset that is used to create the custom content visual. You can't create a visual without a dataset.
|
|
167953
168029
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
@@ -174061,7 +174137,7 @@ class CfnTemplate(
|
|
|
174061
174137
|
|
|
174062
174138
|
This option isn't available for pie charts.
|
|
174063
174139
|
|
|
174064
|
-
:param label_visibility: Determines the visibility of the label in a donut chart. In the
|
|
174140
|
+
:param label_visibility: Determines the visibility of the label in a donut chart. In the Quick Sight console, this option is called ``'Show total'`` .
|
|
174065
174141
|
|
|
174066
174142
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-donutcenteroptions.html
|
|
174067
174143
|
:exampleMetadata: fixture=_generated
|
|
@@ -174087,7 +174163,7 @@ class CfnTemplate(
|
|
|
174087
174163
|
def label_visibility(self) -> typing.Optional[builtins.str]:
|
|
174088
174164
|
'''Determines the visibility of the label in a donut chart.
|
|
174089
174165
|
|
|
174090
|
-
In the
|
|
174166
|
+
In the Quick Sight console, this option is called ``'Show total'`` .
|
|
174091
174167
|
|
|
174092
174168
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-donutcenteroptions.html#cfn-quicksight-template-donutcenteroptions-labelvisibility
|
|
174093
174169
|
'''
|
|
@@ -174558,7 +174634,7 @@ class CfnTemplate(
|
|
|
174558
174634
|
) -> None:
|
|
174559
174635
|
'''An empty visual.
|
|
174560
174636
|
|
|
174561
|
-
Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the
|
|
174637
|
+
Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the Quick Sight console is considered an ``EmptyVisual`` until a visual type is selected.
|
|
174562
174638
|
|
|
174563
174639
|
:param data_set_identifier: The data set that is used in the empty visual. Every visual requires a dataset to render.
|
|
174564
174640
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
@@ -176213,7 +176289,7 @@ class CfnTemplate(
|
|
|
176213
176289
|
) -> None:
|
|
176214
176290
|
'''A filled map.
|
|
176215
176291
|
|
|
176216
|
-
For more information, see `Creating filled maps <https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html>`_ in the *Amazon
|
|
176292
|
+
For more information, see `Creating filled maps <https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
176217
176293
|
|
|
176218
176294
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
176219
176295
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -177340,7 +177416,7 @@ class CfnTemplate(
|
|
|
177340
177416
|
) -> None:
|
|
177341
177417
|
'''A grouping of individual filters. Filter groups are applied to the same group of visuals.
|
|
177342
177418
|
|
|
177343
|
-
For more information, see `Adding filter conditions (group filters) with AND and OR operators <https://docs.aws.amazon.com/quicksight/latest/user/add-a-compound-filter.html>`_ in the *Amazon
|
|
177419
|
+
For more information, see `Adding filter conditions (group filters) with AND and OR operators <https://docs.aws.amazon.com/quicksight/latest/user/add-a-compound-filter.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
177344
177420
|
|
|
177345
177421
|
:param cross_dataset: The filter new feature which can apply filter group to all data sets. Choose one of the following options:. - ``ALL_DATASETS`` - ``SINGLE_DATASET``
|
|
177346
177422
|
:param filter_group_id: The value that uniquely identifies a ``FilterGroup`` within a dashboard, template, or analysis.
|
|
@@ -177954,7 +178030,7 @@ class CfnTemplate(
|
|
|
177954
178030
|
|
|
177955
178031
|
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
|
|
177956
178032
|
|
|
177957
|
-
:param category_filter: A ``CategoryFilter`` filters text values. For more information, see `Adding text filters <https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html>`_ in the *Amazon
|
|
178033
|
+
:param category_filter: A ``CategoryFilter`` filters text values. For more information, see `Adding text filters <https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
177958
178034
|
:param nested_filter: A ``NestedFilter`` filters data with a subset of data that is defined by the nested inner filter.
|
|
177959
178035
|
:param numeric_equality_filter: A ``NumericEqualityFilter`` filters numeric values that equal or do not equal a given numeric value.
|
|
177960
178036
|
:param numeric_range_filter: A ``NumericRangeFilter`` filters numeric values that are either inside or outside a given numeric range.
|
|
@@ -178004,7 +178080,7 @@ class CfnTemplate(
|
|
|
178004
178080
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.CategoryFilterProperty"]]:
|
|
178005
178081
|
'''A ``CategoryFilter`` filters text values.
|
|
178006
178082
|
|
|
178007
|
-
For more information, see `Adding text filters <https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html>`_ in the *Amazon
|
|
178083
|
+
For more information, see `Adding text filters <https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
178008
178084
|
|
|
178009
178085
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-categoryfilter
|
|
178010
178086
|
'''
|
|
@@ -181165,7 +181241,7 @@ class CfnTemplate(
|
|
|
181165
181241
|
) -> None:
|
|
181166
181242
|
'''A funnel chart.
|
|
181167
181243
|
|
|
181168
|
-
For more information, see `Using funnel charts <https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html>`_ in the *Amazon
|
|
181244
|
+
For more information, see `Using funnel charts <https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
181169
181245
|
|
|
181170
181246
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
181171
181247
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -182264,7 +182340,7 @@ class CfnTemplate(
|
|
|
182264
182340
|
) -> None:
|
|
182265
182341
|
'''A gauge chart.
|
|
182266
182342
|
|
|
182267
|
-
For more information, see `Using gauge charts <https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html>`_ in the *Amazon
|
|
182343
|
+
For more information, see `Using gauge charts <https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
182268
182344
|
|
|
182269
182345
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
182270
182346
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -183053,7 +183129,7 @@ class CfnTemplate(
|
|
|
183053
183129
|
) -> None:
|
|
183054
183130
|
'''A geospatial map or a points on map visual.
|
|
183055
183131
|
|
|
183056
|
-
For more information, see `Creating point maps <https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html>`_ in the *Amazon
|
|
183132
|
+
For more information, see `Creating point maps <https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
183057
183133
|
|
|
183058
183134
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
183059
183135
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -183949,7 +184025,7 @@ class CfnTemplate(
|
|
|
183949
184025
|
) -> None:
|
|
183950
184026
|
'''The options that determine the sizing of the canvas used in a grid layout.
|
|
183951
184027
|
|
|
183952
|
-
:param resize_option: This value determines the layout behavior when the viewport is resized. - ``FIXED`` : A fixed width will be used when optimizing the layout. In the
|
|
184028
|
+
:param resize_option: This value determines the layout behavior when the viewport is resized. - ``FIXED`` : A fixed width will be used when optimizing the layout. In the Quick Sight console, this option is called ``Classic`` . - ``RESPONSIVE`` : The width of the canvas will be responsive and optimized to the view port. In the Quick Sight console, this option is called ``Tiled`` .
|
|
183953
184029
|
:param optimized_view_port_width: The width that the view port will be optimized for when the layout renders.
|
|
183954
184030
|
|
|
183955
184031
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutscreencanvassizeoptions.html
|
|
@@ -183982,8 +184058,8 @@ class CfnTemplate(
|
|
|
183982
184058
|
def resize_option(self) -> builtins.str:
|
|
183983
184059
|
'''This value determines the layout behavior when the viewport is resized.
|
|
183984
184060
|
|
|
183985
|
-
- ``FIXED`` : A fixed width will be used when optimizing the layout. In the
|
|
183986
|
-
- ``RESPONSIVE`` : The width of the canvas will be responsive and optimized to the view port. In the
|
|
184061
|
+
- ``FIXED`` : A fixed width will be used when optimizing the layout. In the Quick Sight console, this option is called ``Classic`` .
|
|
184062
|
+
- ``RESPONSIVE`` : The width of the canvas will be responsive and optimized to the view port. In the Quick Sight console, this option is called ``Tiled`` .
|
|
183987
184063
|
|
|
183988
184064
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-gridlayoutscreencanvassizeoptions.html#cfn-quicksight-template-gridlayoutscreencanvassizeoptions-resizeoption
|
|
183989
184065
|
'''
|
|
@@ -184793,7 +184869,7 @@ class CfnTemplate(
|
|
|
184793
184869
|
) -> None:
|
|
184794
184870
|
'''A heat map.
|
|
184795
184871
|
|
|
184796
|
-
For more information, see `Using heat maps <https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html>`_ in the *Amazon
|
|
184872
|
+
For more information, see `Using heat maps <https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
184797
184873
|
|
|
184798
184874
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
184799
184875
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -185884,7 +185960,7 @@ class CfnTemplate(
|
|
|
185884
185960
|
) -> None:
|
|
185885
185961
|
'''A histogram.
|
|
185886
185962
|
|
|
185887
|
-
For more information, see `Using histograms <https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html>`_ in the *Amazon
|
|
185963
|
+
For more information, see `Using histograms <https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
185888
185964
|
|
|
185889
185965
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
185890
185966
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -186833,7 +186909,7 @@ class CfnTemplate(
|
|
|
186833
186909
|
) -> None:
|
|
186834
186910
|
'''An insight visual.
|
|
186835
186911
|
|
|
186836
|
-
For more information, see `Working with insights <https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html>`_ in the *Amazon
|
|
186912
|
+
For more information, see `Working with insights <https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
186837
186913
|
|
|
186838
186914
|
:param data_set_identifier: The dataset that is used in the insight visual.
|
|
186839
186915
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
@@ -189012,7 +189088,7 @@ class CfnTemplate(
|
|
|
189012
189088
|
) -> None:
|
|
189013
189089
|
'''A key performance indicator (KPI).
|
|
189014
189090
|
|
|
189015
|
-
For more information, see `Using KPIs <https://docs.aws.amazon.com/quicksight/latest/user/kpi.html>`_ in the *Amazon
|
|
189091
|
+
For more information, see `Using KPIs <https://docs.aws.amazon.com/quicksight/latest/user/kpi.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
189016
189092
|
|
|
189017
189093
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
189018
189094
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -189728,7 +189804,7 @@ class CfnTemplate(
|
|
|
189728
189804
|
) -> None:
|
|
189729
189805
|
'''A ``Layout`` defines the placement of elements within a sheet.
|
|
189730
189806
|
|
|
189731
|
-
For more information, see `Types of layout <https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html>`_ in the *Amazon
|
|
189807
|
+
For more information, see `Types of layout <https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
189732
189808
|
|
|
189733
189809
|
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
|
|
189734
189810
|
|
|
@@ -191453,7 +191529,7 @@ class CfnTemplate(
|
|
|
191453
191529
|
) -> None:
|
|
191454
191530
|
'''A line chart.
|
|
191455
191531
|
|
|
191456
|
-
For more information, see `Using line charts <https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html>`_ in the *Amazon
|
|
191532
|
+
For more information, see `Using line charts <https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
191457
191533
|
|
|
191458
191534
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
191459
191535
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -196511,7 +196587,7 @@ class CfnTemplate(
|
|
|
196511
196587
|
) -> None:
|
|
196512
196588
|
'''The declaration definition of a parameter.
|
|
196513
196589
|
|
|
196514
|
-
For more information, see `Parameters in Amazon
|
|
196590
|
+
For more information, see `Parameters in Amazon Quick Sight <https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
196515
196591
|
|
|
196516
196592
|
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
|
|
196517
196593
|
|
|
@@ -198814,9 +198890,9 @@ class CfnTemplate(
|
|
|
198814
198890
|
- Pie charts
|
|
198815
198891
|
- Donut charts
|
|
198816
198892
|
|
|
198817
|
-
For more information, see `Using pie charts <https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html>`_ in the *Amazon
|
|
198893
|
+
For more information, see `Using pie charts <https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
198818
198894
|
|
|
198819
|
-
For more information, see `Using donut charts <https://docs.aws.amazon.com/quicksight/latest/user/donut-chart.html>`_ in the *Amazon
|
|
198895
|
+
For more information, see `Using donut charts <https://docs.aws.amazon.com/quicksight/latest/user/donut-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
198820
198896
|
|
|
198821
198897
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
198822
198898
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -201380,7 +201456,7 @@ class CfnTemplate(
|
|
|
201380
201456
|
) -> None:
|
|
201381
201457
|
'''A pivot table.
|
|
201382
201458
|
|
|
201383
|
-
For more information, see `Using pivot tables <https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html>`_ in the *Amazon
|
|
201459
|
+
For more information, see `Using pivot tables <https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
201384
201460
|
|
|
201385
201461
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
201386
201462
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -202193,7 +202269,7 @@ class CfnTemplate(
|
|
|
202193
202269
|
title: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnTemplate.VisualTitleLabelOptionsProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
202194
202270
|
visual_content_alt_text: typing.Optional[builtins.str] = None,
|
|
202195
202271
|
) -> None:
|
|
202196
|
-
'''A flexible visualization type that allows engineers to create new custom charts in
|
|
202272
|
+
'''A flexible visualization type that allows engineers to create new custom charts in Quick Sight.
|
|
202197
202273
|
|
|
202198
202274
|
:param plugin_arn: The Amazon Resource Name (ARN) that reflects the plugin and version.
|
|
202199
202275
|
:param visual_id: The ID of the visual that you want to use.
|
|
@@ -205392,7 +205468,7 @@ class CfnTemplate(
|
|
|
205392
205468
|
'''Permission for the resource.
|
|
205393
205469
|
|
|
205394
205470
|
:param actions: The IAM action to grant or revoke permissions on.
|
|
205395
|
-
:param principal: The Amazon Resource Name (ARN) of the principal. This can be one of the following:. - The ARN of an Amazon
|
|
205471
|
+
:param principal: The Amazon Resource Name (ARN) of the principal. This can be one of the following:. - The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is common.) - The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) - The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
|
|
205396
205472
|
:param resource:
|
|
205397
205473
|
|
|
205398
205474
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-resourcepermission.html
|
|
@@ -205438,9 +205514,9 @@ class CfnTemplate(
|
|
|
205438
205514
|
def principal(self) -> builtins.str:
|
|
205439
205515
|
'''The Amazon Resource Name (ARN) of the principal. This can be one of the following:.
|
|
205440
205516
|
|
|
205441
|
-
- The ARN of an Amazon
|
|
205442
|
-
- The ARN of an Amazon
|
|
205443
|
-
- The ARN of an AWS account root: This is an IAM ARN rather than a
|
|
205517
|
+
- The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is common.)
|
|
205518
|
+
- The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
|
|
205519
|
+
- The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
|
|
205444
205520
|
|
|
205445
205521
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-resourcepermission.html#cfn-quicksight-template-resourcepermission-principal
|
|
205446
205522
|
'''
|
|
@@ -206109,7 +206185,7 @@ class CfnTemplate(
|
|
|
206109
206185
|
) -> None:
|
|
206110
206186
|
'''A sankey diagram.
|
|
206111
206187
|
|
|
206112
|
-
For more information, see `Using Sankey diagrams <https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html>`_ in the *Amazon
|
|
206188
|
+
For more information, see `Using Sankey diagrams <https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
206113
206189
|
|
|
206114
206190
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
206115
206191
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -206860,7 +206936,7 @@ class CfnTemplate(
|
|
|
206860
206936
|
) -> None:
|
|
206861
206937
|
'''A scatter plot.
|
|
206862
206938
|
|
|
206863
|
-
For more information, see `Using scatter plots <https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html>`_ in the *Amazon
|
|
206939
|
+
For more information, see `Using scatter plots <https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
206864
206940
|
|
|
206865
206941
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
206866
206942
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -208546,11 +208622,11 @@ class CfnTemplate(
|
|
|
208546
208622
|
:param sheet_id: The unique identifier of a sheet.
|
|
208547
208623
|
:param content_type: The layout content type of the sheet. Choose one of the following options:. - ``PAGINATED`` : Creates a sheet for a paginated report. - ``INTERACTIVE`` : Creates a sheet for an interactive dashboard.
|
|
208548
208624
|
:param description: A description of the sheet.
|
|
208549
|
-
:param filter_controls: The list of filter controls that are on a sheet. For more information, see `Adding filter controls to analysis sheets <https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html>`_ in the *Amazon
|
|
208625
|
+
:param filter_controls: The list of filter controls that are on a sheet. For more information, see `Adding filter controls to analysis sheets <https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
208550
208626
|
:param images: A list of images on a sheet.
|
|
208551
|
-
:param layouts: Layouts define how the components of a sheet are arranged. For more information, see `Types of layout <https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html>`_ in the *Amazon
|
|
208627
|
+
:param layouts: Layouts define how the components of a sheet are arranged. For more information, see `Types of layout <https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
208552
208628
|
:param name: The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
|
|
208553
|
-
:param parameter_controls: The list of parameter controls that are on a sheet. For more information, see `Using a Control with a Parameter in Amazon
|
|
208629
|
+
:param parameter_controls: The list of parameter controls that are on a sheet. For more information, see `Using a Control with a Parameter in Amazon Quick Sight <https://docs.aws.amazon.com/quicksight/latest/user/parameters-controls.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
208554
208630
|
:param sheet_control_layouts: The control layouts of the sheet.
|
|
208555
208631
|
:param text_boxes: The text boxes that are on a sheet.
|
|
208556
208632
|
:param title: The title of the sheet.
|
|
@@ -208640,7 +208716,7 @@ class CfnTemplate(
|
|
|
208640
208716
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnTemplate.FilterControlProperty"]]]]:
|
|
208641
208717
|
'''The list of filter controls that are on a sheet.
|
|
208642
208718
|
|
|
208643
|
-
For more information, see `Adding filter controls to analysis sheets <https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html>`_ in the *Amazon
|
|
208719
|
+
For more information, see `Adding filter controls to analysis sheets <https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
208644
208720
|
|
|
208645
208721
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-filtercontrols
|
|
208646
208722
|
'''
|
|
@@ -208664,7 +208740,7 @@ class CfnTemplate(
|
|
|
208664
208740
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnTemplate.LayoutProperty"]]]]:
|
|
208665
208741
|
'''Layouts define how the components of a sheet are arranged.
|
|
208666
208742
|
|
|
208667
|
-
For more information, see `Types of layout <https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html>`_ in the *Amazon
|
|
208743
|
+
For more information, see `Types of layout <https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
208668
208744
|
|
|
208669
208745
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-layouts
|
|
208670
208746
|
'''
|
|
@@ -208688,7 +208764,7 @@ class CfnTemplate(
|
|
|
208688
208764
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnTemplate.ParameterControlProperty"]]]]:
|
|
208689
208765
|
'''The list of parameter controls that are on a sheet.
|
|
208690
208766
|
|
|
208691
|
-
For more information, see `Using a Control with a Parameter in Amazon
|
|
208767
|
+
For more information, see `Using a Control with a Parameter in Amazon Quick Sight <https://docs.aws.amazon.com/quicksight/latest/user/parameters-controls.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
208692
208768
|
|
|
208693
208769
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheetdefinition.html#cfn-quicksight-template-sheetdefinition-parametercontrols
|
|
208694
208770
|
'''
|
|
@@ -209420,11 +209496,11 @@ class CfnTemplate(
|
|
|
209420
209496
|
name: typing.Optional[builtins.str] = None,
|
|
209421
209497
|
sheet_id: typing.Optional[builtins.str] = None,
|
|
209422
209498
|
) -> None:
|
|
209423
|
-
'''A *sheet* , which is an object that contains a set of visuals that are viewed together on one page in
|
|
209499
|
+
'''A *sheet* , which is an object that contains a set of visuals that are viewed together on one page in Quick Sight.
|
|
209424
209500
|
|
|
209425
209501
|
Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.
|
|
209426
209502
|
|
|
209427
|
-
:param name: The name of a sheet. This name is displayed on the sheet's tab in the
|
|
209503
|
+
:param name: The name of a sheet. This name is displayed on the sheet's tab in the Quick Sight console.
|
|
209428
209504
|
:param sheet_id: The unique identifier associated with a sheet.
|
|
209429
209505
|
|
|
209430
209506
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheet.html
|
|
@@ -209455,7 +209531,7 @@ class CfnTemplate(
|
|
|
209455
209531
|
def name(self) -> typing.Optional[builtins.str]:
|
|
209456
209532
|
'''The name of a sheet.
|
|
209457
209533
|
|
|
209458
|
-
This name is displayed on the sheet's tab in the
|
|
209534
|
+
This name is displayed on the sheet's tab in the Quick Sight console.
|
|
209459
209535
|
|
|
209460
209536
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheet.html#cfn-quicksight-template-sheet-name
|
|
209461
209537
|
'''
|
|
@@ -214270,7 +214346,7 @@ class CfnTemplate(
|
|
|
214270
214346
|
) -> None:
|
|
214271
214347
|
'''A table visual.
|
|
214272
214348
|
|
|
214273
|
-
For more information, see `Using tables as visuals <https://docs.aws.amazon.com/quicksight/latest/user/tabular.html>`_ in the *Amazon
|
|
214349
|
+
For more information, see `Using tables as visuals <https://docs.aws.amazon.com/quicksight/latest/user/tabular.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
214274
214350
|
|
|
214275
214351
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
214276
214352
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -214740,9 +214816,9 @@ class CfnTemplate(
|
|
|
214740
214816
|
:param analysis_defaults:
|
|
214741
214817
|
:param calculated_fields: An array of calculated field definitions for the template.
|
|
214742
214818
|
:param column_configurations: An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.
|
|
214743
|
-
:param filter_groups: Filter definitions for a template. For more information, see `Filtering Data <https://docs.aws.amazon.com/quicksight/latest/user/filtering-visual-data.html>`_ in the *Amazon
|
|
214819
|
+
:param filter_groups: Filter definitions for a template. For more information, see `Filtering Data <https://docs.aws.amazon.com/quicksight/latest/user/filtering-visual-data.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
214744
214820
|
:param options: An array of option definitions for a template.
|
|
214745
|
-
:param parameter_declarations: An array of parameter declarations for a template. *Parameters* are named variables that can transfer a value for use by an action or an object. For more information, see `Parameters in Amazon
|
|
214821
|
+
:param parameter_declarations: An array of parameter declarations for a template. *Parameters* are named variables that can transfer a value for use by an action or an object. For more information, see `Parameters in Amazon Quick Sight <https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
214746
214822
|
:param query_execution_options:
|
|
214747
214823
|
:param sheets: An array of sheet definitions for a template.
|
|
214748
214824
|
|
|
@@ -214838,7 +214914,7 @@ class CfnTemplate(
|
|
|
214838
214914
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnTemplate.FilterGroupProperty"]]]]:
|
|
214839
214915
|
'''Filter definitions for a template.
|
|
214840
214916
|
|
|
214841
|
-
For more information, see `Filtering Data <https://docs.aws.amazon.com/quicksight/latest/user/filtering-visual-data.html>`_ in the *Amazon
|
|
214917
|
+
For more information, see `Filtering Data <https://docs.aws.amazon.com/quicksight/latest/user/filtering-visual-data.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
214842
214918
|
|
|
214843
214919
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversiondefinition.html#cfn-quicksight-template-templateversiondefinition-filtergroups
|
|
214844
214920
|
'''
|
|
@@ -214864,7 +214940,7 @@ class CfnTemplate(
|
|
|
214864
214940
|
|
|
214865
214941
|
*Parameters* are named variables that can transfer a value for use by an action or an object.
|
|
214866
214942
|
|
|
214867
|
-
For more information, see `Parameters in Amazon
|
|
214943
|
+
For more information, see `Parameters in Amazon Quick Sight <https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
214868
214944
|
|
|
214869
214945
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversiondefinition.html#cfn-quicksight-template-templateversiondefinition-parameterdeclarations
|
|
214870
214946
|
'''
|
|
@@ -219103,7 +219179,7 @@ class CfnTemplate(
|
|
|
219103
219179
|
) -> None:
|
|
219104
219180
|
'''A tree map.
|
|
219105
219181
|
|
|
219106
|
-
For more information, see `Using tree maps <https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html>`_ in the *Amazon
|
|
219182
|
+
For more information, see `Using tree maps <https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
219107
219183
|
|
|
219108
219184
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
219109
219185
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -220687,30 +220763,30 @@ class CfnTemplate(
|
|
|
220687
220763
|
|
|
220688
220764
|
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
|
|
220689
220765
|
|
|
220690
|
-
:param bar_chart_visual: A bar chart. For more information, see `Using bar charts <https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html>`_ in the *Amazon
|
|
220691
|
-
:param box_plot_visual: A box plot. For more information, see `Using box plots <https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html>`_ in the *Amazon
|
|
220692
|
-
:param combo_chart_visual: A combo chart. For more information, see `Using combo charts <https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html>`_ in the *Amazon
|
|
220693
|
-
:param custom_content_visual: A visual that contains custom content. For more information, see `Using custom visual content <https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html>`_ in the *Amazon
|
|
220766
|
+
:param bar_chart_visual: A bar chart. For more information, see `Using bar charts <https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220767
|
+
:param box_plot_visual: A box plot. For more information, see `Using box plots <https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220768
|
+
:param combo_chart_visual: A combo chart. For more information, see `Using combo charts <https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220769
|
+
:param custom_content_visual: A visual that contains custom content. For more information, see `Using custom visual content <https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220694
220770
|
:param empty_visual: An empty visual.
|
|
220695
|
-
:param filled_map_visual: A filled map. For more information, see `Creating filled maps <https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html>`_ in the *Amazon
|
|
220696
|
-
:param funnel_chart_visual: A funnel chart. For more information, see `Using funnel charts <https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html>`_ in the *Amazon
|
|
220697
|
-
:param gauge_chart_visual: A gauge chart. For more information, see `Using gauge charts <https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html>`_ in the *Amazon
|
|
220698
|
-
:param geospatial_map_visual: A geospatial map or a points on map visual. For more information, see `Creating point maps <https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html>`_ in the *Amazon
|
|
220699
|
-
:param heat_map_visual: A heat map. For more information, see `Using heat maps <https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html>`_ in the *Amazon
|
|
220700
|
-
:param histogram_visual: A histogram. For more information, see `Using histograms <https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html>`_ in the *Amazon
|
|
220701
|
-
:param insight_visual: An insight visual. For more information, see `Working with insights <https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html>`_ in the *Amazon
|
|
220702
|
-
:param kpi_visual: A key performance indicator (KPI). For more information, see `Using KPIs <https://docs.aws.amazon.com/quicksight/latest/user/kpi.html>`_ in the *Amazon
|
|
220703
|
-
:param line_chart_visual: A line chart. For more information, see `Using line charts <https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html>`_ in the *Amazon
|
|
220704
|
-
:param pie_chart_visual: A pie or donut chart. For more information, see `Using pie charts <https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html>`_ in the *Amazon
|
|
220705
|
-
:param pivot_table_visual: A pivot table. For more information, see `Using pivot tables <https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html>`_ in the *Amazon
|
|
220771
|
+
:param filled_map_visual: A filled map. For more information, see `Creating filled maps <https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220772
|
+
:param funnel_chart_visual: A funnel chart. For more information, see `Using funnel charts <https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220773
|
+
:param gauge_chart_visual: A gauge chart. For more information, see `Using gauge charts <https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220774
|
+
:param geospatial_map_visual: A geospatial map or a points on map visual. For more information, see `Creating point maps <https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220775
|
+
:param heat_map_visual: A heat map. For more information, see `Using heat maps <https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220776
|
+
:param histogram_visual: A histogram. For more information, see `Using histograms <https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220777
|
+
:param insight_visual: An insight visual. For more information, see `Working with insights <https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220778
|
+
:param kpi_visual: A key performance indicator (KPI). For more information, see `Using KPIs <https://docs.aws.amazon.com/quicksight/latest/user/kpi.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220779
|
+
:param line_chart_visual: A line chart. For more information, see `Using line charts <https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220780
|
+
:param pie_chart_visual: A pie or donut chart. For more information, see `Using pie charts <https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220781
|
+
:param pivot_table_visual: A pivot table. For more information, see `Using pivot tables <https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220706
220782
|
:param plugin_visual: The custom plugin visual type.
|
|
220707
|
-
:param radar_chart_visual: A radar chart visual. For more information, see `Using radar charts <https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html>`_ in the *Amazon
|
|
220708
|
-
:param sankey_diagram_visual: A sankey diagram. For more information, see `Using Sankey diagrams <https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html>`_ in the *Amazon
|
|
220709
|
-
:param scatter_plot_visual: A scatter plot. For more information, see `Using scatter plots <https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html>`_ in the *Amazon
|
|
220710
|
-
:param table_visual: A table visual. For more information, see `Using tables as visuals <https://docs.aws.amazon.com/quicksight/latest/user/tabular.html>`_ in the *Amazon
|
|
220711
|
-
:param tree_map_visual: A tree map. For more information, see `Using tree maps <https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html>`_ in the *Amazon
|
|
220712
|
-
:param waterfall_visual: A waterfall chart. For more information, see `Using waterfall charts <https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html>`_ in the *Amazon
|
|
220713
|
-
:param word_cloud_visual: A word cloud. For more information, see `Using word clouds <https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html>`_ in the *Amazon
|
|
220783
|
+
:param radar_chart_visual: A radar chart visual. For more information, see `Using radar charts <https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220784
|
+
:param sankey_diagram_visual: A sankey diagram. For more information, see `Using Sankey diagrams <https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220785
|
+
:param scatter_plot_visual: A scatter plot. For more information, see `Using scatter plots <https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220786
|
+
:param table_visual: A table visual. For more information, see `Using tables as visuals <https://docs.aws.amazon.com/quicksight/latest/user/tabular.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220787
|
+
:param tree_map_visual: A tree map. For more information, see `Using tree maps <https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220788
|
+
:param waterfall_visual: A waterfall chart. For more information, see `Using waterfall charts <https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220789
|
+
:param word_cloud_visual: A word cloud. For more information, see `Using word clouds <https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220714
220790
|
|
|
220715
220791
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html
|
|
220716
220792
|
:exampleMetadata: fixture=_generated
|
|
@@ -220801,7 +220877,7 @@ class CfnTemplate(
|
|
|
220801
220877
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.BarChartVisualProperty"]]:
|
|
220802
220878
|
'''A bar chart.
|
|
220803
220879
|
|
|
220804
|
-
For more information, see `Using bar charts <https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html>`_ in the *Amazon
|
|
220880
|
+
For more information, see `Using bar charts <https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220805
220881
|
|
|
220806
220882
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-barchartvisual
|
|
220807
220883
|
'''
|
|
@@ -220814,7 +220890,7 @@ class CfnTemplate(
|
|
|
220814
220890
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.BoxPlotVisualProperty"]]:
|
|
220815
220891
|
'''A box plot.
|
|
220816
220892
|
|
|
220817
|
-
For more information, see `Using box plots <https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html>`_ in the *Amazon
|
|
220893
|
+
For more information, see `Using box plots <https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220818
220894
|
|
|
220819
220895
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-boxplotvisual
|
|
220820
220896
|
'''
|
|
@@ -220827,7 +220903,7 @@ class CfnTemplate(
|
|
|
220827
220903
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.ComboChartVisualProperty"]]:
|
|
220828
220904
|
'''A combo chart.
|
|
220829
220905
|
|
|
220830
|
-
For more information, see `Using combo charts <https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html>`_ in the *Amazon
|
|
220906
|
+
For more information, see `Using combo charts <https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220831
220907
|
|
|
220832
220908
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-combochartvisual
|
|
220833
220909
|
'''
|
|
@@ -220840,7 +220916,7 @@ class CfnTemplate(
|
|
|
220840
220916
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.CustomContentVisualProperty"]]:
|
|
220841
220917
|
'''A visual that contains custom content.
|
|
220842
220918
|
|
|
220843
|
-
For more information, see `Using custom visual content <https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html>`_ in the *Amazon
|
|
220919
|
+
For more information, see `Using custom visual content <https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220844
220920
|
|
|
220845
220921
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-customcontentvisual
|
|
220846
220922
|
'''
|
|
@@ -220864,7 +220940,7 @@ class CfnTemplate(
|
|
|
220864
220940
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.FilledMapVisualProperty"]]:
|
|
220865
220941
|
'''A filled map.
|
|
220866
220942
|
|
|
220867
|
-
For more information, see `Creating filled maps <https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html>`_ in the *Amazon
|
|
220943
|
+
For more information, see `Creating filled maps <https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220868
220944
|
|
|
220869
220945
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-filledmapvisual
|
|
220870
220946
|
'''
|
|
@@ -220877,7 +220953,7 @@ class CfnTemplate(
|
|
|
220877
220953
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.FunnelChartVisualProperty"]]:
|
|
220878
220954
|
'''A funnel chart.
|
|
220879
220955
|
|
|
220880
|
-
For more information, see `Using funnel charts <https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html>`_ in the *Amazon
|
|
220956
|
+
For more information, see `Using funnel charts <https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220881
220957
|
|
|
220882
220958
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-funnelchartvisual
|
|
220883
220959
|
'''
|
|
@@ -220890,7 +220966,7 @@ class CfnTemplate(
|
|
|
220890
220966
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.GaugeChartVisualProperty"]]:
|
|
220891
220967
|
'''A gauge chart.
|
|
220892
220968
|
|
|
220893
|
-
For more information, see `Using gauge charts <https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html>`_ in the *Amazon
|
|
220969
|
+
For more information, see `Using gauge charts <https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220894
220970
|
|
|
220895
220971
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-gaugechartvisual
|
|
220896
220972
|
'''
|
|
@@ -220903,7 +220979,7 @@ class CfnTemplate(
|
|
|
220903
220979
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.GeospatialMapVisualProperty"]]:
|
|
220904
220980
|
'''A geospatial map or a points on map visual.
|
|
220905
220981
|
|
|
220906
|
-
For more information, see `Creating point maps <https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html>`_ in the *Amazon
|
|
220982
|
+
For more information, see `Creating point maps <https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220907
220983
|
|
|
220908
220984
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-geospatialmapvisual
|
|
220909
220985
|
'''
|
|
@@ -220916,7 +220992,7 @@ class CfnTemplate(
|
|
|
220916
220992
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.HeatMapVisualProperty"]]:
|
|
220917
220993
|
'''A heat map.
|
|
220918
220994
|
|
|
220919
|
-
For more information, see `Using heat maps <https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html>`_ in the *Amazon
|
|
220995
|
+
For more information, see `Using heat maps <https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220920
220996
|
|
|
220921
220997
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-heatmapvisual
|
|
220922
220998
|
'''
|
|
@@ -220929,7 +221005,7 @@ class CfnTemplate(
|
|
|
220929
221005
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.HistogramVisualProperty"]]:
|
|
220930
221006
|
'''A histogram.
|
|
220931
221007
|
|
|
220932
|
-
For more information, see `Using histograms <https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html>`_ in the *Amazon
|
|
221008
|
+
For more information, see `Using histograms <https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220933
221009
|
|
|
220934
221010
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-histogramvisual
|
|
220935
221011
|
'''
|
|
@@ -220942,7 +221018,7 @@ class CfnTemplate(
|
|
|
220942
221018
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.InsightVisualProperty"]]:
|
|
220943
221019
|
'''An insight visual.
|
|
220944
221020
|
|
|
220945
|
-
For more information, see `Working with insights <https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html>`_ in the *Amazon
|
|
221021
|
+
For more information, see `Working with insights <https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220946
221022
|
|
|
220947
221023
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-insightvisual
|
|
220948
221024
|
'''
|
|
@@ -220955,7 +221031,7 @@ class CfnTemplate(
|
|
|
220955
221031
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.KPIVisualProperty"]]:
|
|
220956
221032
|
'''A key performance indicator (KPI).
|
|
220957
221033
|
|
|
220958
|
-
For more information, see `Using KPIs <https://docs.aws.amazon.com/quicksight/latest/user/kpi.html>`_ in the *Amazon
|
|
221034
|
+
For more information, see `Using KPIs <https://docs.aws.amazon.com/quicksight/latest/user/kpi.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220959
221035
|
|
|
220960
221036
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-kpivisual
|
|
220961
221037
|
'''
|
|
@@ -220968,7 +221044,7 @@ class CfnTemplate(
|
|
|
220968
221044
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.LineChartVisualProperty"]]:
|
|
220969
221045
|
'''A line chart.
|
|
220970
221046
|
|
|
220971
|
-
For more information, see `Using line charts <https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html>`_ in the *Amazon
|
|
221047
|
+
For more information, see `Using line charts <https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220972
221048
|
|
|
220973
221049
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-linechartvisual
|
|
220974
221050
|
'''
|
|
@@ -220981,7 +221057,7 @@ class CfnTemplate(
|
|
|
220981
221057
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.PieChartVisualProperty"]]:
|
|
220982
221058
|
'''A pie or donut chart.
|
|
220983
221059
|
|
|
220984
|
-
For more information, see `Using pie charts <https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html>`_ in the *Amazon
|
|
221060
|
+
For more information, see `Using pie charts <https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220985
221061
|
|
|
220986
221062
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-piechartvisual
|
|
220987
221063
|
'''
|
|
@@ -220994,7 +221070,7 @@ class CfnTemplate(
|
|
|
220994
221070
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.PivotTableVisualProperty"]]:
|
|
220995
221071
|
'''A pivot table.
|
|
220996
221072
|
|
|
220997
|
-
For more information, see `Using pivot tables <https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html>`_ in the *Amazon
|
|
221073
|
+
For more information, see `Using pivot tables <https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
220998
221074
|
|
|
220999
221075
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-pivottablevisual
|
|
221000
221076
|
'''
|
|
@@ -221018,7 +221094,7 @@ class CfnTemplate(
|
|
|
221018
221094
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.RadarChartVisualProperty"]]:
|
|
221019
221095
|
'''A radar chart visual.
|
|
221020
221096
|
|
|
221021
|
-
For more information, see `Using radar charts <https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html>`_ in the *Amazon
|
|
221097
|
+
For more information, see `Using radar charts <https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
221022
221098
|
|
|
221023
221099
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-radarchartvisual
|
|
221024
221100
|
'''
|
|
@@ -221031,7 +221107,7 @@ class CfnTemplate(
|
|
|
221031
221107
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.SankeyDiagramVisualProperty"]]:
|
|
221032
221108
|
'''A sankey diagram.
|
|
221033
221109
|
|
|
221034
|
-
For more information, see `Using Sankey diagrams <https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html>`_ in the *Amazon
|
|
221110
|
+
For more information, see `Using Sankey diagrams <https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
221035
221111
|
|
|
221036
221112
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-sankeydiagramvisual
|
|
221037
221113
|
'''
|
|
@@ -221044,7 +221120,7 @@ class CfnTemplate(
|
|
|
221044
221120
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.ScatterPlotVisualProperty"]]:
|
|
221045
221121
|
'''A scatter plot.
|
|
221046
221122
|
|
|
221047
|
-
For more information, see `Using scatter plots <https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html>`_ in the *Amazon
|
|
221123
|
+
For more information, see `Using scatter plots <https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
221048
221124
|
|
|
221049
221125
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-scatterplotvisual
|
|
221050
221126
|
'''
|
|
@@ -221057,7 +221133,7 @@ class CfnTemplate(
|
|
|
221057
221133
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.TableVisualProperty"]]:
|
|
221058
221134
|
'''A table visual.
|
|
221059
221135
|
|
|
221060
|
-
For more information, see `Using tables as visuals <https://docs.aws.amazon.com/quicksight/latest/user/tabular.html>`_ in the *Amazon
|
|
221136
|
+
For more information, see `Using tables as visuals <https://docs.aws.amazon.com/quicksight/latest/user/tabular.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
221061
221137
|
|
|
221062
221138
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-tablevisual
|
|
221063
221139
|
'''
|
|
@@ -221070,7 +221146,7 @@ class CfnTemplate(
|
|
|
221070
221146
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.TreeMapVisualProperty"]]:
|
|
221071
221147
|
'''A tree map.
|
|
221072
221148
|
|
|
221073
|
-
For more information, see `Using tree maps <https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html>`_ in the *Amazon
|
|
221149
|
+
For more information, see `Using tree maps <https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
221074
221150
|
|
|
221075
221151
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-treemapvisual
|
|
221076
221152
|
'''
|
|
@@ -221083,7 +221159,7 @@ class CfnTemplate(
|
|
|
221083
221159
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.WaterfallVisualProperty"]]:
|
|
221084
221160
|
'''A waterfall chart.
|
|
221085
221161
|
|
|
221086
|
-
For more information, see `Using waterfall charts <https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html>`_ in the *Amazon
|
|
221162
|
+
For more information, see `Using waterfall charts <https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
221087
221163
|
|
|
221088
221164
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-waterfallvisual
|
|
221089
221165
|
'''
|
|
@@ -221096,7 +221172,7 @@ class CfnTemplate(
|
|
|
221096
221172
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTemplate.WordCloudVisualProperty"]]:
|
|
221097
221173
|
'''A word cloud.
|
|
221098
221174
|
|
|
221099
|
-
For more information, see `Using word clouds <https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html>`_ in the *Amazon
|
|
221175
|
+
For more information, see `Using word clouds <https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
221100
221176
|
|
|
221101
221177
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-visual.html#cfn-quicksight-template-visual-wordcloudvisual
|
|
221102
221178
|
'''
|
|
@@ -221984,7 +222060,7 @@ class CfnTemplate(
|
|
|
221984
222060
|
) -> None:
|
|
221985
222061
|
'''A waterfall chart.
|
|
221986
222062
|
|
|
221987
|
-
For more information, see `Using waterfall charts <https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html>`_ in the *Amazon
|
|
222063
|
+
For more information, see `Using waterfall charts <https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
221988
222064
|
|
|
221989
222065
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
|
|
221990
222066
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -222792,7 +222868,7 @@ class CfnTemplate(
|
|
|
222792
222868
|
) -> None:
|
|
222793
222869
|
'''A word cloud.
|
|
222794
222870
|
|
|
222795
|
-
For more information, see `Using word clouds <https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html>`_ in the *Amazon
|
|
222871
|
+
For more information, see `Using word clouds <https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
222796
222872
|
|
|
222797
222873
|
:param visual_id: The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
|
|
222798
222874
|
:param actions: The list of custom actions that are configured for a visual.
|
|
@@ -222984,7 +223060,7 @@ class CfnTheme(
|
|
|
222984
223060
|
):
|
|
222985
223061
|
'''Creates a theme.
|
|
222986
223062
|
|
|
222987
|
-
A *theme* is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see `Using Themes in Amazon
|
|
223063
|
+
A *theme* is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see `Using Themes in Amazon Quick Suite <https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html>`_ in the *Amazon Quick Suite User Guide* .
|
|
222988
223064
|
|
|
222989
223065
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html
|
|
222990
223066
|
:cloudformationResource: AWS::QuickSight::Theme
|
|
@@ -223081,7 +223157,7 @@ class CfnTheme(
|
|
|
223081
223157
|
:param scope: Scope in which this resource is defined.
|
|
223082
223158
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
223083
223159
|
:param aws_account_id: The ID of the AWS account where you want to store the new theme.
|
|
223084
|
-
:param base_theme_id: The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon
|
|
223160
|
+
:param base_theme_id: The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon Quick Sight. For a list of the starting themes, use ``ListThemes`` or choose *Themes* from within an analysis.
|
|
223085
223161
|
:param configuration: The theme configuration, which contains the theme display properties.
|
|
223086
223162
|
:param name: A display name for the theme.
|
|
223087
223163
|
:param theme_id: An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.
|
|
@@ -223744,7 +223820,7 @@ class CfnTheme(
|
|
|
223744
223820
|
'''Permission for the resource.
|
|
223745
223821
|
|
|
223746
223822
|
:param actions: The IAM action to grant or revoke permissions on.
|
|
223747
|
-
:param principal: The Amazon Resource Name (ARN) of the principal. This can be one of the following:. - The ARN of an Amazon
|
|
223823
|
+
:param principal: The Amazon Resource Name (ARN) of the principal. This can be one of the following:. - The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is common.) - The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) - The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
|
|
223748
223824
|
:param resource:
|
|
223749
223825
|
|
|
223750
223826
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-resourcepermission.html
|
|
@@ -223790,9 +223866,9 @@ class CfnTheme(
|
|
|
223790
223866
|
def principal(self) -> builtins.str:
|
|
223791
223867
|
'''The Amazon Resource Name (ARN) of the principal. This can be one of the following:.
|
|
223792
223868
|
|
|
223793
|
-
- The ARN of an Amazon
|
|
223794
|
-
- The ARN of an Amazon
|
|
223795
|
-
- The ARN of an AWS account root: This is an IAM ARN rather than a
|
|
223869
|
+
- The ARN of an Amazon Quick Suite user or group associated with a data source or dataset. (This is common.)
|
|
223870
|
+
- The ARN of an Amazon Quick Suite user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
|
|
223871
|
+
- The ARN of an AWS account root: This is an IAM ARN rather than a Quick Suite ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
|
|
223796
223872
|
|
|
223797
223873
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-resourcepermission.html#cfn-quicksight-theme-resourcepermission-principal
|
|
223798
223874
|
'''
|
|
@@ -224158,7 +224234,7 @@ class CfnTheme(
|
|
|
224158
224234
|
'''A version of a theme.
|
|
224159
224235
|
|
|
224160
224236
|
:param arn: The Amazon Resource Name (ARN) of the resource.
|
|
224161
|
-
:param base_theme_id: The
|
|
224237
|
+
:param base_theme_id: The Quick Sight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default Quick Sight theme.
|
|
224162
224238
|
:param configuration: The theme configuration, which contains all the theme display properties.
|
|
224163
224239
|
:param created_time: The date and time that this theme version was created.
|
|
224164
224240
|
:param description: The description of the theme.
|
|
@@ -224272,9 +224348,9 @@ class CfnTheme(
|
|
|
224272
224348
|
|
|
224273
224349
|
@builtins.property
|
|
224274
224350
|
def base_theme_id(self) -> typing.Optional[builtins.str]:
|
|
224275
|
-
'''The
|
|
224351
|
+
'''The Quick Sight-defined ID of the theme that a custom theme inherits from.
|
|
224276
224352
|
|
|
224277
|
-
All themes initially inherit from a default
|
|
224353
|
+
All themes initially inherit from a default Quick Sight theme.
|
|
224278
224354
|
|
|
224279
224355
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeversion.html#cfn-quicksight-theme-themeversion-basethemeid
|
|
224280
224356
|
'''
|
|
@@ -224591,7 +224667,7 @@ class CfnTheme(
|
|
|
224591
224667
|
) -> None:
|
|
224592
224668
|
'''The theme colors that apply to UI and to charts, excluding data colors.
|
|
224593
224669
|
|
|
224594
|
-
The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with ``#`` , for example #37BFF5. For more information, see `Using Themes in Amazon
|
|
224670
|
+
The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with ``#`` , for example #37BFF5. For more information, see `Using Themes in Amazon Quick Suite <https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html>`_ in the *Amazon Quick Suite User Guide.*
|
|
224595
224671
|
|
|
224596
224672
|
:param accent: This color is that applies to selected states and buttons.
|
|
224597
224673
|
:param accent_foreground: The foreground color that applies to any text or other elements that appear over the accent color.
|
|
@@ -236109,6 +236185,7 @@ def _typecheckingstub__c9e09587ab720431f5373014612c24f6d414533d5702638a33a14c36c
|
|
|
236109
236185
|
executive_summary_option: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDashboard.ExecutiveSummaryOptionProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
236110
236186
|
export_to_csv_option: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDashboard.ExportToCSVOptionProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
236111
236187
|
export_with_hidden_fields_option: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDashboard.ExportWithHiddenFieldsOptionProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
236188
|
+
quick_suite_actions_option: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDashboard.QuickSuiteActionsOptionProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
236112
236189
|
sheet_controls_option: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDashboard.SheetControlsOptionProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
236113
236190
|
sheet_layout_element_maximization_option: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDashboard.SheetLayoutElementMaximizationOptionProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
236114
236191
|
visual_axis_sort_option: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDashboard.VisualAxisSortOptionProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
@@ -239015,6 +239092,13 @@ def _typecheckingstub__7b749fd545ef26437f40040ce3d66eb5fc1f74dd885bdbd215d96299a
|
|
|
239015
239092
|
"""Type checking stubs"""
|
|
239016
239093
|
pass
|
|
239017
239094
|
|
|
239095
|
+
def _typecheckingstub__9c8b3e1bc413fb8347a340dd8ee206f937d0c39bdda82fbb3961908543f7b81c(
|
|
239096
|
+
*,
|
|
239097
|
+
availability_status: typing.Optional[builtins.str] = None,
|
|
239098
|
+
) -> None:
|
|
239099
|
+
"""Type checking stubs"""
|
|
239100
|
+
pass
|
|
239101
|
+
|
|
239018
239102
|
def _typecheckingstub__62e03423d11f9d7c54d2dbabdc23b969f7868353b929e4d5ed40a4a2e3caac79(
|
|
239019
239103
|
*,
|
|
239020
239104
|
category: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDashboard.DimensionFieldProperty, typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
@@ -247310,3 +247394,6 @@ def _typecheckingstub__739acf70e62b97a09a7f5c798708670a2c0bc24d04d30df3dac04b1b4
|
|
|
247310
247394
|
) -> None:
|
|
247311
247395
|
"""Type checking stubs"""
|
|
247312
247396
|
pass
|
|
247397
|
+
|
|
247398
|
+
for cls in [IAnalysisRef, ICustomPermissionsRef, IDashboardRef, IDataSetRef, IDataSourceRef, IFolderRef, IRefreshScheduleRef, ITemplateRef, IThemeRef, ITopicRef, IVPCConnectionRef]:
|
|
247399
|
+
typing.cast(typing.Any, cls).__protocol_attrs__ = typing.cast(typing.Any, cls).__protocol_attrs__ - set(['__jsii_proxy_class__', '__jsii_type__'])
|