Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.QuickSight.Lens

Contents

Operations
Types

Description

Synopsis

Operations

CancelIngestion

cancelIngestion_awsAccountId :: Lens' CancelIngestion Text Source #

The Amazon Web Services account ID.

cancelIngestion_dataSetId :: Lens' CancelIngestion Text Source #

The ID of the dataset used in the ingestion.

cancelIngestion_ingestionId :: Lens' CancelIngestion Text Source #

An ID for the ingestion.

cancelIngestionResponse_arn :: Lens' CancelIngestionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the data ingestion.

cancelIngestionResponse_ingestionId :: Lens' CancelIngestionResponse (Maybe Text) Source #

An ID for the ingestion.

cancelIngestionResponse_requestId :: Lens' CancelIngestionResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

cancelIngestionResponse_status :: Lens' CancelIngestionResponse Int Source #

The HTTP status of the request.

CreateAccountCustomization

createAccountCustomization_namespace :: Lens' CreateAccountCustomization (Maybe Text) Source #

The Amazon QuickSight namespace that you want to add customizations to.

createAccountCustomization_tags :: Lens' CreateAccountCustomization (Maybe (NonEmpty Tag)) Source #

A list of the tags that you want to attach to this resource.

createAccountCustomization_awsAccountId :: Lens' CreateAccountCustomization Text Source #

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

createAccountCustomization_accountCustomization :: Lens' CreateAccountCustomization AccountCustomization Source #

The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add these to an Amazon Web Services account and a QuickSight namespace.

For example, you can add a default theme by setting AccountCustomization to the midnight theme: "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" }. Or, you can add a custom theme by specifying "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" }.

createAccountCustomizationResponse_accountCustomization :: Lens' CreateAccountCustomizationResponse (Maybe AccountCustomization) Source #

The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region.

createAccountCustomizationResponse_arn :: Lens' CreateAccountCustomizationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.

createAccountCustomizationResponse_awsAccountId :: Lens' CreateAccountCustomizationResponse (Maybe Text) Source #

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

createAccountCustomizationResponse_namespace :: Lens' CreateAccountCustomizationResponse (Maybe Text) Source #

The namespace associated with the customization you're creating.

createAccountCustomizationResponse_requestId :: Lens' CreateAccountCustomizationResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createAccountCustomizationResponse_status :: Lens' CreateAccountCustomizationResponse Int Source #

The HTTP status of the request.

CreateAccountSubscription

createAccountSubscription_activeDirectoryName :: Lens' CreateAccountSubscription (Maybe Text) Source #

The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

createAccountSubscription_adminGroup :: Lens' CreateAccountSubscription (Maybe [Text]) Source #

The admin group associated with your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

createAccountSubscription_authorGroup :: Lens' CreateAccountSubscription (Maybe [Text]) Source #

The author group associated with your Active Directory. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

createAccountSubscription_contactNumber :: Lens' CreateAccountSubscription (Maybe Text) Source #

A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.

createAccountSubscription_directoryId :: Lens' CreateAccountSubscription (Maybe Text) Source #

The ID of the Active Directory that is associated with your Amazon QuickSight account.

createAccountSubscription_emailAddress :: Lens' CreateAccountSubscription (Maybe Text) Source #

The email address of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.

createAccountSubscription_firstName :: Lens' CreateAccountSubscription (Maybe Text) Source #

The first name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.

createAccountSubscription_lastName :: Lens' CreateAccountSubscription (Maybe Text) Source #

The last name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.

createAccountSubscription_readerGroup :: Lens' CreateAccountSubscription (Maybe [Text]) Source #

The reader group associated with your Active Direcrtory. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

createAccountSubscription_realm :: Lens' CreateAccountSubscription (Maybe Text) Source #

The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

createAccountSubscription_edition :: Lens' CreateAccountSubscription Edition Source #

The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from ENTERPRISE or ENTERPRISE_AND_Q.

If you choose ENTERPRISE_AND_Q, the following parameters are required:

```
FirstName
```
```
LastName
```
```
EmailAddress
```
```
ContactNumber
```

createAccountSubscription_authenticationMethod :: Lens' CreateAccountSubscription AuthenticationMethodOption Source #

The method that you want to use to authenticate your Amazon QuickSight account. Currently, the valid values for this parameter are IAM_AND_QUICKSIGHT, IAM_ONLY, and ACTIVE_DIRECTORY.

If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName and an AdminGroup associated with your Active Directory.

createAccountSubscription_awsAccountId :: Lens' CreateAccountSubscription Text Source #

The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.

createAccountSubscription_accountName :: Lens' CreateAccountSubscription Text Source #

The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change AccountName value after the Amazon QuickSight account is created.

createAccountSubscription_notificationEmail :: Lens' CreateAccountSubscription Text Source #

The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.

createAccountSubscriptionResponse_requestId :: Lens' CreateAccountSubscriptionResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createAccountSubscriptionResponse_signupResponse :: Lens' CreateAccountSubscriptionResponse (Maybe SignupResponse) Source #

A SignupResponse object that returns information about a newly created Amazon QuickSight account.

createAccountSubscriptionResponse_status :: Lens' CreateAccountSubscriptionResponse Int Source #

The HTTP status of the request.

CreateAnalysis

createAnalysis_definition :: Lens' CreateAnalysis (Maybe AnalysisDefinition) Source #

The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

createAnalysis_parameters :: Lens' CreateAnalysis (Maybe Parameters) Source #

The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

createAnalysis_permissions :: Lens' CreateAnalysis (Maybe (NonEmpty ResourcePermission)) Source #

A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit Permissions.

createAnalysis_sourceEntity :: Lens' CreateAnalysis (Maybe AnalysisSourceEntity) Source #

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.

createAnalysis_tags :: Lens' CreateAnalysis (Maybe (NonEmpty Tag)) Source #

Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

createAnalysis_themeArn :: Lens' CreateAnalysis (Maybe Text) Source #

The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.

createAnalysis_awsAccountId :: Lens' CreateAnalysis Text Source #

The ID of the Amazon Web Services account where you are creating an analysis.

createAnalysis_analysisId :: Lens' CreateAnalysis Text Source #

The ID for the analysis that you're creating. This ID displays in the URL of the analysis.

createAnalysis_name :: Lens' CreateAnalysis Text Source #

A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.

createAnalysisResponse_analysisId :: Lens' CreateAnalysisResponse (Maybe Text) Source #

The ID of the analysis.

createAnalysisResponse_arn :: Lens' CreateAnalysisResponse (Maybe Text) Source #

The ARN for the analysis.

createAnalysisResponse_creationStatus :: Lens' CreateAnalysisResponse (Maybe ResourceStatus) Source #

The status of the creation of the analysis.

createAnalysisResponse_requestId :: Lens' CreateAnalysisResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createAnalysisResponse_status :: Lens' CreateAnalysisResponse Int Source #

The HTTP status of the request.

CreateDashboard

createDashboard_dashboardPublishOptions :: Lens' CreateDashboard (Maybe DashboardPublishOptions) Source #

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 QuickSight 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.

createDashboard_definition :: Lens' CreateDashboard (Maybe DashboardVersionDefinition) Source #

The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

createDashboard_parameters :: Lens' CreateDashboard (Maybe Parameters) Source #

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

createDashboard_permissions :: Lens' CreateDashboard (Maybe (NonEmpty ResourcePermission)) Source #

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

createDashboard_sourceEntity :: Lens' CreateDashboard (Maybe DashboardSourceEntity) Source #

The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

createDashboard_tags :: Lens' CreateDashboard (Maybe (NonEmpty Tag)) Source #

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

createDashboard_themeArn :: Lens' CreateDashboard (Maybe Text) Source #

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

createDashboard_versionDescription :: Lens' CreateDashboard (Maybe Text) Source #

A description for the first version of the dashboard being created.

createDashboard_awsAccountId :: Lens' CreateDashboard Text Source #

The ID of the Amazon Web Services account where you want to create the dashboard.

createDashboard_dashboardId :: Lens' CreateDashboard Text Source #

The ID for the dashboard, also added to the IAM policy.

createDashboard_name :: Lens' CreateDashboard Text Source #

The display name of the dashboard.

createDashboardResponse_arn :: Lens' CreateDashboardResponse (Maybe Text) Source #

The ARN of the dashboard.

createDashboardResponse_creationStatus :: Lens' CreateDashboardResponse (Maybe ResourceStatus) Source #

The status of the dashboard creation request.

createDashboardResponse_dashboardId :: Lens' CreateDashboardResponse (Maybe Text) Source #

The ID for the dashboard.

createDashboardResponse_requestId :: Lens' CreateDashboardResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createDashboardResponse_versionArn :: Lens' CreateDashboardResponse (Maybe Text) Source #

The ARN of the dashboard, including the version number of the first version that is created.

createDashboardResponse_status :: Lens' CreateDashboardResponse Int Source #

The HTTP status of the request.

CreateDataSet

createDataSet_columnGroups :: Lens' CreateDataSet (Maybe (NonEmpty ColumnGroup)) Source #

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

createDataSet_columnLevelPermissionRules :: Lens' CreateDataSet (Maybe (NonEmpty ColumnLevelPermissionRule)) Source #

A set of one or more definitions of a ColumnLevelPermissionRule .

createDataSet_dataSetUsageConfiguration :: Lens' CreateDataSet (Maybe DataSetUsageConfiguration) Source #

Undocumented member.

createDataSet_fieldFolders :: Lens' CreateDataSet (Maybe (HashMap Text FieldFolder)) Source #

The folder that contains fields and nested subfolders for your dataset.

createDataSet_logicalTableMap :: Lens' CreateDataSet (Maybe (HashMap Text LogicalTable)) Source #

Configures the combination and transformation of the data from the physical tables.

createDataSet_permissions :: Lens' CreateDataSet (Maybe (NonEmpty ResourcePermission)) Source #

A list of resource permissions on the dataset.

createDataSet_rowLevelPermissionDataSet :: Lens' CreateDataSet (Maybe RowLevelPermissionDataSet) Source #

The row-level security configuration for the data that you want to create.

createDataSet_rowLevelPermissionTagConfiguration :: Lens' CreateDataSet (Maybe RowLevelPermissionTagConfiguration) Source #

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

createDataSet_tags :: Lens' CreateDataSet (Maybe (NonEmpty Tag)) Source #

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

createDataSet_awsAccountId :: Lens' CreateDataSet Text Source #

The Amazon Web Services account ID.

createDataSet_dataSetId :: Lens' CreateDataSet Text Source #

An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

createDataSet_name :: Lens' CreateDataSet Text Source #

The display name for the dataset.

createDataSet_physicalTableMap :: Lens' CreateDataSet (HashMap Text PhysicalTable) Source #

Declares the physical tables that are available in the underlying data sources.

createDataSet_importMode :: Lens' CreateDataSet DataSetImportMode Source #

Indicates whether you want to import the data into SPICE.

createDataSetResponse_arn :: Lens' CreateDataSetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset.

createDataSetResponse_dataSetId :: Lens' CreateDataSetResponse (Maybe Text) Source #

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

createDataSetResponse_ingestionArn :: Lens' CreateDataSetResponse (Maybe Text) Source #

The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.

createDataSetResponse_ingestionId :: Lens' CreateDataSetResponse (Maybe Text) Source #

The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.

createDataSetResponse_requestId :: Lens' CreateDataSetResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createDataSetResponse_status :: Lens' CreateDataSetResponse Int Source #

The HTTP status of the request.

CreateDataSource

createDataSource_credentials :: Lens' CreateDataSource (Maybe DataSourceCredentials) Source #

The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

createDataSource_dataSourceParameters :: Lens' CreateDataSource (Maybe DataSourceParameters) Source #

The parameters that Amazon QuickSight uses to connect to your underlying source.

createDataSource_permissions :: Lens' CreateDataSource (Maybe (NonEmpty ResourcePermission)) Source #

A list of resource permissions on the data source.

createDataSource_sslProperties :: Lens' CreateDataSource (Maybe SslProperties) Source #

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

createDataSource_tags :: Lens' CreateDataSource (Maybe (NonEmpty Tag)) Source #

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

createDataSource_vpcConnectionProperties :: Lens' CreateDataSource (Maybe VpcConnectionProperties) Source #

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

createDataSource_awsAccountId :: Lens' CreateDataSource Text Source #

The Amazon Web Services account ID.

createDataSource_dataSourceId :: Lens' CreateDataSource Text Source #

An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

createDataSource_name :: Lens' CreateDataSource Text Source #

A display name for the data source.

createDataSource_type :: Lens' CreateDataSource DataSourceType Source #

The type of the data source. To return a list of all data sources, use ListDataSources.

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

createDataSourceResponse_arn :: Lens' CreateDataSourceResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the data source.

createDataSourceResponse_creationStatus :: Lens' CreateDataSourceResponse (Maybe ResourceStatus) Source #

The status of creating the data source.

createDataSourceResponse_dataSourceId :: Lens' CreateDataSourceResponse (Maybe Text) Source #

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

createDataSourceResponse_requestId :: Lens' CreateDataSourceResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createDataSourceResponse_status :: Lens' CreateDataSourceResponse Int Source #

The HTTP status of the request.

CreateFolder

createFolder_folderType :: Lens' CreateFolder (Maybe FolderType) Source #

The type of folder. By default, folderType is SHARED.

createFolder_name :: Lens' CreateFolder (Maybe Text) Source #

The name of the folder.

createFolder_parentFolderArn :: Lens' CreateFolder (Maybe Text) Source #

The Amazon Resource Name (ARN) for the parent folder.

ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

createFolder_permissions :: Lens' CreateFolder (Maybe (NonEmpty ResourcePermission)) Source #

A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions.

createFolder_tags :: Lens' CreateFolder (Maybe (NonEmpty Tag)) Source #

Tags for the folder.

createFolder_awsAccountId :: Lens' CreateFolder Text Source #

The ID for the Amazon Web Services account where you want to create the folder.

createFolder_folderId :: Lens' CreateFolder Text Source #

The ID of the folder.

createFolderResponse_arn :: Lens' CreateFolderResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the newly created folder.

createFolderResponse_folderId :: Lens' CreateFolderResponse (Maybe Text) Source #

The folder ID for the newly created folder.

createFolderResponse_requestId :: Lens' CreateFolderResponse (Maybe Text) Source #

The request ID for the newly created folder.

createFolderResponse_status :: Lens' CreateFolderResponse Int Source #

The HTTP status of the request.

CreateFolderMembership

createFolderMembership_awsAccountId :: Lens' CreateFolderMembership Text Source #

The ID for the Amazon Web Services account that contains the folder.

createFolderMembership_folderId :: Lens' CreateFolderMembership Text Source #

The ID of the folder.

createFolderMembership_memberId :: Lens' CreateFolderMembership Text Source #

The ID of the asset (the dashboard, analysis, or dataset).

createFolderMembership_memberType :: Lens' CreateFolderMembership MemberType Source #

The type of the member, including DASHBOARD, ANALYSIS, and DATASET.

createFolderMembershipResponse_folderMember :: Lens' CreateFolderMembershipResponse (Maybe FolderMember) Source #

Information about the member in the folder.

createFolderMembershipResponse_requestId :: Lens' CreateFolderMembershipResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createFolderMembershipResponse_status :: Lens' CreateFolderMembershipResponse (Maybe Int) Source #

The HTTP status of the request.

createFolderMembershipResponse_httpStatus :: Lens' CreateFolderMembershipResponse Int Source #

The response's http status code.

CreateGroup

createGroup_description :: Lens' CreateGroup (Maybe Text) Source #

A description for the group that you want to create.

createGroup_groupName :: Lens' CreateGroup Text Source #

A name for the group that you want to create.

createGroup_awsAccountId :: Lens' CreateGroup Text Source #

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

createGroup_namespace :: Lens' CreateGroup Text Source #

The namespace that you want the group to be a part of.

createGroupResponse_group :: Lens' CreateGroupResponse (Maybe Group) Source #

The name of the group.

createGroupResponse_requestId :: Lens' CreateGroupResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createGroupResponse_status :: Lens' CreateGroupResponse Int Source #

The HTTP status of the request.

CreateGroupMembership

createGroupMembership_memberName :: Lens' CreateGroupMembership Text Source #

The name of the user that you want to add to the group membership.

createGroupMembership_groupName :: Lens' CreateGroupMembership Text Source #

The name of the group that you want to add the user to.

createGroupMembership_awsAccountId :: Lens' CreateGroupMembership Text Source #

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

createGroupMembership_namespace :: Lens' CreateGroupMembership Text Source #

The namespace that you want the user to be a part of.

createGroupMembershipResponse_groupMember :: Lens' CreateGroupMembershipResponse (Maybe GroupMember) Source #

The group member.

createGroupMembershipResponse_requestId :: Lens' CreateGroupMembershipResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createGroupMembershipResponse_status :: Lens' CreateGroupMembershipResponse Int Source #

The HTTP status of the request.

CreateIAMPolicyAssignment

createIAMPolicyAssignment_identities :: Lens' CreateIAMPolicyAssignment (Maybe (HashMap Text [Text])) Source #

The Amazon QuickSight users, groups, or both that you want to assign the policy to.

createIAMPolicyAssignment_policyArn :: Lens' CreateIAMPolicyAssignment (Maybe Text) Source #

The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.

createIAMPolicyAssignment_awsAccountId :: Lens' CreateIAMPolicyAssignment Text Source #

The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.

createIAMPolicyAssignment_assignmentName :: Lens' CreateIAMPolicyAssignment Text Source #

The name of the assignment, also called a rule. It must be unique within an Amazon Web Services account.

createIAMPolicyAssignment_assignmentStatus :: Lens' CreateIAMPolicyAssignment AssignmentStatus Source #

The status of the assignment. Possible values are as follows:

ENABLED - Anything specified in this assignment is used when creating the data source.
DISABLED - This assignment isn't used when creating the data source.
DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.

createIAMPolicyAssignment_namespace :: Lens' CreateIAMPolicyAssignment Text Source #

The namespace that contains the assignment.

createIAMPolicyAssignmentResponse_assignmentId :: Lens' CreateIAMPolicyAssignmentResponse (Maybe Text) Source #

The ID for the assignment.

createIAMPolicyAssignmentResponse_assignmentName :: Lens' CreateIAMPolicyAssignmentResponse (Maybe Text) Source #

The name of the assignment. This name must be unique within the Amazon Web Services account.

createIAMPolicyAssignmentResponse_assignmentStatus :: Lens' CreateIAMPolicyAssignmentResponse (Maybe AssignmentStatus) Source #

The status of the assignment. Possible values are as follows:

ENABLED - Anything specified in this assignment is used when creating the data source.
DISABLED - This assignment isn't used when creating the data source.
DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.

createIAMPolicyAssignmentResponse_identities :: Lens' CreateIAMPolicyAssignmentResponse (Maybe (HashMap Text [Text])) Source #

The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.

createIAMPolicyAssignmentResponse_policyArn :: Lens' CreateIAMPolicyAssignmentResponse (Maybe Text) Source #

The ARN for the IAM policy that is applied to the Amazon QuickSight users and groups specified in this assignment.

createIAMPolicyAssignmentResponse_requestId :: Lens' CreateIAMPolicyAssignmentResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createIAMPolicyAssignmentResponse_status :: Lens' CreateIAMPolicyAssignmentResponse Int Source #

The HTTP status of the request.

CreateIngestion

createIngestion_ingestionType :: Lens' CreateIngestion (Maybe IngestionType) Source #

The type of ingestion that you want to create.

createIngestion_dataSetId :: Lens' CreateIngestion Text Source #

The ID of the dataset used in the ingestion.

createIngestion_ingestionId :: Lens' CreateIngestion Text Source #

An ID for the ingestion.

createIngestion_awsAccountId :: Lens' CreateIngestion Text Source #

The Amazon Web Services account ID.

createIngestionResponse_arn :: Lens' CreateIngestionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the data ingestion.

createIngestionResponse_ingestionId :: Lens' CreateIngestionResponse (Maybe Text) Source #

An ID for the ingestion.

createIngestionResponse_ingestionStatus :: Lens' CreateIngestionResponse (Maybe IngestionStatus) Source #

The ingestion status.

createIngestionResponse_requestId :: Lens' CreateIngestionResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createIngestionResponse_status :: Lens' CreateIngestionResponse Int Source #

The HTTP status of the request.

CreateNamespace

createNamespace_tags :: Lens' CreateNamespace (Maybe (NonEmpty Tag)) Source #

The tags that you want to associate with the namespace that you're creating.

createNamespace_awsAccountId :: Lens' CreateNamespace Text Source #

The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.

createNamespace_namespace :: Lens' CreateNamespace Text Source #

The name that you want to use to describe the new namespace.

createNamespace_identityStore :: Lens' CreateNamespace IdentityStore Source #

Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.

createNamespaceResponse_arn :: Lens' CreateNamespaceResponse (Maybe Text) Source #

The ARN of the Amazon QuickSight namespace you created.

createNamespaceResponse_capacityRegion :: Lens' CreateNamespaceResponse (Maybe Text) Source #

The Amazon Web Services Region; that you want to use for the free SPICE capacity for the new namespace. This is set to the region that you run CreateNamespace in.

createNamespaceResponse_creationStatus :: Lens' CreateNamespaceResponse (Maybe NamespaceStatus) Source #

The status of the creation of the namespace. This is an asynchronous process. A status of CREATED means that your namespace is ready to use. If an error occurs, it indicates if the process is retryable or non-retryable. In the case of a non-retryable error, refer to the error message for follow-up tasks.

createNamespaceResponse_identityStore :: Lens' CreateNamespaceResponse (Maybe IdentityStore) Source #

Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.

createNamespaceResponse_name :: Lens' CreateNamespaceResponse (Maybe Text) Source #

The name of the new namespace that you created.

createNamespaceResponse_requestId :: Lens' CreateNamespaceResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createNamespaceResponse_status :: Lens' CreateNamespaceResponse Int Source #

The HTTP status of the request.

CreateTemplate

createTemplate_definition :: Lens' CreateTemplate (Maybe TemplateVersionDefinition) Source #

The definition of a template.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

createTemplate_name :: Lens' CreateTemplate (Maybe Text) Source #

A display name for the template.

createTemplate_permissions :: Lens' CreateTemplate (Maybe (NonEmpty ResourcePermission)) Source #

A list of resource permissions to be set on the template.

createTemplate_sourceEntity :: Lens' CreateTemplate (Maybe TemplateSourceEntity) Source #

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 Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services 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.

createTemplate_tags :: Lens' CreateTemplate (Maybe (NonEmpty Tag)) Source #

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

createTemplate_versionDescription :: Lens' CreateTemplate (Maybe Text) Source #

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.

createTemplate_awsAccountId :: Lens' CreateTemplate Text Source #

The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

createTemplate_templateId :: Lens' CreateTemplate Text Source #

An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.

createTemplateResponse_arn :: Lens' CreateTemplateResponse (Maybe Text) Source #

The ARN for the template.

createTemplateResponse_creationStatus :: Lens' CreateTemplateResponse (Maybe ResourceStatus) Source #

The template creation status.

createTemplateResponse_requestId :: Lens' CreateTemplateResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createTemplateResponse_templateId :: Lens' CreateTemplateResponse (Maybe Text) Source #

The ID of the template.

createTemplateResponse_versionArn :: Lens' CreateTemplateResponse (Maybe Text) Source #

The ARN for the template, including the version information of the first version.

createTemplateResponse_status :: Lens' CreateTemplateResponse Int Source #

The HTTP status of the request.

CreateTemplateAlias

createTemplateAlias_awsAccountId :: Lens' CreateTemplateAlias Text Source #

The ID of the Amazon Web Services account that contains the template that you creating an alias for.

createTemplateAlias_templateId :: Lens' CreateTemplateAlias Text Source #

An ID for the template.

createTemplateAlias_aliasName :: Lens' CreateTemplateAlias Text Source #

The name that you want to give to the template alias that you're creating. Don't start the alias name with the $ character. Alias names that start with $ are reserved by Amazon QuickSight.

createTemplateAlias_templateVersionNumber :: Lens' CreateTemplateAlias Natural Source #

The version number of the template.

createTemplateAliasResponse_requestId :: Lens' CreateTemplateAliasResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createTemplateAliasResponse_templateAlias :: Lens' CreateTemplateAliasResponse (Maybe TemplateAlias) Source #

Information about the template alias.

createTemplateAliasResponse_status :: Lens' CreateTemplateAliasResponse Int Source #

The HTTP status of the request.

CreateTheme

createTheme_permissions :: Lens' CreateTheme (Maybe (NonEmpty ResourcePermission)) Source #

A valid grouping of resource permissions to apply to the new theme.

createTheme_tags :: Lens' CreateTheme (Maybe (NonEmpty Tag)) Source #

A map of the key-value pairs for the resource tag or tags that you want to add to the resource.

createTheme_versionDescription :: Lens' CreateTheme (Maybe Text) Source #

A description of the first version of the theme that you're creating. Every time UpdateTheme is called, a new version is created. Each version of the theme has a description of the version in the VersionDescription field.

createTheme_awsAccountId :: Lens' CreateTheme Text Source #

The ID of the Amazon Web Services account where you want to store the new theme.

createTheme_themeId :: Lens' CreateTheme Text Source #

An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in each Amazon Web Services account.

createTheme_name :: Lens' CreateTheme Text Source #

A display name for the theme.

createTheme_baseThemeId :: Lens' CreateTheme Text Source #

The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within an analysis.

createTheme_configuration :: Lens' CreateTheme ThemeConfiguration Source #

The theme configuration, which contains the theme display properties.

createThemeResponse_arn :: Lens' CreateThemeResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the theme.

createThemeResponse_creationStatus :: Lens' CreateThemeResponse (Maybe ResourceStatus) Source #

The theme creation status.

createThemeResponse_requestId :: Lens' CreateThemeResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createThemeResponse_themeId :: Lens' CreateThemeResponse (Maybe Text) Source #

The ID of the theme.

createThemeResponse_versionArn :: Lens' CreateThemeResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the new theme.

createThemeResponse_status :: Lens' CreateThemeResponse Int Source #

The HTTP status of the request.

CreateThemeAlias

createThemeAlias_awsAccountId :: Lens' CreateThemeAlias Text Source #

The ID of the Amazon Web Services account that contains the theme for the new theme alias.

createThemeAlias_themeId :: Lens' CreateThemeAlias Text Source #

An ID for the theme alias.

createThemeAlias_aliasName :: Lens' CreateThemeAlias Text Source #

The name that you want to give to the theme alias that you are creating. The alias name can't begin with a $. Alias names that start with $ are reserved by Amazon QuickSight.

createThemeAlias_themeVersionNumber :: Lens' CreateThemeAlias Natural Source #

The version number of the theme.

createThemeAliasResponse_requestId :: Lens' CreateThemeAliasResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createThemeAliasResponse_themeAlias :: Lens' CreateThemeAliasResponse (Maybe ThemeAlias) Source #

Information about the theme alias.

createThemeAliasResponse_status :: Lens' CreateThemeAliasResponse Int Source #

The HTTP status of the request.

DeleteAccountCustomization

deleteAccountCustomization_namespace :: Lens' DeleteAccountCustomization (Maybe Text) Source #

The Amazon QuickSight namespace that you're deleting the customizations from.

deleteAccountCustomization_awsAccountId :: Lens' DeleteAccountCustomization Text Source #

The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in this Amazon Web Services Region.

deleteAccountCustomizationResponse_requestId :: Lens' DeleteAccountCustomizationResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

deleteAccountCustomizationResponse_status :: Lens' DeleteAccountCustomizationResponse Int Source #

The HTTP status of the request.

DeleteAccountSubscription

deleteAccountSubscription_awsAccountId :: Lens' DeleteAccountSubscription Text Source #

The Amazon Web Services account ID of the account that you want to delete.

deleteAccountSubscriptionResponse_requestId :: Lens' DeleteAccountSubscriptionResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

deleteAccountSubscriptionResponse_status :: Lens' DeleteAccountSubscriptionResponse Int Source #

The HTTP status of the request.

DeleteAnalysis

deleteAnalysis_forceDeleteWithoutRecovery :: Lens' DeleteAnalysis (Maybe Bool) Source #

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

deleteAnalysis_recoveryWindowInDays :: Lens' DeleteAnalysis (Maybe Natural) Source #

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

deleteAnalysis_awsAccountId :: Lens' DeleteAnalysis Text Source #

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

deleteAnalysis_analysisId :: Lens' DeleteAnalysis Text Source #

The ID of the analysis that you're deleting.

deleteAnalysisResponse_analysisId :: Lens' DeleteAnalysisResponse (Maybe Text) Source #

The ID of the deleted analysis.

deleteAnalysisResponse_arn :: Lens' DeleteAnalysisResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the deleted analysis.

deleteAnalysisResponse_deletionTime :: Lens' DeleteAnalysisResponse (Maybe UTCTime) Source #

The date and time that the analysis is scheduled to be deleted.

deleteAnalysisResponse_requestId :: Lens' DeleteAnalysisResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

deleteAnalysisResponse_status :: Lens' DeleteAnalysisResponse Int Source #

The HTTP status of the request.

DeleteDashboard

deleteDashboard_versionNumber :: Lens' DeleteDashboard (Maybe Natural) Source #

The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted.

deleteDashboard_awsAccountId :: Lens' DeleteDashboard Text Source #

The ID of the Amazon Web Services account that contains the dashboard that you're deleting.

deleteDashboard_dashboardId :: Lens' DeleteDashboard Text Source #

The ID for the dashboard.

deleteDashboardResponse_arn :: Lens' DeleteDashboardResponse (Maybe Text) Source #

The Secure Socket Layer (SSL) properties that apply for the resource.

deleteDashboardResponse_dashboardId :: Lens' DeleteDashboardResponse (Maybe Text) Source #

The ID of the dashboard.

deleteDashboardResponse_requestId :: Lens' DeleteDashboardResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

deleteDashboardResponse_status :: Lens' DeleteDashboardResponse Int Source #

The HTTP status of the request.

DeleteDataSet

deleteDataSet_awsAccountId :: Lens' DeleteDataSet Text Source #

The Amazon Web Services account ID.

deleteDataSet_dataSetId :: Lens' DeleteDataSet Text Source #

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

deleteDataSetResponse_arn :: Lens' DeleteDataSetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset.

deleteDataSetResponse_dataSetId :: Lens' DeleteDataSetResponse (Maybe Text) Source #

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

deleteDataSetResponse_requestId :: Lens' DeleteDataSetResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

deleteDataSetResponse_status :: Lens' DeleteDataSetResponse Int Source #

The HTTP status of the request.

DeleteDataSource

deleteDataSource_awsAccountId :: Lens' DeleteDataSource Text Source #

The Amazon Web Services account ID.

deleteDataSource_dataSourceId :: Lens' DeleteDataSource Text Source #

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

deleteDataSourceResponse_arn :: Lens' DeleteDataSourceResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the data source that you deleted.

deleteDataSourceResponse_dataSourceId :: Lens' DeleteDataSourceResponse (Maybe Text) Source #

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

deleteDataSourceResponse_requestId :: Lens' DeleteDataSourceResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

deleteDataSourceResponse_status :: Lens' DeleteDataSourceResponse Int Source #

The HTTP status of the request.

DeleteFolder

deleteFolder_awsAccountId :: Lens' DeleteFolder Text Source #

The ID for the Amazon Web Services account that contains the folder.

deleteFolder_folderId :: Lens' DeleteFolder Text Source #

The ID of the folder.

deleteFolderResponse_arn :: Lens' DeleteFolderResponse (Maybe Text) Source #

The Amazon Resource Name of the deleted folder.

deleteFolderResponse_folderId :: Lens' DeleteFolderResponse (Maybe Text) Source #

The ID of the folder.

deleteFolderResponse_requestId :: Lens' DeleteFolderResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

deleteFolderResponse_status :: Lens' DeleteFolderResponse Int Source #

The HTTP status of the request.

DeleteFolderMembership

deleteFolderMembership_awsAccountId :: Lens' DeleteFolderMembership Text Source #

The ID for the Amazon Web Services account that contains the folder.

deleteFolderMembership_folderId :: Lens' DeleteFolderMembership Text Source #

The Folder ID.

deleteFolderMembership_memberId :: Lens' DeleteFolderMembership Text Source #

The ID of the asset (the dashboard, analysis, or dataset) that you want to delete.

deleteFolderMembership_memberType :: Lens' DeleteFolderMembership MemberType Source #

The type of the member, including DASHBOARD, ANALYSIS, and DATASET

deleteFolderMembershipResponse_requestId :: Lens' DeleteFolderMembershipResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

deleteFolderMembershipResponse_status :: Lens' DeleteFolderMembershipResponse (Maybe Int) Source #

The HTTP status of the request.

deleteFolderMembershipResponse_httpStatus :: Lens' DeleteFolderMembershipResponse Int Source #

The response's http status code.

DeleteGroup

deleteGroup_groupName :: Lens' DeleteGroup Text Source #

The name of the group that you want to delete.

deleteGroup_awsAccountId :: Lens' DeleteGroup Text Source #

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

deleteGroup_namespace :: Lens' DeleteGroup Text Source #

The namespace of the group that you want to delete.

deleteGroupResponse_requestId :: Lens' DeleteGroupResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

deleteGroupResponse_status :: Lens' DeleteGroupResponse Int Source #

The HTTP status of the request.

DeleteGroupMembership

deleteGroupMembership_memberName :: Lens' DeleteGroupMembership Text Source #

The name of the user that you want to delete from the group membership.

deleteGroupMembership_groupName :: Lens' DeleteGroupMembership Text Source #

The name of the group that you want to delete the user from.

deleteGroupMembership_awsAccountId :: Lens' DeleteGroupMembership Text Source #

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

deleteGroupMembership_namespace :: Lens' DeleteGroupMembership Text Source #

The namespace of the group that you want to remove a user from.

deleteGroupMembershipResponse_requestId :: Lens' DeleteGroupMembershipResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

deleteGroupMembershipResponse_status :: Lens' DeleteGroupMembershipResponse Int Source #

The HTTP status of the request.

DeleteIAMPolicyAssignment

deleteIAMPolicyAssignment_awsAccountId :: Lens' DeleteIAMPolicyAssignment Text Source #

The Amazon Web Services account ID where you want to delete the IAM policy assignment.

deleteIAMPolicyAssignment_assignmentName :: Lens' DeleteIAMPolicyAssignment Text Source #

The name of the assignment.

deleteIAMPolicyAssignment_namespace :: Lens' DeleteIAMPolicyAssignment Text Source #

The namespace that contains the assignment.

deleteIAMPolicyAssignmentResponse_assignmentName :: Lens' DeleteIAMPolicyAssignmentResponse (Maybe Text) Source #

The name of the assignment.

deleteIAMPolicyAssignmentResponse_requestId :: Lens' DeleteIAMPolicyAssignmentResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

deleteIAMPolicyAssignmentResponse_status :: Lens' DeleteIAMPolicyAssignmentResponse Int Source #

The HTTP status of the request.

DeleteNamespace

deleteNamespace_awsAccountId :: Lens' DeleteNamespace Text Source #

The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.

deleteNamespace_namespace :: Lens' DeleteNamespace Text Source #

The namespace that you want to delete.

deleteNamespaceResponse_requestId :: Lens' DeleteNamespaceResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

deleteNamespaceResponse_status :: Lens' DeleteNamespaceResponse Int Source #

The HTTP status of the request.

DeleteTemplate

deleteTemplate_versionNumber :: Lens' DeleteTemplate (Maybe Natural) Source #

Specifies the version of the template that you want to delete. If you don't provide a version number, DeleteTemplate deletes all versions of the template.

deleteTemplate_awsAccountId :: Lens' DeleteTemplate Text Source #

The ID of the Amazon Web Services account that contains the template that you're deleting.

deleteTemplate_templateId :: Lens' DeleteTemplate Text Source #

An ID for the template you want to delete.

deleteTemplateResponse_arn :: Lens' DeleteTemplateResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource.

deleteTemplateResponse_requestId :: Lens' DeleteTemplateResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

deleteTemplateResponse_templateId :: Lens' DeleteTemplateResponse (Maybe Text) Source #

An ID for the template.

deleteTemplateResponse_status :: Lens' DeleteTemplateResponse Int Source #

The HTTP status of the request.

DeleteTemplateAlias

deleteTemplateAlias_awsAccountId :: Lens' DeleteTemplateAlias Text Source #

The ID of the Amazon Web Services account that contains the item to delete.

deleteTemplateAlias_templateId :: Lens' DeleteTemplateAlias Text Source #

The ID for the template that the specified alias is for.

deleteTemplateAlias_aliasName :: Lens' DeleteTemplateAlias Text Source #

The name for the template alias. To delete a specific alias, you delete the version that the alias points to. You can specify the alias name, or specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter.

deleteTemplateAliasResponse_aliasName :: Lens' DeleteTemplateAliasResponse (Maybe Text) Source #

The name for the template alias.

deleteTemplateAliasResponse_arn :: Lens' DeleteTemplateAliasResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the template you want to delete.

deleteTemplateAliasResponse_requestId :: Lens' DeleteTemplateAliasResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

deleteTemplateAliasResponse_templateId :: Lens' DeleteTemplateAliasResponse (Maybe Text) Source #

An ID for the template associated with the deletion.

deleteTemplateAliasResponse_status :: Lens' DeleteTemplateAliasResponse Int Source #

The HTTP status of the request.

DeleteTheme

deleteTheme_versionNumber :: Lens' DeleteTheme (Maybe Natural) Source #

The version of the theme that you want to delete.

Note: If you don't provide a version number, you're using this call to DeleteTheme to delete all versions of the theme.

deleteTheme_awsAccountId :: Lens' DeleteTheme Text Source #

The ID of the Amazon Web Services account that contains the theme that you're deleting.

deleteTheme_themeId :: Lens' DeleteTheme Text Source #

An ID for the theme that you want to delete.

deleteThemeResponse_arn :: Lens' DeleteThemeResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource.

deleteThemeResponse_requestId :: Lens' DeleteThemeResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

deleteThemeResponse_themeId :: Lens' DeleteThemeResponse (Maybe Text) Source #

An ID for the theme.

deleteThemeResponse_status :: Lens' DeleteThemeResponse Int Source #

The HTTP status of the request.

DeleteThemeAlias

deleteThemeAlias_awsAccountId :: Lens' DeleteThemeAlias Text Source #

The ID of the Amazon Web Services account that contains the theme alias to delete.

deleteThemeAlias_themeId :: Lens' DeleteThemeAlias Text Source #

The ID for the theme that the specified alias is for.

deleteThemeAlias_aliasName :: Lens' DeleteThemeAlias Text Source #

The unique name for the theme alias to delete.

deleteThemeAliasResponse_aliasName :: Lens' DeleteThemeAliasResponse (Maybe Text) Source #

The name for the theme alias.

deleteThemeAliasResponse_arn :: Lens' DeleteThemeAliasResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the theme resource using the deleted alias.

deleteThemeAliasResponse_requestId :: Lens' DeleteThemeAliasResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

deleteThemeAliasResponse_themeId :: Lens' DeleteThemeAliasResponse (Maybe Text) Source #

An ID for the theme associated with the deletion.

deleteThemeAliasResponse_status :: Lens' DeleteThemeAliasResponse Int Source #

The HTTP status of the request.

DeleteUser

deleteUser_userName :: Lens' DeleteUser Text Source #

The name of the user that you want to delete.

deleteUser_awsAccountId :: Lens' DeleteUser Text Source #

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

deleteUser_namespace :: Lens' DeleteUser Text Source #

The namespace. Currently, you should set this to default.

deleteUserResponse_requestId :: Lens' DeleteUserResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

deleteUserResponse_status :: Lens' DeleteUserResponse Int Source #

The HTTP status of the request.

DeleteUserByPrincipalId

deleteUserByPrincipalId_principalId :: Lens' DeleteUserByPrincipalId Text Source #

The principal ID of the user.

deleteUserByPrincipalId_awsAccountId :: Lens' DeleteUserByPrincipalId Text Source #

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

deleteUserByPrincipalId_namespace :: Lens' DeleteUserByPrincipalId Text Source #

The namespace. Currently, you should set this to default.

deleteUserByPrincipalIdResponse_requestId :: Lens' DeleteUserByPrincipalIdResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

deleteUserByPrincipalIdResponse_status :: Lens' DeleteUserByPrincipalIdResponse Int Source #

The HTTP status of the request.

DescribeAccountCustomization

describeAccountCustomization_namespace :: Lens' DescribeAccountCustomization (Maybe Text) Source #

The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations for.

describeAccountCustomization_resolved :: Lens' DescribeAccountCustomization (Maybe Bool) Source #

The Resolved flag works with the other parameters to determine which view of Amazon QuickSight customizations is returned. You can add this flag to your command to use the same view that Amazon QuickSight uses to identify which customizations to apply to the console. Omit this flag, or set it to no-resolved, to reveal customizations that are configured at different levels.

describeAccountCustomization_awsAccountId :: Lens' DescribeAccountCustomization Text Source #

The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations for.

describeAccountCustomizationResponse_accountCustomization :: Lens' DescribeAccountCustomizationResponse (Maybe AccountCustomization) Source #

The Amazon QuickSight customizations that exist in the current Amazon Web Services Region.

describeAccountCustomizationResponse_arn :: Lens' DescribeAccountCustomizationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services account.

describeAccountCustomizationResponse_awsAccountId :: Lens' DescribeAccountCustomizationResponse (Maybe Text) Source #

The ID for the Amazon Web Services account that you're describing.

describeAccountCustomizationResponse_namespace :: Lens' DescribeAccountCustomizationResponse (Maybe Text) Source #

The Amazon QuickSight namespace that you're describing.

describeAccountCustomizationResponse_requestId :: Lens' DescribeAccountCustomizationResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeAccountCustomizationResponse_status :: Lens' DescribeAccountCustomizationResponse Int Source #

The HTTP status of the request.

DescribeAccountSettings

describeAccountSettings_awsAccountId :: Lens' DescribeAccountSettings Text Source #

The ID for the Amazon Web Services account that contains the settings that you want to list.

describeAccountSettingsResponse_accountSettings :: Lens' DescribeAccountSettingsResponse (Maybe AccountSettings) Source #

The Amazon QuickSight settings for this Amazon Web Services account. This information includes the edition of Amazon Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the Amazon QuickSight subscription.

In the QuickSight console, the Amazon QuickSight subscription is sometimes referred to as a QuickSight "account" even though it's technically not an account by itself. Instead, it's a subscription to the Amazon QuickSight service for your Amazon Web Services account. The edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region where you use it.

describeAccountSettingsResponse_requestId :: Lens' DescribeAccountSettingsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeAccountSettingsResponse_status :: Lens' DescribeAccountSettingsResponse Int Source #

The HTTP status of the request.

DescribeAccountSubscription

describeAccountSubscription_awsAccountId :: Lens' DescribeAccountSubscription Text Source #

The Amazon Web Services account ID associated with your Amazon QuickSight account.

describeAccountSubscriptionResponse_accountInfo :: Lens' DescribeAccountSubscriptionResponse (Maybe AccountInfo) Source #

A structure that contains the following elements:

Your Amazon QuickSight account name.
The edition of Amazon QuickSight that your account is using.
The notification email address that is associated with the Amazon QuickSight account.
The authentication type of the Amazon QuickSight account.
The status of the Amazon QuickSight account's subscription.

describeAccountSubscriptionResponse_requestId :: Lens' DescribeAccountSubscriptionResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeAccountSubscriptionResponse_status :: Lens' DescribeAccountSubscriptionResponse Int Source #

The HTTP status of the request.

DescribeAnalysis

describeAnalysis_awsAccountId :: Lens' DescribeAnalysis Text Source #

The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.

describeAnalysis_analysisId :: Lens' DescribeAnalysis Text Source #

The ID of the analysis that you're describing. The ID is part of the URL of the analysis.

describeAnalysisResponse_analysis :: Lens' DescribeAnalysisResponse (Maybe Analysis) Source #

A metadata structure that contains summary information for the analysis that you're describing.

describeAnalysisResponse_requestId :: Lens' DescribeAnalysisResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeAnalysisResponse_status :: Lens' DescribeAnalysisResponse Int Source #

The HTTP status of the request.

DescribeAnalysisDefinition

describeAnalysisDefinition_awsAccountId :: Lens' DescribeAnalysisDefinition Text Source #

The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.

describeAnalysisDefinition_analysisId :: Lens' DescribeAnalysisDefinition Text Source #

The ID of the analysis that you're describing. The ID is part of the URL of the analysis.

describeAnalysisDefinitionResponse_analysisId :: Lens' DescribeAnalysisDefinitionResponse (Maybe Text) Source #

The ID of the analysis described.

describeAnalysisDefinitionResponse_definition :: Lens' DescribeAnalysisDefinitionResponse (Maybe AnalysisDefinition) Source #

The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

describeAnalysisDefinitionResponse_errors :: Lens' DescribeAnalysisDefinitionResponse (Maybe (NonEmpty AnalysisError)) Source #

Errors associated with the analysis.

describeAnalysisDefinitionResponse_name :: Lens' DescribeAnalysisDefinitionResponse (Maybe Text) Source #

The descriptive name of the analysis.

describeAnalysisDefinitionResponse_requestId :: Lens' DescribeAnalysisDefinitionResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeAnalysisDefinitionResponse_resourceStatus :: Lens' DescribeAnalysisDefinitionResponse (Maybe ResourceStatus) Source #

Status associated with the analysis.

```
CREATION_IN_PROGRESS
```
```
CREATION_SUCCESSFUL
```
```
CREATION_FAILED
```
```
UPDATE_IN_PROGRESS
```
```
UPDATE_SUCCESSFUL
```
```
UPDATE_FAILED
```
```
DELETED
```

describeAnalysisDefinitionResponse_themeArn :: Lens' DescribeAnalysisDefinitionResponse (Maybe Text) Source #

The ARN of the theme of the analysis.

describeAnalysisDefinitionResponse_status :: Lens' DescribeAnalysisDefinitionResponse Int Source #

The HTTP status of the request.

DescribeAnalysisPermissions

describeAnalysisPermissions_awsAccountId :: Lens' DescribeAnalysisPermissions Text Source #

The ID of the Amazon Web Services account that contains the analysis whose permissions you're describing. You must be using the Amazon Web Services account that the analysis is in.

describeAnalysisPermissions_analysisId :: Lens' DescribeAnalysisPermissions Text Source #

The ID of the analysis whose permissions you're describing. The ID is part of the analysis URL.

describeAnalysisPermissionsResponse_analysisArn :: Lens' DescribeAnalysisPermissionsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the analysis whose permissions you're describing.

describeAnalysisPermissionsResponse_analysisId :: Lens' DescribeAnalysisPermissionsResponse (Maybe Text) Source #

The ID of the analysis whose permissions you're describing.

describeAnalysisPermissionsResponse_permissions :: Lens' DescribeAnalysisPermissionsResponse (Maybe (NonEmpty ResourcePermission)) Source #

A structure that describes the principals and the resource-level permissions on an analysis.

describeAnalysisPermissionsResponse_requestId :: Lens' DescribeAnalysisPermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeAnalysisPermissionsResponse_status :: Lens' DescribeAnalysisPermissionsResponse Int Source #

The HTTP status of the request.

DescribeDashboard

describeDashboard_aliasName :: Lens' DescribeDashboard (Maybe Text) Source #

The alias name.

describeDashboard_versionNumber :: Lens' DescribeDashboard (Maybe Natural) Source #

The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.

describeDashboard_awsAccountId :: Lens' DescribeDashboard Text Source #

The ID of the Amazon Web Services account that contains the dashboard that you're describing.

describeDashboard_dashboardId :: Lens' DescribeDashboard Text Source #

The ID for the dashboard.

describeDashboardResponse_dashboard :: Lens' DescribeDashboardResponse (Maybe Dashboard) Source #

Information about the dashboard.

describeDashboardResponse_requestId :: Lens' DescribeDashboardResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeDashboardResponse_status :: Lens' DescribeDashboardResponse Int Source #

The HTTP status of this request.

DescribeDashboardDefinition

describeDashboardDefinition_aliasName :: Lens' DescribeDashboardDefinition (Maybe Text) Source #

The alias name.

describeDashboardDefinition_versionNumber :: Lens' DescribeDashboardDefinition (Maybe Natural) Source #

The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.

describeDashboardDefinition_awsAccountId :: Lens' DescribeDashboardDefinition Text Source #

The ID of the Amazon Web Services account that contains the dashboard that you're describing.

describeDashboardDefinition_dashboardId :: Lens' DescribeDashboardDefinition Text Source #

The ID for the dashboard.

describeDashboardDefinitionResponse_dashboardId :: Lens' DescribeDashboardDefinitionResponse (Maybe Text) Source #

The ID of the dashboard described.

describeDashboardDefinitionResponse_definition :: Lens' DescribeDashboardDefinitionResponse (Maybe DashboardVersionDefinition) Source #

The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

describeDashboardDefinitionResponse_errors :: Lens' DescribeDashboardDefinitionResponse (Maybe (NonEmpty DashboardError)) Source #

Errors associated with this dashboard version.

describeDashboardDefinitionResponse_name :: Lens' DescribeDashboardDefinitionResponse (Maybe Text) Source #

The display name of the dashboard.

describeDashboardDefinitionResponse_requestId :: Lens' DescribeDashboardDefinitionResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeDashboardDefinitionResponse_resourceStatus :: Lens' DescribeDashboardDefinitionResponse (Maybe ResourceStatus) Source #

Status associated with the dashboard version.

```
CREATION_IN_PROGRESS
```
```
CREATION_SUCCESSFUL
```
```
CREATION_FAILED
```
```
UPDATE_IN_PROGRESS
```
```
UPDATE_SUCCESSFUL
```
```
UPDATE_FAILED
```
```
DELETED
```

describeDashboardDefinitionResponse_themeArn :: Lens' DescribeDashboardDefinitionResponse (Maybe Text) Source #

The ARN of the theme of the dashboard.

describeDashboardDefinitionResponse_status :: Lens' DescribeDashboardDefinitionResponse Int Source #

The HTTP status of the request.

DescribeDashboardPermissions

describeDashboardPermissions_awsAccountId :: Lens' DescribeDashboardPermissions Text Source #

The ID of the Amazon Web Services account that contains the dashboard that you're describing permissions for.

describeDashboardPermissions_dashboardId :: Lens' DescribeDashboardPermissions Text Source #

The ID for the dashboard, also added to the IAM policy.

describeDashboardPermissionsResponse_dashboardArn :: Lens' DescribeDashboardPermissionsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dashboard.

describeDashboardPermissionsResponse_dashboardId :: Lens' DescribeDashboardPermissionsResponse (Maybe Text) Source #

The ID for the dashboard.

describeDashboardPermissionsResponse_linkSharingConfiguration :: Lens' DescribeDashboardPermissionsResponse (Maybe LinkSharingConfiguration) Source #

A structure that contains the configuration of a shareable link that grants access to the dashboard. Your users can use the link to view and interact with the dashboard, if the dashboard has been shared with them. For more information about sharing dashboards, see Sharing Dashboards.

describeDashboardPermissionsResponse_permissions :: Lens' DescribeDashboardPermissionsResponse (Maybe (NonEmpty ResourcePermission)) Source #

A structure that contains the permissions for the dashboard.

describeDashboardPermissionsResponse_requestId :: Lens' DescribeDashboardPermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeDashboardPermissionsResponse_status :: Lens' DescribeDashboardPermissionsResponse Int Source #

The HTTP status of the request.

DescribeDataSet

describeDataSet_awsAccountId :: Lens' DescribeDataSet Text Source #

The Amazon Web Services account ID.

describeDataSet_dataSetId :: Lens' DescribeDataSet Text Source #

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

describeDataSetResponse_dataSet :: Lens' DescribeDataSetResponse (Maybe DataSet) Source #

Information on the dataset.

describeDataSetResponse_requestId :: Lens' DescribeDataSetResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeDataSetResponse_status :: Lens' DescribeDataSetResponse Int Source #

The HTTP status of the request.

DescribeDataSetPermissions

describeDataSetPermissions_awsAccountId :: Lens' DescribeDataSetPermissions Text Source #

The Amazon Web Services account ID.

describeDataSetPermissions_dataSetId :: Lens' DescribeDataSetPermissions Text Source #

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

describeDataSetPermissionsResponse_dataSetArn :: Lens' DescribeDataSetPermissionsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset.

describeDataSetPermissionsResponse_dataSetId :: Lens' DescribeDataSetPermissionsResponse (Maybe Text) Source #

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

describeDataSetPermissionsResponse_permissions :: Lens' DescribeDataSetPermissionsResponse (Maybe (NonEmpty ResourcePermission)) Source #

A list of resource permissions on the dataset.

describeDataSetPermissionsResponse_requestId :: Lens' DescribeDataSetPermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeDataSetPermissionsResponse_status :: Lens' DescribeDataSetPermissionsResponse Int Source #

The HTTP status of the request.

DescribeDataSource

describeDataSource_awsAccountId :: Lens' DescribeDataSource Text Source #

The Amazon Web Services account ID.

describeDataSource_dataSourceId :: Lens' DescribeDataSource Text Source #

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

describeDataSourceResponse_dataSource :: Lens' DescribeDataSourceResponse (Maybe DataSource) Source #

The information on the data source.

describeDataSourceResponse_requestId :: Lens' DescribeDataSourceResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeDataSourceResponse_status :: Lens' DescribeDataSourceResponse Int Source #

The HTTP status of the request.

DescribeDataSourcePermissions

describeDataSourcePermissions_awsAccountId :: Lens' DescribeDataSourcePermissions Text Source #

The Amazon Web Services account ID.

describeDataSourcePermissions_dataSourceId :: Lens' DescribeDataSourcePermissions Text Source #

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

describeDataSourcePermissionsResponse_dataSourceArn :: Lens' DescribeDataSourcePermissionsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the data source.

describeDataSourcePermissionsResponse_dataSourceId :: Lens' DescribeDataSourcePermissionsResponse (Maybe Text) Source #

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

describeDataSourcePermissionsResponse_permissions :: Lens' DescribeDataSourcePermissionsResponse (Maybe (NonEmpty ResourcePermission)) Source #

A list of resource permissions on the data source.

describeDataSourcePermissionsResponse_requestId :: Lens' DescribeDataSourcePermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeDataSourcePermissionsResponse_status :: Lens' DescribeDataSourcePermissionsResponse Int Source #

The HTTP status of the request.

DescribeFolder

describeFolder_awsAccountId :: Lens' DescribeFolder Text Source #

The ID for the Amazon Web Services account that contains the folder.

describeFolder_folderId :: Lens' DescribeFolder Text Source #

The ID of the folder.

describeFolderResponse_folder :: Lens' DescribeFolderResponse (Maybe Folder) Source #

Information about the folder.

describeFolderResponse_requestId :: Lens' DescribeFolderResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeFolderResponse_status :: Lens' DescribeFolderResponse Int Source #

The HTTP status of the request.

DescribeFolderPermissions

describeFolderPermissions_awsAccountId :: Lens' DescribeFolderPermissions Text Source #

The ID for the Amazon Web Services account that contains the folder.

describeFolderPermissions_folderId :: Lens' DescribeFolderPermissions Text Source #

The ID of the folder.

describeFolderPermissionsResponse_arn :: Lens' DescribeFolderPermissionsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the folder.

describeFolderPermissionsResponse_folderId :: Lens' DescribeFolderPermissionsResponse (Maybe Text) Source #

The ID of the folder.

describeFolderPermissionsResponse_permissions :: Lens' DescribeFolderPermissionsResponse (Maybe (NonEmpty ResourcePermission)) Source #

Information about the permissions on the folder.

describeFolderPermissionsResponse_requestId :: Lens' DescribeFolderPermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeFolderPermissionsResponse_status :: Lens' DescribeFolderPermissionsResponse Int Source #

The HTTP status of the request.

DescribeFolderResolvedPermissions

describeFolderResolvedPermissions_awsAccountId :: Lens' DescribeFolderResolvedPermissions Text Source #

The ID for the Amazon Web Services account that contains the folder.

describeFolderResolvedPermissions_folderId :: Lens' DescribeFolderResolvedPermissions Text Source #

The ID of the folder.

describeFolderResolvedPermissionsResponse_arn :: Lens' DescribeFolderResolvedPermissionsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the folder.

describeFolderResolvedPermissionsResponse_folderId :: Lens' DescribeFolderResolvedPermissionsResponse (Maybe Text) Source #

The ID of the folder.

describeFolderResolvedPermissionsResponse_permissions :: Lens' DescribeFolderResolvedPermissionsResponse (Maybe (NonEmpty ResourcePermission)) Source #

Information about the permissions for the folder.

describeFolderResolvedPermissionsResponse_requestId :: Lens' DescribeFolderResolvedPermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeFolderResolvedPermissionsResponse_status :: Lens' DescribeFolderResolvedPermissionsResponse Int Source #

The HTTP status of the request.

DescribeGroup

describeGroup_groupName :: Lens' DescribeGroup Text Source #

The name of the group that you want to describe.

describeGroup_awsAccountId :: Lens' DescribeGroup Text Source #

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

describeGroup_namespace :: Lens' DescribeGroup Text Source #

The namespace of the group that you want described.

describeGroupResponse_group :: Lens' DescribeGroupResponse (Maybe Group) Source #

The name of the group.

describeGroupResponse_requestId :: Lens' DescribeGroupResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeGroupResponse_status :: Lens' DescribeGroupResponse Int Source #

The HTTP status of the request.

DescribeGroupMembership

describeGroupMembership_memberName :: Lens' DescribeGroupMembership Text Source #

The user name of the user that you want to search for.

describeGroupMembership_groupName :: Lens' DescribeGroupMembership Text Source #

The name of the group that you want to search.

describeGroupMembership_awsAccountId :: Lens' DescribeGroupMembership Text Source #

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

describeGroupMembership_namespace :: Lens' DescribeGroupMembership Text Source #

The namespace that includes the group you are searching within.

describeGroupMembershipResponse_groupMember :: Lens' DescribeGroupMembershipResponse (Maybe GroupMember) Source #

Undocumented member.

describeGroupMembershipResponse_requestId :: Lens' DescribeGroupMembershipResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeGroupMembershipResponse_status :: Lens' DescribeGroupMembershipResponse Int Source #

The HTTP status of the request.

DescribeIAMPolicyAssignment

describeIAMPolicyAssignment_awsAccountId :: Lens' DescribeIAMPolicyAssignment Text Source #

The ID of the Amazon Web Services account that contains the assignment that you want to describe.

describeIAMPolicyAssignment_assignmentName :: Lens' DescribeIAMPolicyAssignment Text Source #

The name of the assignment, also called a rule.

describeIAMPolicyAssignment_namespace :: Lens' DescribeIAMPolicyAssignment Text Source #

The namespace that contains the assignment.

describeIAMPolicyAssignmentResponse_iAMPolicyAssignment :: Lens' DescribeIAMPolicyAssignmentResponse (Maybe IAMPolicyAssignment) Source #

Information describing the IAM policy assignment.

describeIAMPolicyAssignmentResponse_requestId :: Lens' DescribeIAMPolicyAssignmentResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeIAMPolicyAssignmentResponse_status :: Lens' DescribeIAMPolicyAssignmentResponse Int Source #

The HTTP status of the request.

DescribeIngestion

describeIngestion_awsAccountId :: Lens' DescribeIngestion Text Source #

The Amazon Web Services account ID.

describeIngestion_dataSetId :: Lens' DescribeIngestion Text Source #

The ID of the dataset used in the ingestion.

describeIngestion_ingestionId :: Lens' DescribeIngestion Text Source #

An ID for the ingestion.

describeIngestionResponse_ingestion :: Lens' DescribeIngestionResponse (Maybe Ingestion) Source #

Information about the ingestion.

describeIngestionResponse_requestId :: Lens' DescribeIngestionResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeIngestionResponse_status :: Lens' DescribeIngestionResponse Int Source #

The HTTP status of the request.

DescribeIpRestriction

describeIpRestriction_awsAccountId :: Lens' DescribeIpRestriction Text Source #

The ID of the Amazon Web Services account that contains the IP rules.

describeIpRestrictionResponse_awsAccountId :: Lens' DescribeIpRestrictionResponse (Maybe Text) Source #

The ID of the Amazon Web Services account that contains the IP rules.

describeIpRestrictionResponse_enabled :: Lens' DescribeIpRestrictionResponse (Maybe Bool) Source #

A value that specifies whether IP rules are turned on.

describeIpRestrictionResponse_ipRestrictionRuleMap :: Lens' DescribeIpRestrictionResponse (Maybe (HashMap Text Text)) Source #

A map that describes the IP rules with CIDR range and description.

describeIpRestrictionResponse_requestId :: Lens' DescribeIpRestrictionResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeIpRestrictionResponse_status :: Lens' DescribeIpRestrictionResponse Int Source #

The HTTP status of the request.

DescribeNamespace

describeNamespace_awsAccountId :: Lens' DescribeNamespace Text Source #

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.

describeNamespace_namespace :: Lens' DescribeNamespace Text Source #

The namespace that you want to describe.

describeNamespaceResponse_namespace :: Lens' DescribeNamespaceResponse (Maybe NamespaceInfoV2) Source #

The information about the namespace that you're describing. The response includes the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. DescribeNamespace also works for namespaces that are in the process of being created. For incomplete namespaces, this API operation lists the namespace error types and messages associated with the creation process.

describeNamespaceResponse_requestId :: Lens' DescribeNamespaceResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeNamespaceResponse_status :: Lens' DescribeNamespaceResponse Int Source #

The HTTP status of the request.

DescribeTemplate

describeTemplate_aliasName :: Lens' DescribeTemplate (Maybe Text) Source #

The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.

describeTemplate_versionNumber :: Lens' DescribeTemplate (Maybe Natural) Source #

(Optional) The number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the template is described.

describeTemplate_awsAccountId :: Lens' DescribeTemplate Text Source #

The ID of the Amazon Web Services account that contains the template that you're describing.

describeTemplate_templateId :: Lens' DescribeTemplate Text Source #

The ID for the template.

describeTemplateResponse_requestId :: Lens' DescribeTemplateResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeTemplateResponse_template :: Lens' DescribeTemplateResponse (Maybe Template) Source #

The template structure for the object you want to describe.

describeTemplateResponse_status :: Lens' DescribeTemplateResponse Int Source #

The HTTP status of the request.

DescribeTemplateAlias

describeTemplateAlias_awsAccountId :: Lens' DescribeTemplateAlias Text Source #

The ID of the Amazon Web Services account that contains the template alias that you're describing.

describeTemplateAlias_templateId :: Lens' DescribeTemplateAlias Text Source #

The ID for the template.

describeTemplateAlias_aliasName :: Lens' DescribeTemplateAlias Text Source #

The name of the template alias that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.

describeTemplateAliasResponse_requestId :: Lens' DescribeTemplateAliasResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeTemplateAliasResponse_templateAlias :: Lens' DescribeTemplateAliasResponse (Maybe TemplateAlias) Source #

Information about the template alias.

describeTemplateAliasResponse_status :: Lens' DescribeTemplateAliasResponse Int Source #

The HTTP status of the request.

DescribeTemplateDefinition

describeTemplateDefinition_aliasName :: Lens' DescribeTemplateDefinition (Maybe Text) Source #

The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.

describeTemplateDefinition_versionNumber :: Lens' DescribeTemplateDefinition (Maybe Natural) Source #

The version number of the template.

describeTemplateDefinition_awsAccountId :: Lens' DescribeTemplateDefinition Text Source #

The ID of the Amazon Web Services account that contains the template. You must be using the Amazon Web Services account that the template is in.

describeTemplateDefinition_templateId :: Lens' DescribeTemplateDefinition Text Source #

The ID of the template that you're describing.

describeTemplateDefinitionResponse_definition :: Lens' DescribeTemplateDefinitionResponse (Maybe TemplateVersionDefinition) Source #

The definition of the template.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

describeTemplateDefinitionResponse_errors :: Lens' DescribeTemplateDefinitionResponse (Maybe (NonEmpty TemplateError)) Source #

Errors associated with the template version.

describeTemplateDefinitionResponse_name :: Lens' DescribeTemplateDefinitionResponse (Maybe Text) Source #

The descriptive name of the template.

describeTemplateDefinitionResponse_requestId :: Lens' DescribeTemplateDefinitionResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeTemplateDefinitionResponse_resourceStatus :: Lens' DescribeTemplateDefinitionResponse (Maybe ResourceStatus) Source #

Status associated with the template.

```
CREATION_IN_PROGRESS
```
```
CREATION_SUCCESSFUL
```
```
CREATION_FAILED
```
```
UPDATE_IN_PROGRESS
```
```
UPDATE_SUCCESSFUL
```
```
UPDATE_FAILED
```
```
DELETED
```

describeTemplateDefinitionResponse_templateId :: Lens' DescribeTemplateDefinitionResponse (Maybe Text) Source #

The ID of the template described.

describeTemplateDefinitionResponse_themeArn :: Lens' DescribeTemplateDefinitionResponse (Maybe Text) Source #

The ARN of the theme of the template.

describeTemplateDefinitionResponse_status :: Lens' DescribeTemplateDefinitionResponse Int Source #

The HTTP status of the request.

DescribeTemplatePermissions

describeTemplatePermissions_awsAccountId :: Lens' DescribeTemplatePermissions Text Source #

The ID of the Amazon Web Services account that contains the template that you're describing.

describeTemplatePermissions_templateId :: Lens' DescribeTemplatePermissions Text Source #

The ID for the template.

describeTemplatePermissionsResponse_permissions :: Lens' DescribeTemplatePermissionsResponse (Maybe (NonEmpty ResourcePermission)) Source #

A list of resource permissions to be set on the template.

describeTemplatePermissionsResponse_requestId :: Lens' DescribeTemplatePermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeTemplatePermissionsResponse_templateArn :: Lens' DescribeTemplatePermissionsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the template.

describeTemplatePermissionsResponse_templateId :: Lens' DescribeTemplatePermissionsResponse (Maybe Text) Source #

The ID for the template.

describeTemplatePermissionsResponse_status :: Lens' DescribeTemplatePermissionsResponse Int Source #

The HTTP status of the request.

DescribeTheme

describeTheme_aliasName :: Lens' DescribeTheme (Maybe Text) Source #

The alias of the theme that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the theme by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to themes.

describeTheme_versionNumber :: Lens' DescribeTheme (Maybe Natural) Source #

The version number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the theme is described.

describeTheme_awsAccountId :: Lens' DescribeTheme Text Source #

The ID of the Amazon Web Services account that contains the theme that you're describing.

describeTheme_themeId :: Lens' DescribeTheme Text Source #

The ID for the theme.

describeThemeResponse_requestId :: Lens' DescribeThemeResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeThemeResponse_theme :: Lens' DescribeThemeResponse (Maybe Theme) Source #

The information about the theme that you are describing.

describeThemeResponse_status :: Lens' DescribeThemeResponse Int Source #

The HTTP status of the request.

DescribeThemeAlias

describeThemeAlias_awsAccountId :: Lens' DescribeThemeAlias Text Source #

The ID of the Amazon Web Services account that contains the theme alias that you're describing.

describeThemeAlias_themeId :: Lens' DescribeThemeAlias Text Source #

The ID for the theme.

describeThemeAlias_aliasName :: Lens' DescribeThemeAlias Text Source #

The name of the theme alias that you want to describe.

describeThemeAliasResponse_requestId :: Lens' DescribeThemeAliasResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeThemeAliasResponse_themeAlias :: Lens' DescribeThemeAliasResponse (Maybe ThemeAlias) Source #

Information about the theme alias.

describeThemeAliasResponse_status :: Lens' DescribeThemeAliasResponse Int Source #

The HTTP status of the request.

DescribeThemePermissions

describeThemePermissions_awsAccountId :: Lens' DescribeThemePermissions Text Source #

The ID of the Amazon Web Services account that contains the theme that you're describing.

describeThemePermissions_themeId :: Lens' DescribeThemePermissions Text Source #

The ID for the theme that you want to describe permissions for.

describeThemePermissionsResponse_permissions :: Lens' DescribeThemePermissionsResponse (Maybe (NonEmpty ResourcePermission)) Source #

A list of resource permissions set on the theme.

describeThemePermissionsResponse_requestId :: Lens' DescribeThemePermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeThemePermissionsResponse_themeArn :: Lens' DescribeThemePermissionsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the theme.

describeThemePermissionsResponse_themeId :: Lens' DescribeThemePermissionsResponse (Maybe Text) Source #

The ID for the theme.

describeThemePermissionsResponse_status :: Lens' DescribeThemePermissionsResponse Int Source #

The HTTP status of the request.

DescribeUser

describeUser_userName :: Lens' DescribeUser Text Source #

The name of the user that you want to describe.

describeUser_awsAccountId :: Lens' DescribeUser Text Source #

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

describeUser_namespace :: Lens' DescribeUser Text Source #

The namespace. Currently, you should set this to default.

describeUserResponse_requestId :: Lens' DescribeUserResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeUserResponse_user :: Lens' DescribeUserResponse (Maybe User) Source #

The user name.

describeUserResponse_status :: Lens' DescribeUserResponse Int Source #

The HTTP status of the request.

GenerateEmbedUrlForAnonymousUser

generateEmbedUrlForAnonymousUser_allowedDomains :: Lens' GenerateEmbedUrlForAnonymousUser (Maybe [Text]) Source #

The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

generateEmbedUrlForAnonymousUser_sessionLifetimeInMinutes :: Lens' GenerateEmbedUrlForAnonymousUser (Maybe Natural) Source #

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

generateEmbedUrlForAnonymousUser_sessionTags :: Lens' GenerateEmbedUrlForAnonymousUser (Maybe (NonEmpty SessionTag)) Source #

The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.

generateEmbedUrlForAnonymousUser_awsAccountId :: Lens' GenerateEmbedUrlForAnonymousUser Text Source #

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

generateEmbedUrlForAnonymousUser_namespace :: Lens' GenerateEmbedUrlForAnonymousUser Text Source #

The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.

generateEmbedUrlForAnonymousUser_authorizedResourceArns :: Lens' GenerateEmbedUrlForAnonymousUser [Text] Source #

The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session. If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view. Currently, you can pass up to 25 dashboard ARNs in each API call.

generateEmbedUrlForAnonymousUser_experienceConfiguration :: Lens' GenerateEmbedUrlForAnonymousUser AnonymousUserEmbeddingExperienceConfiguration Source #

The configuration of the experience that you are embedding.

generateEmbedUrlForAnonymousUserResponse_status :: Lens' GenerateEmbedUrlForAnonymousUserResponse Int Source #

The HTTP status of the request.

generateEmbedUrlForAnonymousUserResponse_embedUrl :: Lens' GenerateEmbedUrlForAnonymousUserResponse Text Source #

The embed URL for the dashboard.

generateEmbedUrlForAnonymousUserResponse_requestId :: Lens' GenerateEmbedUrlForAnonymousUserResponse Text Source #

The Amazon Web Services request ID for this operation.

generateEmbedUrlForAnonymousUserResponse_anonymousUserArn :: Lens' GenerateEmbedUrlForAnonymousUserResponse Text Source #

The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.

GenerateEmbedUrlForRegisteredUser

generateEmbedUrlForRegisteredUser_allowedDomains :: Lens' GenerateEmbedUrlForRegisteredUser (Maybe [Text]) Source #

The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

generateEmbedUrlForRegisteredUser_sessionLifetimeInMinutes :: Lens' GenerateEmbedUrlForRegisteredUser (Maybe Natural) Source #

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

generateEmbedUrlForRegisteredUser_awsAccountId :: Lens' GenerateEmbedUrlForRegisteredUser Text Source #

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

generateEmbedUrlForRegisteredUser_userArn :: Lens' GenerateEmbedUrlForRegisteredUser Text Source #

The Amazon Resource Name for the registered user.

generateEmbedUrlForRegisteredUser_experienceConfiguration :: Lens' GenerateEmbedUrlForRegisteredUser RegisteredUserEmbeddingExperienceConfiguration Source #

The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, or the entire Amazon QuickSight console.

generateEmbedUrlForRegisteredUserResponse_status :: Lens' GenerateEmbedUrlForRegisteredUserResponse Int Source #

The HTTP status of the request.

generateEmbedUrlForRegisteredUserResponse_embedUrl :: Lens' GenerateEmbedUrlForRegisteredUserResponse Text Source #

The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, or console.

generateEmbedUrlForRegisteredUserResponse_requestId :: Lens' GenerateEmbedUrlForRegisteredUserResponse Text Source #

The Amazon Web Services request ID for this operation.

GetDashboardEmbedUrl

getDashboardEmbedUrl_additionalDashboardIds :: Lens' GetDashboardEmbedUrl (Maybe (NonEmpty Text)) Source #

A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set "--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.

getDashboardEmbedUrl_namespace :: Lens' GetDashboardEmbedUrl (Maybe Text) Source #

The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set Namespace = default.

getDashboardEmbedUrl_resetDisabled :: Lens' GetDashboardEmbedUrl (Maybe Bool) Source #

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

getDashboardEmbedUrl_sessionLifetimeInMinutes :: Lens' GetDashboardEmbedUrl (Maybe Natural) Source #

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

getDashboardEmbedUrl_statePersistenceEnabled :: Lens' GetDashboardEmbedUrl (Maybe Bool) Source #

Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.

getDashboardEmbedUrl_undoRedoDisabled :: Lens' GetDashboardEmbedUrl (Maybe Bool) Source #

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

getDashboardEmbedUrl_userArn :: Lens' GetDashboardEmbedUrl (Maybe Text) Source #

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:

Active Directory (AD) users or group members
Invited nonfederated users
IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.

Omit this parameter for users in the third group – IAM users and IAM role-based sessions.

getDashboardEmbedUrl_awsAccountId :: Lens' GetDashboardEmbedUrl Text Source #

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

getDashboardEmbedUrl_dashboardId :: Lens' GetDashboardEmbedUrl Text Source #

The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.

getDashboardEmbedUrl_identityType :: Lens' GetDashboardEmbedUrl EmbeddingIdentityType Source #

The authentication method that the user uses to sign in.

getDashboardEmbedUrlResponse_embedUrl :: Lens' GetDashboardEmbedUrlResponse (Maybe Text) Source #

A single-use URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes. The API operation provides the URL with an auth_code value that enables one (and only one) sign-on to a user session that is valid for 10 hours.

getDashboardEmbedUrlResponse_requestId :: Lens' GetDashboardEmbedUrlResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

getDashboardEmbedUrlResponse_status :: Lens' GetDashboardEmbedUrlResponse Int Source #

The HTTP status of the request.

GetSessionEmbedUrl

getSessionEmbedUrl_entryPoint :: Lens' GetSessionEmbedUrl (Maybe Text) Source #

The URL you use to access the embedded session. The entry point URL is constrained to the following paths:

```
/start
```
```
/start/analyses
```
```
/start/dashboards
```
```
/start/favorites
```
/dashboards/DashboardId - where DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard
/analyses/AnalysisId - where AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis

getSessionEmbedUrl_sessionLifetimeInMinutes :: Lens' GetSessionEmbedUrl (Maybe Natural) Source #

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

getSessionEmbedUrl_userArn :: Lens' GetSessionEmbedUrl (Maybe Text) Source #

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They need to be authenticated as one of the following:

Active Directory (AD) users or group members
Invited nonfederated users
Identity and Access Management (IAM) users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation

Omit this parameter for users in the third group, IAM users and IAM role-based sessions.

getSessionEmbedUrl_awsAccountId :: Lens' GetSessionEmbedUrl Text Source #

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

getSessionEmbedUrlResponse_embedUrl :: Lens' GetSessionEmbedUrlResponse (Maybe Text) Source #

A single-use URL that you can put into your server-side web page to embed your Amazon QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an auth_code value that enables one (and only one) sign-on to a user session that is valid for 10 hours.

getSessionEmbedUrlResponse_requestId :: Lens' GetSessionEmbedUrlResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

getSessionEmbedUrlResponse_status :: Lens' GetSessionEmbedUrlResponse Int Source #

The HTTP status of the request.

ListAnalyses

listAnalyses_maxResults :: Lens' ListAnalyses (Maybe Natural) Source #

The maximum number of results to return.

listAnalyses_nextToken :: Lens' ListAnalyses (Maybe Text) Source #

A pagination token that can be used in a subsequent request.

listAnalyses_awsAccountId :: Lens' ListAnalyses Text Source #

The ID of the Amazon Web Services account that contains the analyses.

listAnalysesResponse_analysisSummaryList :: Lens' ListAnalysesResponse (Maybe [AnalysisSummary]) Source #

Metadata describing each of the analyses that are listed.

listAnalysesResponse_nextToken :: Lens' ListAnalysesResponse (Maybe Text) Source #

A pagination token that can be used in a subsequent request.

listAnalysesResponse_requestId :: Lens' ListAnalysesResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listAnalysesResponse_status :: Lens' ListAnalysesResponse Int Source #

The HTTP status of the request.

ListDashboardVersions

listDashboardVersions_maxResults :: Lens' ListDashboardVersions (Maybe Natural) Source #

The maximum number of results to be returned per request.

listDashboardVersions_nextToken :: Lens' ListDashboardVersions (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listDashboardVersions_awsAccountId :: Lens' ListDashboardVersions Text Source #

The ID of the Amazon Web Services account that contains the dashboard that you're listing versions for.

listDashboardVersions_dashboardId :: Lens' ListDashboardVersions Text Source #

The ID for the dashboard.

listDashboardVersionsResponse_dashboardVersionSummaryList :: Lens' ListDashboardVersionsResponse (Maybe [DashboardVersionSummary]) Source #

A structure that contains information about each version of the dashboard.

listDashboardVersionsResponse_nextToken :: Lens' ListDashboardVersionsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listDashboardVersionsResponse_requestId :: Lens' ListDashboardVersionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listDashboardVersionsResponse_status :: Lens' ListDashboardVersionsResponse Int Source #

The HTTP status of the request.

ListDashboards

listDashboards_maxResults :: Lens' ListDashboards (Maybe Natural) Source #

The maximum number of results to be returned per request.

listDashboards_nextToken :: Lens' ListDashboards (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listDashboards_awsAccountId :: Lens' ListDashboards Text Source #

The ID of the Amazon Web Services account that contains the dashboards that you're listing.

listDashboardsResponse_dashboardSummaryList :: Lens' ListDashboardsResponse (Maybe [DashboardSummary]) Source #

A structure that contains all of the dashboards in your Amazon Web Services account. This structure provides basic information about the dashboards.

listDashboardsResponse_nextToken :: Lens' ListDashboardsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listDashboardsResponse_requestId :: Lens' ListDashboardsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listDashboardsResponse_status :: Lens' ListDashboardsResponse Int Source #

The HTTP status of the request.

ListDataSets

listDataSets_maxResults :: Lens' ListDataSets (Maybe Natural) Source #

The maximum number of results to be returned per request.

listDataSets_nextToken :: Lens' ListDataSets (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listDataSets_awsAccountId :: Lens' ListDataSets Text Source #

The Amazon Web Services account ID.

listDataSetsResponse_dataSetSummaries :: Lens' ListDataSetsResponse (Maybe [DataSetSummary]) Source #

The list of dataset summaries.

listDataSetsResponse_nextToken :: Lens' ListDataSetsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listDataSetsResponse_requestId :: Lens' ListDataSetsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listDataSetsResponse_status :: Lens' ListDataSetsResponse Int Source #

The HTTP status of the request.

ListDataSources

listDataSources_maxResults :: Lens' ListDataSources (Maybe Natural) Source #

The maximum number of results to be returned per request.

listDataSources_nextToken :: Lens' ListDataSources (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listDataSources_awsAccountId :: Lens' ListDataSources Text Source #

The Amazon Web Services account ID.

listDataSourcesResponse_dataSources :: Lens' ListDataSourcesResponse (Maybe [DataSource]) Source #

A list of data sources.

listDataSourcesResponse_nextToken :: Lens' ListDataSourcesResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listDataSourcesResponse_requestId :: Lens' ListDataSourcesResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listDataSourcesResponse_status :: Lens' ListDataSourcesResponse Int Source #

The HTTP status of the request.

ListFolderMembers

listFolderMembers_maxResults :: Lens' ListFolderMembers (Maybe Natural) Source #

The maximum number of results to be returned per request.

listFolderMembers_nextToken :: Lens' ListFolderMembers (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listFolderMembers_awsAccountId :: Lens' ListFolderMembers Text Source #

The ID for the Amazon Web Services account that contains the folder.

listFolderMembers_folderId :: Lens' ListFolderMembers Text Source #

The ID of the folder.

listFolderMembersResponse_folderMemberList :: Lens' ListFolderMembersResponse (Maybe [MemberIdArnPair]) Source #

A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.

listFolderMembersResponse_nextToken :: Lens' ListFolderMembersResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listFolderMembersResponse_requestId :: Lens' ListFolderMembersResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listFolderMembersResponse_status :: Lens' ListFolderMembersResponse Int Source #

The HTTP status of the request.

ListFolders

listFolders_maxResults :: Lens' ListFolders (Maybe Natural) Source #

The maximum number of results to be returned per request.

listFolders_nextToken :: Lens' ListFolders (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listFolders_awsAccountId :: Lens' ListFolders Text Source #

The ID for the Amazon Web Services account that contains the folder.

listFoldersResponse_folderSummaryList :: Lens' ListFoldersResponse (Maybe [FolderSummary]) Source #

A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

listFoldersResponse_nextToken :: Lens' ListFoldersResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listFoldersResponse_requestId :: Lens' ListFoldersResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listFoldersResponse_status :: Lens' ListFoldersResponse Int Source #

The HTTP status of the request.

ListGroupMemberships

listGroupMemberships_maxResults :: Lens' ListGroupMemberships (Maybe Natural) Source #

The maximum number of results to return from this request.

listGroupMemberships_nextToken :: Lens' ListGroupMemberships (Maybe Text) Source #

A pagination token that can be used in a subsequent request.

listGroupMemberships_groupName :: Lens' ListGroupMemberships Text Source #

The name of the group that you want to see a membership list of.

listGroupMemberships_awsAccountId :: Lens' ListGroupMemberships Text Source #

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

listGroupMemberships_namespace :: Lens' ListGroupMemberships Text Source #

The namespace of the group that you want a list of users from.

listGroupMembershipsResponse_groupMemberList :: Lens' ListGroupMembershipsResponse (Maybe [GroupMember]) Source #

The list of the members of the group.

listGroupMembershipsResponse_nextToken :: Lens' ListGroupMembershipsResponse (Maybe Text) Source #

A pagination token that can be used in a subsequent request.

listGroupMembershipsResponse_requestId :: Lens' ListGroupMembershipsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listGroupMembershipsResponse_status :: Lens' ListGroupMembershipsResponse Int Source #

The HTTP status of the request.

ListGroups

listGroups_maxResults :: Lens' ListGroups (Maybe Natural) Source #

The maximum number of results to return.

listGroups_nextToken :: Lens' ListGroups (Maybe Text) Source #

A pagination token that can be used in a subsequent request.

listGroups_awsAccountId :: Lens' ListGroups Text Source #

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

listGroups_namespace :: Lens' ListGroups Text Source #

The namespace that you want a list of groups from.

listGroupsResponse_groupList :: Lens' ListGroupsResponse (Maybe [Group]) Source #

The list of the groups.

listGroupsResponse_nextToken :: Lens' ListGroupsResponse (Maybe Text) Source #

A pagination token that can be used in a subsequent request.

listGroupsResponse_requestId :: Lens' ListGroupsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listGroupsResponse_status :: Lens' ListGroupsResponse Int Source #

The HTTP status of the request.

ListIAMPolicyAssignments

listIAMPolicyAssignments_assignmentStatus :: Lens' ListIAMPolicyAssignments (Maybe AssignmentStatus) Source #

The status of the assignments.

listIAMPolicyAssignments_maxResults :: Lens' ListIAMPolicyAssignments (Maybe Natural) Source #

The maximum number of results to be returned per request.

listIAMPolicyAssignments_nextToken :: Lens' ListIAMPolicyAssignments (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listIAMPolicyAssignments_awsAccountId :: Lens' ListIAMPolicyAssignments Text Source #

The ID of the Amazon Web Services account that contains these IAM policy assignments.

listIAMPolicyAssignments_namespace :: Lens' ListIAMPolicyAssignments Text Source #

The namespace for the assignments.

listIAMPolicyAssignmentsResponse_iAMPolicyAssignments :: Lens' ListIAMPolicyAssignmentsResponse (Maybe [IAMPolicyAssignmentSummary]) Source #

Information describing the IAM policy assignments.

listIAMPolicyAssignmentsResponse_nextToken :: Lens' ListIAMPolicyAssignmentsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listIAMPolicyAssignmentsResponse_requestId :: Lens' ListIAMPolicyAssignmentsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listIAMPolicyAssignmentsResponse_status :: Lens' ListIAMPolicyAssignmentsResponse Int Source #

The HTTP status of the request.

ListIAMPolicyAssignmentsForUser

listIAMPolicyAssignmentsForUser_maxResults :: Lens' ListIAMPolicyAssignmentsForUser (Maybe Natural) Source #

The maximum number of results to be returned per request.

listIAMPolicyAssignmentsForUser_nextToken :: Lens' ListIAMPolicyAssignmentsForUser (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listIAMPolicyAssignmentsForUser_awsAccountId :: Lens' ListIAMPolicyAssignmentsForUser Text Source #

The ID of the Amazon Web Services account that contains the assignments.

listIAMPolicyAssignmentsForUser_userName :: Lens' ListIAMPolicyAssignmentsForUser Text Source #

The name of the user.

listIAMPolicyAssignmentsForUser_namespace :: Lens' ListIAMPolicyAssignmentsForUser Text Source #

The namespace of the assignment.

listIAMPolicyAssignmentsForUserResponse_activeAssignments :: Lens' ListIAMPolicyAssignmentsForUserResponse (Maybe [ActiveIAMPolicyAssignment]) Source #

The active assignments for this user.

listIAMPolicyAssignmentsForUserResponse_nextToken :: Lens' ListIAMPolicyAssignmentsForUserResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listIAMPolicyAssignmentsForUserResponse_requestId :: Lens' ListIAMPolicyAssignmentsForUserResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listIAMPolicyAssignmentsForUserResponse_status :: Lens' ListIAMPolicyAssignmentsForUserResponse Int Source #

The HTTP status of the request.

ListIngestions

listIngestions_maxResults :: Lens' ListIngestions (Maybe Natural) Source #

The maximum number of results to be returned per request.

listIngestions_nextToken :: Lens' ListIngestions (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listIngestions_dataSetId :: Lens' ListIngestions Text Source #

The ID of the dataset used in the ingestion.

listIngestions_awsAccountId :: Lens' ListIngestions Text Source #

The Amazon Web Services account ID.

listIngestionsResponse_ingestions :: Lens' ListIngestionsResponse (Maybe [Ingestion]) Source #

A list of the ingestions.

listIngestionsResponse_nextToken :: Lens' ListIngestionsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listIngestionsResponse_requestId :: Lens' ListIngestionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listIngestionsResponse_status :: Lens' ListIngestionsResponse Int Source #

The HTTP status of the request.

ListNamespaces

listNamespaces_maxResults :: Lens' ListNamespaces (Maybe Natural) Source #

The maximum number of results to return.

listNamespaces_nextToken :: Lens' ListNamespaces (Maybe Text) Source #

A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous ListNameSpaces API call if there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

listNamespaces_awsAccountId :: Lens' ListNamespaces Text Source #

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.

listNamespacesResponse_namespaces :: Lens' ListNamespacesResponse (Maybe [NamespaceInfoV2]) Source #

The information about the namespaces in this Amazon Web Services account. The response includes the namespace ARN, name, Amazon Web Services Region, notification email address, creation status, and identity store.

listNamespacesResponse_nextToken :: Lens' ListNamespacesResponse (Maybe Text) Source #

A unique pagination token that can be used in a subsequent request. Receiving NextToken in your response inticates that there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

listNamespacesResponse_requestId :: Lens' ListNamespacesResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listNamespacesResponse_status :: Lens' ListNamespacesResponse Int Source #

The HTTP status of the request.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource that you want a list of tags for.

listTagsForResourceResponse_requestId :: Lens' ListTagsForResourceResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (NonEmpty Tag)) Source #

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

listTagsForResourceResponse_status :: Lens' ListTagsForResourceResponse Int Source #

The HTTP status of the request.

ListTemplateAliases

listTemplateAliases_maxResults :: Lens' ListTemplateAliases (Maybe Natural) Source #

The maximum number of results to be returned per request.

listTemplateAliases_nextToken :: Lens' ListTemplateAliases (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listTemplateAliases_awsAccountId :: Lens' ListTemplateAliases Text Source #

The ID of the Amazon Web Services account that contains the template aliases that you're listing.

listTemplateAliases_templateId :: Lens' ListTemplateAliases Text Source #

The ID for the template.

listTemplateAliasesResponse_nextToken :: Lens' ListTemplateAliasesResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listTemplateAliasesResponse_requestId :: Lens' ListTemplateAliasesResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listTemplateAliasesResponse_templateAliasList :: Lens' ListTemplateAliasesResponse (Maybe [TemplateAlias]) Source #

A structure containing the list of the template's aliases.

listTemplateAliasesResponse_status :: Lens' ListTemplateAliasesResponse Int Source #

The HTTP status of the request.

ListTemplateVersions

listTemplateVersions_maxResults :: Lens' ListTemplateVersions (Maybe Natural) Source #

The maximum number of results to be returned per request.

listTemplateVersions_nextToken :: Lens' ListTemplateVersions (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listTemplateVersions_awsAccountId :: Lens' ListTemplateVersions Text Source #

The ID of the Amazon Web Services account that contains the templates that you're listing.

listTemplateVersions_templateId :: Lens' ListTemplateVersions Text Source #

The ID for the template.

listTemplateVersionsResponse_nextToken :: Lens' ListTemplateVersionsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listTemplateVersionsResponse_requestId :: Lens' ListTemplateVersionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listTemplateVersionsResponse_templateVersionSummaryList :: Lens' ListTemplateVersionsResponse (Maybe [TemplateVersionSummary]) Source #

A structure containing a list of all the versions of the specified template.

listTemplateVersionsResponse_status :: Lens' ListTemplateVersionsResponse Int Source #

The HTTP status of the request.

ListTemplates

listTemplates_maxResults :: Lens' ListTemplates (Maybe Natural) Source #

The maximum number of results to be returned per request.

listTemplates_nextToken :: Lens' ListTemplates (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listTemplates_awsAccountId :: Lens' ListTemplates Text Source #

The ID of the Amazon Web Services account that contains the templates that you're listing.

listTemplatesResponse_nextToken :: Lens' ListTemplatesResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listTemplatesResponse_requestId :: Lens' ListTemplatesResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listTemplatesResponse_templateSummaryList :: Lens' ListTemplatesResponse (Maybe [TemplateSummary]) Source #

A structure containing information about the templates in the list.

listTemplatesResponse_status :: Lens' ListTemplatesResponse Int Source #

The HTTP status of the request.

ListThemeAliases

listThemeAliases_maxResults :: Lens' ListThemeAliases (Maybe Natural) Source #

The maximum number of results to be returned per request.

listThemeAliases_nextToken :: Lens' ListThemeAliases (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listThemeAliases_awsAccountId :: Lens' ListThemeAliases Text Source #

The ID of the Amazon Web Services account that contains the theme aliases that you're listing.

listThemeAliases_themeId :: Lens' ListThemeAliases Text Source #

The ID for the theme.

listThemeAliasesResponse_nextToken :: Lens' ListThemeAliasesResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listThemeAliasesResponse_requestId :: Lens' ListThemeAliasesResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listThemeAliasesResponse_themeAliasList :: Lens' ListThemeAliasesResponse (Maybe [ThemeAlias]) Source #

A structure containing the list of the theme's aliases.

listThemeAliasesResponse_status :: Lens' ListThemeAliasesResponse Int Source #

The HTTP status of the request.

ListThemeVersions

listThemeVersions_maxResults :: Lens' ListThemeVersions (Maybe Natural) Source #

The maximum number of results to be returned per request.

listThemeVersions_nextToken :: Lens' ListThemeVersions (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listThemeVersions_awsAccountId :: Lens' ListThemeVersions Text Source #

The ID of the Amazon Web Services account that contains the themes that you're listing.

listThemeVersions_themeId :: Lens' ListThemeVersions Text Source #

The ID for the theme.

listThemeVersionsResponse_nextToken :: Lens' ListThemeVersionsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listThemeVersionsResponse_requestId :: Lens' ListThemeVersionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listThemeVersionsResponse_themeVersionSummaryList :: Lens' ListThemeVersionsResponse (Maybe [ThemeVersionSummary]) Source #

A structure containing a list of all the versions of the specified theme.

listThemeVersionsResponse_status :: Lens' ListThemeVersionsResponse Int Source #

The HTTP status of the request.

ListThemes

listThemes_maxResults :: Lens' ListThemes (Maybe Natural) Source #

The maximum number of results to be returned per request.

listThemes_nextToken :: Lens' ListThemes (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listThemes_type :: Lens' ListThemes (Maybe ThemeType) Source #

The type of themes that you want to list. Valid options include the following:

ALL (default)- Display all existing themes.
CUSTOM - Display only the themes created by people using Amazon QuickSight.
QUICKSIGHT - Display only the starting themes defined by Amazon QuickSight.

listThemes_awsAccountId :: Lens' ListThemes Text Source #

The ID of the Amazon Web Services account that contains the themes that you're listing.

listThemesResponse_nextToken :: Lens' ListThemesResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

listThemesResponse_requestId :: Lens' ListThemesResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listThemesResponse_themeSummaryList :: Lens' ListThemesResponse (Maybe [ThemeSummary]) Source #

Information about the themes in the list.

listThemesResponse_status :: Lens' ListThemesResponse Int Source #

The HTTP status of the request.

ListUserGroups

listUserGroups_maxResults :: Lens' ListUserGroups (Maybe Natural) Source #

The maximum number of results to return from this request.

listUserGroups_nextToken :: Lens' ListUserGroups (Maybe Text) Source #

A pagination token that can be used in a subsequent request.

listUserGroups_userName :: Lens' ListUserGroups Text Source #

The Amazon QuickSight user name that you want to list group memberships for.

listUserGroups_awsAccountId :: Lens' ListUserGroups Text Source #

The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

listUserGroups_namespace :: Lens' ListUserGroups Text Source #

The namespace. Currently, you should set this to default.

listUserGroupsResponse_groupList :: Lens' ListUserGroupsResponse (Maybe [Group]) Source #

The list of groups the user is a member of.

listUserGroupsResponse_nextToken :: Lens' ListUserGroupsResponse (Maybe Text) Source #

A pagination token that can be used in a subsequent request.

listUserGroupsResponse_requestId :: Lens' ListUserGroupsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listUserGroupsResponse_status :: Lens' ListUserGroupsResponse Int Source #

The HTTP status of the request.

ListUsers

listUsers_maxResults :: Lens' ListUsers (Maybe Natural) Source #

The maximum number of results to return from this request.

listUsers_nextToken :: Lens' ListUsers (Maybe Text) Source #

A pagination token that can be used in a subsequent request.

listUsers_awsAccountId :: Lens' ListUsers Text Source #

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

listUsers_namespace :: Lens' ListUsers Text Source #

The namespace. Currently, you should set this to default.

listUsersResponse_nextToken :: Lens' ListUsersResponse (Maybe Text) Source #

A pagination token that can be used in a subsequent request.

listUsersResponse_requestId :: Lens' ListUsersResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

listUsersResponse_userList :: Lens' ListUsersResponse (Maybe [User]) Source #

The list of users.

listUsersResponse_status :: Lens' ListUsersResponse Int Source #

The HTTP status of the request.

RegisterUser

registerUser_customFederationProviderUrl :: Lens' RegisterUser (Maybe Text) Source #

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

registerUser_customPermissionsName :: Lens' RegisterUser (Maybe Text) Source #

(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:

Create and update data sources
Create and update datasets
Create and update email reports
Subscribe to email reports

To add custom permissions to an existing user, use UpdateUser instead.

A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader).

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

registerUser_externalLoginFederationProviderType :: Lens' RegisterUser (Maybe Text) Source #

The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.
CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

registerUser_externalLoginId :: Lens' RegisterUser (Maybe Text) Source #

The identity ID for a user in the external login provider.

registerUser_iamArn :: Lens' RegisterUser (Maybe Text) Source #

The ARN of the IAM user or role that you are registering with Amazon QuickSight.

registerUser_sessionName :: Lens' RegisterUser (Maybe Text) Source #

You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon QuickSight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see assume-role in the CLI Reference.

registerUser_userName :: Lens' RegisterUser (Maybe Text) Source #

The Amazon QuickSight user name that you want to create for the user you are registering.

registerUser_identityType :: Lens' RegisterUser IdentityType Source #

Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:

IAM: A user whose identity maps to an existing IAM user or role.
QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.

registerUser_email :: Lens' RegisterUser Text Source #

The email address of the user that you want to register.

registerUser_userRole :: Lens' RegisterUser UserRole Source #

The Amazon QuickSight role for the user. The user role can be one of the following:

READER: A user who has read-only access to dashboards.
AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.
ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.
RESTRICTED_READER: This role isn't currently available for use.
RESTRICTED_AUTHOR: This role isn't currently available for use.

registerUser_awsAccountId :: Lens' RegisterUser Text Source #

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

registerUser_namespace :: Lens' RegisterUser Text Source #

The namespace. Currently, you should set this to default.

registerUserResponse_requestId :: Lens' RegisterUserResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

registerUserResponse_user :: Lens' RegisterUserResponse (Maybe User) Source #

The user's user name.

registerUserResponse_userInvitationUrl :: Lens' RegisterUserResponse (Maybe Text) Source #

The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of QUICKSIGHT.

registerUserResponse_status :: Lens' RegisterUserResponse Int Source #

The HTTP status of the request.

RestoreAnalysis

restoreAnalysis_awsAccountId :: Lens' RestoreAnalysis Text Source #

The ID of the Amazon Web Services account that contains the analysis.

restoreAnalysis_analysisId :: Lens' RestoreAnalysis Text Source #

The ID of the analysis that you're restoring.

restoreAnalysisResponse_analysisId :: Lens' RestoreAnalysisResponse (Maybe Text) Source #

The ID of the analysis that you're restoring.

restoreAnalysisResponse_arn :: Lens' RestoreAnalysisResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the analysis that you're restoring.

restoreAnalysisResponse_requestId :: Lens' RestoreAnalysisResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

restoreAnalysisResponse_status :: Lens' RestoreAnalysisResponse Int Source #

The HTTP status of the request.

SearchAnalyses

searchAnalyses_maxResults :: Lens' SearchAnalyses (Maybe Natural) Source #

The maximum number of results to return.

searchAnalyses_nextToken :: Lens' SearchAnalyses (Maybe Text) Source #

A pagination token that can be used in a subsequent request.

searchAnalyses_awsAccountId :: Lens' SearchAnalyses Text Source #

The ID of the Amazon Web Services account that contains the analyses that you're searching for.

searchAnalyses_filters :: Lens' SearchAnalyses (NonEmpty AnalysisSearchFilter) Source #

The structure for the search filters that you want to apply to your search.

searchAnalysesResponse_analysisSummaryList :: Lens' SearchAnalysesResponse (Maybe [AnalysisSummary]) Source #

Metadata describing the analyses that you searched for.

searchAnalysesResponse_nextToken :: Lens' SearchAnalysesResponse (Maybe Text) Source #

A pagination token that can be used in a subsequent request.

searchAnalysesResponse_requestId :: Lens' SearchAnalysesResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

searchAnalysesResponse_status :: Lens' SearchAnalysesResponse Int Source #

The HTTP status of the request.

SearchDashboards

searchDashboards_maxResults :: Lens' SearchDashboards (Maybe Natural) Source #

The maximum number of results to be returned per request.

searchDashboards_nextToken :: Lens' SearchDashboards (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

searchDashboards_awsAccountId :: Lens' SearchDashboards Text Source #

The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.

searchDashboards_filters :: Lens' SearchDashboards (NonEmpty DashboardSearchFilter) Source #

The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

searchDashboardsResponse_dashboardSummaryList :: Lens' SearchDashboardsResponse (Maybe [DashboardSummary]) Source #

The list of dashboards owned by the user specified in Filters in your request.

searchDashboardsResponse_nextToken :: Lens' SearchDashboardsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

searchDashboardsResponse_requestId :: Lens' SearchDashboardsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

searchDashboardsResponse_status :: Lens' SearchDashboardsResponse Int Source #

The HTTP status of the request.

SearchDataSets

searchDataSets_maxResults :: Lens' SearchDataSets (Maybe Natural) Source #

The maximum number of results to be returned per request.

searchDataSets_nextToken :: Lens' SearchDataSets (Maybe Text) Source #

A pagination token that can be used in a subsequent request.

searchDataSets_awsAccountId :: Lens' SearchDataSets Text Source #

The Amazon Web Services account ID.

searchDataSets_filters :: Lens' SearchDataSets (NonEmpty DataSetSearchFilter) Source #

The filters to apply to the search.

searchDataSetsResponse_dataSetSummaries :: Lens' SearchDataSetsResponse (Maybe [DataSetSummary]) Source #

A DataSetSummaries object that returns a summary of a dataset.

searchDataSetsResponse_nextToken :: Lens' SearchDataSetsResponse (Maybe Text) Source #

A pagination token that can be used in a subsequent request.

searchDataSetsResponse_requestId :: Lens' SearchDataSetsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

searchDataSetsResponse_status :: Lens' SearchDataSetsResponse Int Source #

The HTTP status of the request.

SearchDataSources

searchDataSources_maxResults :: Lens' SearchDataSources (Maybe Natural) Source #

The maximum number of results to be returned per request.

searchDataSources_nextToken :: Lens' SearchDataSources (Maybe Text) Source #

A pagination token that can be used in a subsequent request.

searchDataSources_awsAccountId :: Lens' SearchDataSources Text Source #

The Amazon Web Services account ID.

searchDataSources_filters :: Lens' SearchDataSources (NonEmpty DataSourceSearchFilter) Source #

The filters to apply to the search.

searchDataSourcesResponse_dataSourceSummaries :: Lens' SearchDataSourcesResponse (Maybe [DataSourceSummary]) Source #

A DataSourceSummaries object that returns a summary of a data source.

searchDataSourcesResponse_nextToken :: Lens' SearchDataSourcesResponse (Maybe Text) Source #

A pagination token that can be used in a subsequent request.

searchDataSourcesResponse_requestId :: Lens' SearchDataSourcesResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

searchDataSourcesResponse_status :: Lens' SearchDataSourcesResponse Int Source #

The HTTP status of the request.

SearchFolders

searchFolders_maxResults :: Lens' SearchFolders (Maybe Natural) Source #

The maximum number of results to be returned per request.

searchFolders_nextToken :: Lens' SearchFolders (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

searchFolders_awsAccountId :: Lens' SearchFolders Text Source #

The ID for the Amazon Web Services account that contains the folder.

searchFolders_filters :: Lens' SearchFolders [FolderSearchFilter] Source #

The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, "Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ].

searchFoldersResponse_folderSummaryList :: Lens' SearchFoldersResponse (Maybe [FolderSummary]) Source #

A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

searchFoldersResponse_nextToken :: Lens' SearchFoldersResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no more results.

searchFoldersResponse_requestId :: Lens' SearchFoldersResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

searchFoldersResponse_status :: Lens' SearchFoldersResponse Int Source #

The HTTP status of the request.

SearchGroups

searchGroups_maxResults :: Lens' SearchGroups (Maybe Natural) Source #

The maximum number of results to return from this request.

searchGroups_nextToken :: Lens' SearchGroups (Maybe Text) Source #

A pagination token that can be used in a subsequent request.

searchGroups_awsAccountId :: Lens' SearchGroups Text Source #

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

searchGroups_namespace :: Lens' SearchGroups Text Source #

The namespace that you want to search.

searchGroups_filters :: Lens' SearchGroups (NonEmpty GroupSearchFilter) Source #

The structure for the search filters that you want to apply to your search.

searchGroupsResponse_groupList :: Lens' SearchGroupsResponse (Maybe [Group]) Source #

A list of groups in a specified namespace that match the filters you set in your SearchGroups request.

searchGroupsResponse_nextToken :: Lens' SearchGroupsResponse (Maybe Text) Source #

A pagination token that can be used in a subsequent request.

searchGroupsResponse_requestId :: Lens' SearchGroupsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

searchGroupsResponse_status :: Lens' SearchGroupsResponse Int Source #

The HTTP status of the request.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource that you want to tag.

tagResource_tags :: Lens' TagResource (NonEmpty Tag) Source #

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

tagResourceResponse_requestId :: Lens' TagResourceResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

tagResourceResponse_status :: Lens' TagResourceResponse Int Source #

The HTTP status of the request.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource that you want to untag.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

The keys of the key-value pairs for the resource tag or tags assigned to the resource.

untagResourceResponse_requestId :: Lens' UntagResourceResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

untagResourceResponse_status :: Lens' UntagResourceResponse Int Source #

The HTTP status of the request.

UpdateAccountCustomization

updateAccountCustomization_namespace :: Lens' UpdateAccountCustomization (Maybe Text) Source #

The namespace that you want to update Amazon QuickSight customizations for.

updateAccountCustomization_awsAccountId :: Lens' UpdateAccountCustomization Text Source #

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.

updateAccountCustomization_accountCustomization :: Lens' UpdateAccountCustomization AccountCustomization Source #

The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.

updateAccountCustomizationResponse_accountCustomization :: Lens' UpdateAccountCustomizationResponse (Maybe AccountCustomization) Source #

The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.

updateAccountCustomizationResponse_arn :: Lens' UpdateAccountCustomizationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.

updateAccountCustomizationResponse_awsAccountId :: Lens' UpdateAccountCustomizationResponse (Maybe Text) Source #

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.

updateAccountCustomizationResponse_namespace :: Lens' UpdateAccountCustomizationResponse (Maybe Text) Source #

The namespace associated with the customization that you're updating.

updateAccountCustomizationResponse_requestId :: Lens' UpdateAccountCustomizationResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateAccountCustomizationResponse_status :: Lens' UpdateAccountCustomizationResponse Int Source #

The HTTP status of the request.

UpdateAccountSettings

updateAccountSettings_notificationEmail :: Lens' UpdateAccountSettings (Maybe Text) Source #

The email address that you want Amazon QuickSight to send notifications to regarding your Amazon Web Services account or Amazon QuickSight subscription.

updateAccountSettings_terminationProtectionEnabled :: Lens' UpdateAccountSettings (Maybe Bool) Source #

A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription request. A False value will allow the account to be deleted.

updateAccountSettings_awsAccountId :: Lens' UpdateAccountSettings Text Source #

The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to list.

updateAccountSettings_defaultNamespace :: Lens' UpdateAccountSettings Text Source #

The default namespace for this Amazon Web Services account. Currently, the default is default. Identity and Access Management (IAM) users that register for the first time with Amazon QuickSight provide an email address that becomes associated with the default namespace.

updateAccountSettingsResponse_requestId :: Lens' UpdateAccountSettingsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateAccountSettingsResponse_status :: Lens' UpdateAccountSettingsResponse Int Source #

The HTTP status of the request.

UpdateAnalysis

updateAnalysis_definition :: Lens' UpdateAnalysis (Maybe AnalysisDefinition) Source #

The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

updateAnalysis_parameters :: Lens' UpdateAnalysis (Maybe Parameters) Source #

The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

updateAnalysis_sourceEntity :: Lens' UpdateAnalysis (Maybe AnalysisSourceEntity) Source #

A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets.

updateAnalysis_themeArn :: Lens' UpdateAnalysis (Maybe Text) Source #

The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.

updateAnalysis_awsAccountId :: Lens' UpdateAnalysis Text Source #

The ID of the Amazon Web Services account that contains the analysis that you're updating.

updateAnalysis_analysisId :: Lens' UpdateAnalysis Text Source #

The ID for the analysis that you're updating. This ID displays in the URL of the analysis.

updateAnalysis_name :: Lens' UpdateAnalysis Text Source #

A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon QuickSight console.

updateAnalysisResponse_analysisId :: Lens' UpdateAnalysisResponse (Maybe Text) Source #

The ID of the analysis.

updateAnalysisResponse_arn :: Lens' UpdateAnalysisResponse (Maybe Text) Source #

The ARN of the analysis that you're updating.

updateAnalysisResponse_requestId :: Lens' UpdateAnalysisResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateAnalysisResponse_updateStatus :: Lens' UpdateAnalysisResponse (Maybe ResourceStatus) Source #

The update status of the last update that was made to the analysis.

updateAnalysisResponse_status :: Lens' UpdateAnalysisResponse Int Source #

The HTTP status of the request.

UpdateAnalysisPermissions

updateAnalysisPermissions_grantPermissions :: Lens' UpdateAnalysisPermissions (Maybe [ResourcePermission]) Source #

A structure that describes the permissions to add and the principal to add them to.

updateAnalysisPermissions_revokePermissions :: Lens' UpdateAnalysisPermissions (Maybe [ResourcePermission]) Source #

A structure that describes the permissions to remove and the principal to remove them from.

updateAnalysisPermissions_awsAccountId :: Lens' UpdateAnalysisPermissions Text Source #

The ID of the Amazon Web Services account that contains the analysis whose permissions you're updating. You must be using the Amazon Web Services account that the analysis is in.

updateAnalysisPermissions_analysisId :: Lens' UpdateAnalysisPermissions Text Source #

The ID of the analysis whose permissions you're updating. The ID is part of the analysis URL.

updateAnalysisPermissionsResponse_analysisArn :: Lens' UpdateAnalysisPermissionsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the analysis that you updated.

updateAnalysisPermissionsResponse_analysisId :: Lens' UpdateAnalysisPermissionsResponse (Maybe Text) Source #

The ID of the analysis that you updated permissions for.

updateAnalysisPermissionsResponse_permissions :: Lens' UpdateAnalysisPermissionsResponse (Maybe (NonEmpty ResourcePermission)) Source #

A structure that describes the principals and the resource-level permissions on an analysis.

updateAnalysisPermissionsResponse_requestId :: Lens' UpdateAnalysisPermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateAnalysisPermissionsResponse_status :: Lens' UpdateAnalysisPermissionsResponse Int Source #

The HTTP status of the request.

UpdateDashboard

updateDashboard_dashboardPublishOptions :: Lens' UpdateDashboard (Maybe DashboardPublishOptions) Source #

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 QuickSight 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.

updateDashboard_definition :: Lens' UpdateDashboard (Maybe DashboardVersionDefinition) Source #

The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

updateDashboard_parameters :: Lens' UpdateDashboard (Maybe Parameters) Source #

A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.

updateDashboard_sourceEntity :: Lens' UpdateDashboard (Maybe DashboardSourceEntity) Source #

The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

updateDashboard_themeArn :: Lens' UpdateDashboard (Maybe Text) Source #

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

updateDashboard_versionDescription :: Lens' UpdateDashboard (Maybe Text) Source #

A description for the first version of the dashboard being created.

updateDashboard_awsAccountId :: Lens' UpdateDashboard Text Source #

The ID of the Amazon Web Services account that contains the dashboard that you're updating.

updateDashboard_dashboardId :: Lens' UpdateDashboard Text Source #

The ID for the dashboard.

updateDashboard_name :: Lens' UpdateDashboard Text Source #

The display name of the dashboard.

updateDashboardResponse_arn :: Lens' UpdateDashboardResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource.

updateDashboardResponse_creationStatus :: Lens' UpdateDashboardResponse (Maybe ResourceStatus) Source #

The creation status of the request.

updateDashboardResponse_dashboardId :: Lens' UpdateDashboardResponse (Maybe Text) Source #

The ID for the dashboard.

updateDashboardResponse_requestId :: Lens' UpdateDashboardResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateDashboardResponse_status :: Lens' UpdateDashboardResponse (Maybe Int) Source #

The HTTP status of the request.

updateDashboardResponse_versionArn :: Lens' UpdateDashboardResponse (Maybe Text) Source #

The ARN of the dashboard, including the version number.

updateDashboardResponse_httpStatus :: Lens' UpdateDashboardResponse Int Source #

The response's http status code.

UpdateDashboardPermissions

updateDashboardPermissions_grantLinkPermissions :: Lens' UpdateDashboardPermissions (Maybe [ResourcePermission]) Source #

Grants link permissions to all users in a defined namespace.

updateDashboardPermissions_grantPermissions :: Lens' UpdateDashboardPermissions (Maybe [ResourcePermission]) Source #

The permissions that you want to grant on this resource.

updateDashboardPermissions_revokeLinkPermissions :: Lens' UpdateDashboardPermissions (Maybe [ResourcePermission]) Source #

Revokes link permissions from all users in a defined namespace.

updateDashboardPermissions_revokePermissions :: Lens' UpdateDashboardPermissions (Maybe [ResourcePermission]) Source #

The permissions that you want to revoke from this resource.

updateDashboardPermissions_awsAccountId :: Lens' UpdateDashboardPermissions Text Source #

The ID of the Amazon Web Services account that contains the dashboard whose permissions you're updating.

updateDashboardPermissions_dashboardId :: Lens' UpdateDashboardPermissions Text Source #

The ID for the dashboard.

updateDashboardPermissionsResponse_dashboardArn :: Lens' UpdateDashboardPermissionsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dashboard.

updateDashboardPermissionsResponse_dashboardId :: Lens' UpdateDashboardPermissionsResponse (Maybe Text) Source #

The ID for the dashboard.

updateDashboardPermissionsResponse_linkSharingConfiguration :: Lens' UpdateDashboardPermissionsResponse (Maybe LinkSharingConfiguration) Source #

Updates the permissions of a shared link to an Amazon QuickSight dashboard.

updateDashboardPermissionsResponse_permissions :: Lens' UpdateDashboardPermissionsResponse (Maybe (NonEmpty ResourcePermission)) Source #

Information about the permissions on the dashboard.

updateDashboardPermissionsResponse_requestId :: Lens' UpdateDashboardPermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateDashboardPermissionsResponse_status :: Lens' UpdateDashboardPermissionsResponse Int Source #

The HTTP status of the request.

UpdateDashboardPublishedVersion

updateDashboardPublishedVersion_awsAccountId :: Lens' UpdateDashboardPublishedVersion Text Source #

The ID of the Amazon Web Services account that contains the dashboard that you're updating.

updateDashboardPublishedVersion_dashboardId :: Lens' UpdateDashboardPublishedVersion Text Source #

The ID for the dashboard.

updateDashboardPublishedVersion_versionNumber :: Lens' UpdateDashboardPublishedVersion Natural Source #

The version number of the dashboard.

updateDashboardPublishedVersionResponse_dashboardArn :: Lens' UpdateDashboardPublishedVersionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dashboard.

updateDashboardPublishedVersionResponse_dashboardId :: Lens' UpdateDashboardPublishedVersionResponse (Maybe Text) Source #

The ID for the dashboard.

updateDashboardPublishedVersionResponse_requestId :: Lens' UpdateDashboardPublishedVersionResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateDashboardPublishedVersionResponse_status :: Lens' UpdateDashboardPublishedVersionResponse Int Source #

The HTTP status of the request.

UpdateDataSet

updateDataSet_columnGroups :: Lens' UpdateDataSet (Maybe (NonEmpty ColumnGroup)) Source #

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

updateDataSet_columnLevelPermissionRules :: Lens' UpdateDataSet (Maybe (NonEmpty ColumnLevelPermissionRule)) Source #

A set of one or more definitions of a ColumnLevelPermissionRule .

updateDataSet_dataSetUsageConfiguration :: Lens' UpdateDataSet (Maybe DataSetUsageConfiguration) Source #

Undocumented member.

updateDataSet_fieldFolders :: Lens' UpdateDataSet (Maybe (HashMap Text FieldFolder)) Source #

The folder that contains fields and nested subfolders for your dataset.

updateDataSet_logicalTableMap :: Lens' UpdateDataSet (Maybe (HashMap Text LogicalTable)) Source #

Configures the combination and transformation of the data from the physical tables.

updateDataSet_rowLevelPermissionDataSet :: Lens' UpdateDataSet (Maybe RowLevelPermissionDataSet) Source #

The row-level security configuration for the data you want to create.

updateDataSet_rowLevelPermissionTagConfiguration :: Lens' UpdateDataSet (Maybe RowLevelPermissionTagConfiguration) Source #

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

updateDataSet_awsAccountId :: Lens' UpdateDataSet Text Source #

The Amazon Web Services account ID.

updateDataSet_dataSetId :: Lens' UpdateDataSet Text Source #

The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

updateDataSet_name :: Lens' UpdateDataSet Text Source #

The display name for the dataset.

updateDataSet_physicalTableMap :: Lens' UpdateDataSet (HashMap Text PhysicalTable) Source #

Declares the physical tables that are available in the underlying data sources.

updateDataSet_importMode :: Lens' UpdateDataSet DataSetImportMode Source #

Indicates whether you want to import the data into SPICE.

updateDataSetResponse_arn :: Lens' UpdateDataSetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset.

updateDataSetResponse_dataSetId :: Lens' UpdateDataSetResponse (Maybe Text) Source #

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

updateDataSetResponse_ingestionArn :: Lens' UpdateDataSetResponse (Maybe Text) Source #

The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.

updateDataSetResponse_ingestionId :: Lens' UpdateDataSetResponse (Maybe Text) Source #

The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.

updateDataSetResponse_requestId :: Lens' UpdateDataSetResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateDataSetResponse_status :: Lens' UpdateDataSetResponse Int Source #

The HTTP status of the request.

UpdateDataSetPermissions

updateDataSetPermissions_grantPermissions :: Lens' UpdateDataSetPermissions (Maybe (NonEmpty ResourcePermission)) Source #

The resource permissions that you want to grant to the dataset.

updateDataSetPermissions_revokePermissions :: Lens' UpdateDataSetPermissions (Maybe (NonEmpty ResourcePermission)) Source #

The resource permissions that you want to revoke from the dataset.

updateDataSetPermissions_awsAccountId :: Lens' UpdateDataSetPermissions Text Source #

The Amazon Web Services account ID.

updateDataSetPermissions_dataSetId :: Lens' UpdateDataSetPermissions Text Source #

The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

updateDataSetPermissionsResponse_dataSetArn :: Lens' UpdateDataSetPermissionsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset.

updateDataSetPermissionsResponse_dataSetId :: Lens' UpdateDataSetPermissionsResponse (Maybe Text) Source #

The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

updateDataSetPermissionsResponse_requestId :: Lens' UpdateDataSetPermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateDataSetPermissionsResponse_status :: Lens' UpdateDataSetPermissionsResponse Int Source #

The HTTP status of the request.

UpdateDataSource

updateDataSource_credentials :: Lens' UpdateDataSource (Maybe DataSourceCredentials) Source #

The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

updateDataSource_dataSourceParameters :: Lens' UpdateDataSource (Maybe DataSourceParameters) Source #

The parameters that Amazon QuickSight uses to connect to your underlying source.

updateDataSource_sslProperties :: Lens' UpdateDataSource (Maybe SslProperties) Source #

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

updateDataSource_vpcConnectionProperties :: Lens' UpdateDataSource (Maybe VpcConnectionProperties) Source #

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

updateDataSource_awsAccountId :: Lens' UpdateDataSource Text Source #

The Amazon Web Services account ID.

updateDataSource_dataSourceId :: Lens' UpdateDataSource Text Source #

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

updateDataSource_name :: Lens' UpdateDataSource Text Source #

A display name for the data source.

updateDataSourceResponse_arn :: Lens' UpdateDataSourceResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the data source.

updateDataSourceResponse_dataSourceId :: Lens' UpdateDataSourceResponse (Maybe Text) Source #

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

updateDataSourceResponse_requestId :: Lens' UpdateDataSourceResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateDataSourceResponse_updateStatus :: Lens' UpdateDataSourceResponse (Maybe ResourceStatus) Source #

The update status of the data source's last update.

updateDataSourceResponse_status :: Lens' UpdateDataSourceResponse Int Source #

The HTTP status of the request.

UpdateDataSourcePermissions

updateDataSourcePermissions_grantPermissions :: Lens' UpdateDataSourcePermissions (Maybe (NonEmpty ResourcePermission)) Source #

A list of resource permissions that you want to grant on the data source.

updateDataSourcePermissions_revokePermissions :: Lens' UpdateDataSourcePermissions (Maybe (NonEmpty ResourcePermission)) Source #

A list of resource permissions that you want to revoke on the data source.

updateDataSourcePermissions_awsAccountId :: Lens' UpdateDataSourcePermissions Text Source #

The Amazon Web Services account ID.

updateDataSourcePermissions_dataSourceId :: Lens' UpdateDataSourcePermissions Text Source #

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

updateDataSourcePermissionsResponse_dataSourceArn :: Lens' UpdateDataSourcePermissionsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the data source.

updateDataSourcePermissionsResponse_dataSourceId :: Lens' UpdateDataSourcePermissionsResponse (Maybe Text) Source #

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

updateDataSourcePermissionsResponse_requestId :: Lens' UpdateDataSourcePermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateDataSourcePermissionsResponse_status :: Lens' UpdateDataSourcePermissionsResponse Int Source #

The HTTP status of the request.

UpdateFolder

updateFolder_awsAccountId :: Lens' UpdateFolder Text Source #

The ID for the Amazon Web Services account that contains the folder to update.

updateFolder_folderId :: Lens' UpdateFolder Text Source #

The ID of the folder.

updateFolder_name :: Lens' UpdateFolder Text Source #

The name of the folder.

updateFolderResponse_arn :: Lens' UpdateFolderResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the folder.

updateFolderResponse_folderId :: Lens' UpdateFolderResponse (Maybe Text) Source #

The ID of the folder.

updateFolderResponse_requestId :: Lens' UpdateFolderResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateFolderResponse_status :: Lens' UpdateFolderResponse Int Source #

The HTTP status of the request.

UpdateFolderPermissions

updateFolderPermissions_grantPermissions :: Lens' UpdateFolderPermissions (Maybe (NonEmpty ResourcePermission)) Source #

The permissions that you want to grant on a resource.

updateFolderPermissions_revokePermissions :: Lens' UpdateFolderPermissions (Maybe (NonEmpty ResourcePermission)) Source #

The permissions that you want to revoke from a resource.

updateFolderPermissions_awsAccountId :: Lens' UpdateFolderPermissions Text Source #

The ID for the Amazon Web Services account that contains the folder to update.

updateFolderPermissions_folderId :: Lens' UpdateFolderPermissions Text Source #

The ID of the folder.

updateFolderPermissionsResponse_arn :: Lens' UpdateFolderPermissionsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the folder.

updateFolderPermissionsResponse_folderId :: Lens' UpdateFolderPermissionsResponse (Maybe Text) Source #

The ID of the folder.

updateFolderPermissionsResponse_permissions :: Lens' UpdateFolderPermissionsResponse (Maybe (NonEmpty ResourcePermission)) Source #

Information about the permissions for the folder.

updateFolderPermissionsResponse_requestId :: Lens' UpdateFolderPermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateFolderPermissionsResponse_status :: Lens' UpdateFolderPermissionsResponse (Maybe Int) Source #

The HTTP status of the request.

updateFolderPermissionsResponse_httpStatus :: Lens' UpdateFolderPermissionsResponse Int Source #

The response's http status code.

UpdateGroup

updateGroup_description :: Lens' UpdateGroup (Maybe Text) Source #

The description for the group that you want to update.

updateGroup_groupName :: Lens' UpdateGroup Text Source #

The name of the group that you want to update.

updateGroup_awsAccountId :: Lens' UpdateGroup Text Source #

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

updateGroup_namespace :: Lens' UpdateGroup Text Source #

The namespace of the group that you want to update.

updateGroupResponse_group :: Lens' UpdateGroupResponse (Maybe Group) Source #

The name of the group.

updateGroupResponse_requestId :: Lens' UpdateGroupResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateGroupResponse_status :: Lens' UpdateGroupResponse Int Source #

The HTTP status of the request.

UpdateIAMPolicyAssignment

updateIAMPolicyAssignment_assignmentStatus :: Lens' UpdateIAMPolicyAssignment (Maybe AssignmentStatus) Source #

The status of the assignment. Possible values are as follows:

ENABLED - Anything specified in this assignment is used when creating the data source.
DISABLED - This assignment isn't used when creating the data source.
DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.

updateIAMPolicyAssignment_identities :: Lens' UpdateIAMPolicyAssignment (Maybe (HashMap Text [Text])) Source #

The Amazon QuickSight users, groups, or both that you want to assign the policy to.

updateIAMPolicyAssignment_policyArn :: Lens' UpdateIAMPolicyAssignment (Maybe Text) Source #

The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.

updateIAMPolicyAssignment_awsAccountId :: Lens' UpdateIAMPolicyAssignment Text Source #

The ID of the Amazon Web Services account that contains the IAM policy assignment.

updateIAMPolicyAssignment_assignmentName :: Lens' UpdateIAMPolicyAssignment Text Source #

The name of the assignment, also called a rule. This name must be unique within an Amazon Web Services account.

updateIAMPolicyAssignment_namespace :: Lens' UpdateIAMPolicyAssignment Text Source #

The namespace of the assignment.

updateIAMPolicyAssignmentResponse_assignmentId :: Lens' UpdateIAMPolicyAssignmentResponse (Maybe Text) Source #

The ID of the assignment.

updateIAMPolicyAssignmentResponse_assignmentName :: Lens' UpdateIAMPolicyAssignmentResponse (Maybe Text) Source #

The name of the assignment or rule.

updateIAMPolicyAssignmentResponse_assignmentStatus :: Lens' UpdateIAMPolicyAssignmentResponse (Maybe AssignmentStatus) Source #

The status of the assignment. Possible values are as follows:

ENABLED - Anything specified in this assignment is used when creating the data source.
DISABLED - This assignment isn't used when creating the data source.
DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.

updateIAMPolicyAssignmentResponse_identities :: Lens' UpdateIAMPolicyAssignmentResponse (Maybe (HashMap Text [Text])) Source #

The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.

updateIAMPolicyAssignmentResponse_policyArn :: Lens' UpdateIAMPolicyAssignmentResponse (Maybe Text) Source #

The ARN for the IAM policy applied to the Amazon QuickSight users and groups specified in this assignment.

updateIAMPolicyAssignmentResponse_requestId :: Lens' UpdateIAMPolicyAssignmentResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateIAMPolicyAssignmentResponse_status :: Lens' UpdateIAMPolicyAssignmentResponse Int Source #

The HTTP status of the request.

UpdateIpRestriction

updateIpRestriction_enabled :: Lens' UpdateIpRestriction (Maybe Bool) Source #

A value that specifies whether IP rules are turned on.

updateIpRestriction_ipRestrictionRuleMap :: Lens' UpdateIpRestriction (Maybe (HashMap Text Text)) Source #

A map that describes the updated IP rules with CIDR ranges and descriptions.

updateIpRestriction_awsAccountId :: Lens' UpdateIpRestriction Text Source #

The ID of the Amazon Web Services account that contains the IP rules.

updateIpRestrictionResponse_awsAccountId :: Lens' UpdateIpRestrictionResponse (Maybe Text) Source #

The ID of the Amazon Web Services account that contains the IP rules.

updateIpRestrictionResponse_requestId :: Lens' UpdateIpRestrictionResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateIpRestrictionResponse_status :: Lens' UpdateIpRestrictionResponse Int Source #

The HTTP status of the request.

UpdatePublicSharingSettings

updatePublicSharingSettings_publicSharingEnabled :: Lens' UpdatePublicSharingSettings (Maybe Bool) Source #

A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.

updatePublicSharingSettings_awsAccountId :: Lens' UpdatePublicSharingSettings Text Source #

The Amazon Web Services account ID associated with your Amazon QuickSight subscription.

updatePublicSharingSettingsResponse_requestId :: Lens' UpdatePublicSharingSettingsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updatePublicSharingSettingsResponse_status :: Lens' UpdatePublicSharingSettingsResponse Int Source #

The HTTP status of the request.

UpdateTemplate

updateTemplate_definition :: Lens' UpdateTemplate (Maybe TemplateVersionDefinition) Source #

The definition of a template.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

updateTemplate_name :: Lens' UpdateTemplate (Maybe Text) Source #

The name for the template.

updateTemplate_sourceEntity :: Lens' UpdateTemplate (Maybe TemplateSourceEntity) Source #

The entity that you are using as a source when you update 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 Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services 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.

updateTemplate_versionDescription :: Lens' UpdateTemplate (Maybe Text) Source #

A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.

updateTemplate_awsAccountId :: Lens' UpdateTemplate Text Source #

The ID of the Amazon Web Services account that contains the template that you're updating.

updateTemplate_templateId :: Lens' UpdateTemplate Text Source #

The ID for the template.

updateTemplateResponse_arn :: Lens' UpdateTemplateResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the template.

updateTemplateResponse_creationStatus :: Lens' UpdateTemplateResponse (Maybe ResourceStatus) Source #

The creation status of the template.

updateTemplateResponse_requestId :: Lens' UpdateTemplateResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateTemplateResponse_templateId :: Lens' UpdateTemplateResponse (Maybe Text) Source #

The ID for the template.

updateTemplateResponse_versionArn :: Lens' UpdateTemplateResponse (Maybe Text) Source #

The ARN for the template, including the version information of the first version.

updateTemplateResponse_status :: Lens' UpdateTemplateResponse Int Source #

The HTTP status of the request.

UpdateTemplateAlias

updateTemplateAlias_awsAccountId :: Lens' UpdateTemplateAlias Text Source #

The ID of the Amazon Web Services account that contains the template alias that you're updating.

updateTemplateAlias_templateId :: Lens' UpdateTemplateAlias Text Source #

The ID for the template.

updateTemplateAlias_aliasName :: Lens' UpdateTemplateAlias Text Source #

The alias of the template that you want to update. If you name a specific alias, you update the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.

updateTemplateAlias_templateVersionNumber :: Lens' UpdateTemplateAlias Natural Source #

The version number of the template.

updateTemplateAliasResponse_requestId :: Lens' UpdateTemplateAliasResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateTemplateAliasResponse_templateAlias :: Lens' UpdateTemplateAliasResponse (Maybe TemplateAlias) Source #

The template alias.

updateTemplateAliasResponse_status :: Lens' UpdateTemplateAliasResponse Int Source #

The HTTP status of the request.

UpdateTemplatePermissions

updateTemplatePermissions_grantPermissions :: Lens' UpdateTemplatePermissions (Maybe [ResourcePermission]) Source #

A list of resource permissions to be granted on the template.

updateTemplatePermissions_revokePermissions :: Lens' UpdateTemplatePermissions (Maybe [ResourcePermission]) Source #

A list of resource permissions to be revoked from the template.

updateTemplatePermissions_awsAccountId :: Lens' UpdateTemplatePermissions Text Source #

The ID of the Amazon Web Services account that contains the template.

updateTemplatePermissions_templateId :: Lens' UpdateTemplatePermissions Text Source #

The ID for the template.

updateTemplatePermissionsResponse_permissions :: Lens' UpdateTemplatePermissionsResponse (Maybe (NonEmpty ResourcePermission)) Source #

A list of resource permissions to be set on the template.

updateTemplatePermissionsResponse_requestId :: Lens' UpdateTemplatePermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateTemplatePermissionsResponse_templateArn :: Lens' UpdateTemplatePermissionsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the template.

updateTemplatePermissionsResponse_templateId :: Lens' UpdateTemplatePermissionsResponse (Maybe Text) Source #

The ID for the template.

updateTemplatePermissionsResponse_status :: Lens' UpdateTemplatePermissionsResponse Int Source #

The HTTP status of the request.

UpdateTheme

updateTheme_configuration :: Lens' UpdateTheme (Maybe ThemeConfiguration) Source #

The theme configuration, which contains the theme display properties.

updateTheme_name :: Lens' UpdateTheme (Maybe Text) Source #

The name for the theme.

updateTheme_versionDescription :: Lens' UpdateTheme (Maybe Text) Source #

A description of the theme version that you're updating Every time that you call UpdateTheme, you create a new version of the theme. Each version of the theme maintains a description of the version in VersionDescription.

updateTheme_awsAccountId :: Lens' UpdateTheme Text Source #

The ID of the Amazon Web Services account that contains the theme that you're updating.

updateTheme_themeId :: Lens' UpdateTheme Text Source #

The ID for the theme.

updateTheme_baseThemeId :: Lens' UpdateTheme Text Source #

The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.

updateThemeResponse_arn :: Lens' UpdateThemeResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the theme.

updateThemeResponse_creationStatus :: Lens' UpdateThemeResponse (Maybe ResourceStatus) Source #

The creation status of the theme.

updateThemeResponse_requestId :: Lens' UpdateThemeResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateThemeResponse_themeId :: Lens' UpdateThemeResponse (Maybe Text) Source #

The ID for the theme.

updateThemeResponse_versionArn :: Lens' UpdateThemeResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the new version of the theme.

updateThemeResponse_status :: Lens' UpdateThemeResponse Int Source #

The HTTP status of the request.

UpdateThemeAlias

updateThemeAlias_awsAccountId :: Lens' UpdateThemeAlias Text Source #

The ID of the Amazon Web Services account that contains the theme alias that you're updating.

updateThemeAlias_themeId :: Lens' UpdateThemeAlias Text Source #

The ID for the theme.

updateThemeAlias_aliasName :: Lens' UpdateThemeAlias Text Source #

The name of the theme alias that you want to update.

updateThemeAlias_themeVersionNumber :: Lens' UpdateThemeAlias Natural Source #

The version number of the theme that the alias should reference.

updateThemeAliasResponse_requestId :: Lens' UpdateThemeAliasResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateThemeAliasResponse_themeAlias :: Lens' UpdateThemeAliasResponse (Maybe ThemeAlias) Source #

Information about the theme alias.

updateThemeAliasResponse_status :: Lens' UpdateThemeAliasResponse Int Source #

The HTTP status of the request.

UpdateThemePermissions

updateThemePermissions_grantPermissions :: Lens' UpdateThemePermissions (Maybe [ResourcePermission]) Source #

A list of resource permissions to be granted for the theme.

updateThemePermissions_revokePermissions :: Lens' UpdateThemePermissions (Maybe [ResourcePermission]) Source #

A list of resource permissions to be revoked from the theme.

updateThemePermissions_awsAccountId :: Lens' UpdateThemePermissions Text Source #

The ID of the Amazon Web Services account that contains the theme.

updateThemePermissions_themeId :: Lens' UpdateThemePermissions Text Source #

The ID for the theme.

updateThemePermissionsResponse_permissions :: Lens' UpdateThemePermissionsResponse (Maybe (NonEmpty ResourcePermission)) Source #

The resulting list of resource permissions for the theme.

updateThemePermissionsResponse_requestId :: Lens' UpdateThemePermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateThemePermissionsResponse_themeArn :: Lens' UpdateThemePermissionsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the theme.

updateThemePermissionsResponse_themeId :: Lens' UpdateThemePermissionsResponse (Maybe Text) Source #

The ID for the theme.

updateThemePermissionsResponse_status :: Lens' UpdateThemePermissionsResponse Int Source #

The HTTP status of the request.

UpdateUser

updateUser_customFederationProviderUrl :: Lens' UpdateUser (Maybe Text) Source #

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

updateUser_customPermissionsName :: Lens' UpdateUser (Maybe Text) Source #

(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:

Create and update data sources
Create and update datasets
Create and update email reports
Subscribe to email reports

A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader).

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

updateUser_externalLoginFederationProviderType :: Lens' UpdateUser (Maybe Text) Source #

The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.
CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.
NONE: This clears all the previously saved external login information for a user. Use the DescribeUser API operation to check the external login information.

updateUser_externalLoginId :: Lens' UpdateUser (Maybe Text) Source #

The identity ID for a user in the external login provider.

updateUser_unapplyCustomPermissions :: Lens' UpdateUser (Maybe Bool) Source #

A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn't accept any other value.

updateUser_userName :: Lens' UpdateUser Text Source #

The Amazon QuickSight user name that you want to update.

updateUser_awsAccountId :: Lens' UpdateUser Text Source #

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

updateUser_namespace :: Lens' UpdateUser Text Source #

The namespace. Currently, you should set this to default.

updateUser_email :: Lens' UpdateUser Text Source #

The email address of the user that you want to update.

updateUser_role :: Lens' UpdateUser UserRole Source #

The Amazon QuickSight role of the user. The role can be one of the following default security cohorts:

READER: A user who has read-only access to dashboards.
AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.
ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.

The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.

updateUserResponse_requestId :: Lens' UpdateUserResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateUserResponse_user :: Lens' UpdateUserResponse (Maybe User) Source #

The Amazon QuickSight user.

updateUserResponse_status :: Lens' UpdateUserResponse Int Source #

The HTTP status of the request.

Types

AccountCustomization

accountCustomization_defaultEmailCustomizationTemplate :: Lens' AccountCustomization (Maybe Text) Source #

The default email customization template.

accountCustomization_defaultTheme :: Lens' AccountCustomization (Maybe Text) Source #

The default theme for this Amazon QuickSight subscription.

AccountInfo

accountInfo_accountName :: Lens' AccountInfo (Maybe Text) Source #

The account name that you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It's unique over all of Amazon Web Services, and it appears only when users sign in.

accountInfo_accountSubscriptionStatus :: Lens' AccountInfo (Maybe Text) Source #

The status of your account subscription.

accountInfo_authenticationType :: Lens' AccountInfo (Maybe Text) Source #

The way that your Amazon QuickSight account is authenticated.

accountInfo_edition :: Lens' AccountInfo (Maybe Edition) Source #

The edition of your Amazon QuickSight account.

accountInfo_notificationEmail :: Lens' AccountInfo (Maybe Text) Source #

The email address that will be used for Amazon QuickSight to send notifications regarding your Amazon Web Services account or Amazon QuickSight subscription.

AccountSettings

accountSettings_accountName :: Lens' AccountSettings (Maybe Text) Source #

The "account name" you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and it appears only when users sign in.

accountSettings_defaultNamespace :: Lens' AccountSettings (Maybe Text) Source #

The default Amazon QuickSight namespace for your Amazon Web Services account.

accountSettings_edition :: Lens' AccountSettings (Maybe Edition) Source #

The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.

accountSettings_notificationEmail :: Lens' AccountSettings (Maybe Text) Source #

The main notification email for your Amazon QuickSight subscription.

accountSettings_publicSharingEnabled :: Lens' AccountSettings (Maybe Bool) Source #

A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For more information about turning on public sharing, see UpdatePublicSharingSettings.

accountSettings_terminationProtectionEnabled :: Lens' AccountSettings (Maybe Bool) Source #

A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubsctiption request. A False value will allow the ccount to be deleted.

ActiveIAMPolicyAssignment

activeIAMPolicyAssignment_assignmentName :: Lens' ActiveIAMPolicyAssignment (Maybe Text) Source #

A name for the IAM policy assignment.

activeIAMPolicyAssignment_policyArn :: Lens' ActiveIAMPolicyAssignment (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource.

AdHocFilteringOption

adHocFilteringOption_availabilityStatus :: Lens' AdHocFilteringOption (Maybe DashboardBehavior) Source #

Availability status.

AggregationFunction

aggregationFunction_categoricalAggregationFunction :: Lens' AggregationFunction (Maybe CategoricalAggregationFunction) Source #

Aggregation for categorical values.

COUNT: Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT: Aggregate by the total number of distinct values.

aggregationFunction_dateAggregationFunction :: Lens' AggregationFunction (Maybe DateAggregationFunction) Source #

Aggregation for date values.

COUNT: Aggregate by the total number of values, including duplicates.
DISTINCT_COUNT: Aggregate by the total number of distinct values.
MIN: Select the smallest date value.
MAX: Select the largest date value.

aggregationFunction_numericalAggregationFunction :: Lens' AggregationFunction (Maybe NumericalAggregationFunction) Source #

Aggregation for numerical values.

AggregationSortConfiguration

aggregationSortConfiguration_column :: Lens' AggregationSortConfiguration ColumnIdentifier Source #

The column that determines the sort order of aggregated values.

aggregationSortConfiguration_sortDirection :: Lens' AggregationSortConfiguration SortDirection Source #

The sort direction of values.

ASC: Sort in ascending order.
DESC: Sort in descending order.

aggregationSortConfiguration_aggregationFunction :: Lens' AggregationSortConfiguration AggregationFunction Source #

The function that aggregates the values in Column.

AmazonElasticsearchParameters

amazonElasticsearchParameters_domain :: Lens' AmazonElasticsearchParameters Text Source #

The OpenSearch domain.

AmazonOpenSearchParameters

amazonOpenSearchParameters_domain :: Lens' AmazonOpenSearchParameters Text Source #

The OpenSearch domain.

Analysis

analysis_analysisId :: Lens' Analysis (Maybe Text) Source #

The ID of the analysis.

analysis_arn :: Lens' Analysis (Maybe Text) Source #

The Amazon Resource Name (ARN) of the analysis.

analysis_createdTime :: Lens' Analysis (Maybe UTCTime) Source #

The time that the analysis was created.

analysis_dataSetArns :: Lens' Analysis (Maybe [Text]) Source #

The ARNs of the datasets of the analysis.

analysis_errors :: Lens' Analysis (Maybe (NonEmpty AnalysisError)) Source #

Errors associated with the analysis.

analysis_lastUpdatedTime :: Lens' Analysis (Maybe UTCTime) Source #

The time that the analysis was last updated.

analysis_name :: Lens' Analysis (Maybe Text) Source #

The descriptive name of the analysis.

analysis_sheets :: Lens' Analysis (Maybe [Sheet]) Source #

A list of the associated sheets with the unique identifier and name of each sheet.

analysis_status :: Lens' Analysis (Maybe ResourceStatus) Source #

Status associated with the analysis.

analysis_themeArn :: Lens' Analysis (Maybe Text) Source #

The ARN of the theme of the analysis.

AnalysisDefaults

analysisDefaults_defaultNewSheetConfiguration :: Lens' AnalysisDefaults DefaultNewSheetConfiguration Source #

The configuration for default new sheet settings.

AnalysisDefinition

analysisDefinition_analysisDefaults :: Lens' AnalysisDefinition (Maybe AnalysisDefaults) Source #

Undocumented member.

analysisDefinition_calculatedFields :: Lens' AnalysisDefinition (Maybe [CalculatedField]) Source #

An array of calculated field definitions for the analysis.

analysisDefinition_columnConfigurations :: Lens' AnalysisDefinition (Maybe [ColumnConfiguration]) Source #

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.

analysisDefinition_filterGroups :: Lens' AnalysisDefinition (Maybe [FilterGroup]) Source #

Filter definitions for an analysis.

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

analysisDefinition_parameterDeclarations :: Lens' AnalysisDefinition (Maybe [ParameterDeclaration]) Source #

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 QuickSight in the Amazon QuickSight User Guide.

analysisDefinition_sheets :: Lens' AnalysisDefinition (Maybe [SheetDefinition]) Source #

An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis.

analysisDefinition_dataSetIdentifierDeclarations :: Lens' AnalysisDefinition (NonEmpty DataSetIdentifierDeclaration) Source #

An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.

AnalysisError

analysisError_message :: Lens' AnalysisError (Maybe Text) Source #

The message associated with the analysis error.

analysisError_type :: Lens' AnalysisError (Maybe AnalysisErrorType) Source #

The type of the analysis error.

analysisError_violatedEntities :: Lens' AnalysisError (Maybe [Entity]) Source #

AnalysisSearchFilter

analysisSearchFilter_name :: Lens' AnalysisSearchFilter (Maybe AnalysisFilterAttribute) Source #

The name of the value that you want to use as a filter, for example "Name": "QUICKSIGHT_OWNER".

Valid values are defined as follows:

QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the analysis' owners or viewers are returned. Implicit permissions from folders or groups are considered.
QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are considered.
DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups are not considered.
ANALYSIS_NAME: Any analyses whose names have a substring match to this value will be returned.

analysisSearchFilter_operator :: Lens' AnalysisSearchFilter (Maybe FilterOperator) Source #

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value ANALYSIS_NAME.

analysisSearchFilter_value :: Lens' AnalysisSearchFilter (Maybe Text) Source #

The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter, for example "Value". An example is "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

AnalysisSourceEntity

analysisSourceEntity_sourceTemplate :: Lens' AnalysisSourceEntity (Maybe AnalysisSourceTemplate) Source #

The source template for the source entity of the analysis.

AnalysisSourceTemplate

analysisSourceTemplate_dataSetReferences :: Lens' AnalysisSourceTemplate (NonEmpty DataSetReference) Source #

The dataset references of the source template of an analysis.

analysisSourceTemplate_arn :: Lens' AnalysisSourceTemplate Text Source #

The Amazon Resource Name (ARN) of the source template of an analysis.

AnalysisSummary

analysisSummary_analysisId :: Lens' AnalysisSummary (Maybe Text) Source #

The ID of the analysis. This ID displays in the URL.

analysisSummary_arn :: Lens' AnalysisSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) for the analysis.

analysisSummary_createdTime :: Lens' AnalysisSummary (Maybe UTCTime) Source #

The time that the analysis was created.

analysisSummary_lastUpdatedTime :: Lens' AnalysisSummary (Maybe UTCTime) Source #

The time that the analysis was last updated.

analysisSummary_name :: Lens' AnalysisSummary (Maybe Text) Source #

The name of the analysis. This name is displayed in the Amazon QuickSight console.

analysisSummary_status :: Lens' AnalysisSummary (Maybe ResourceStatus) Source #

The last known status for the analysis.

AnchorDateConfiguration

anchorDateConfiguration_anchorOption :: Lens' AnchorDateConfiguration (Maybe AnchorOption) Source #

The options for the date configuration. Choose one of the options below:

```
NOW
```

anchorDateConfiguration_parameterName :: Lens' AnchorDateConfiguration (Maybe Text) Source #

The name of the parameter that is used for the anchor date configuration.

AnonymousUserDashboardEmbeddingConfiguration

anonymousUserDashboardEmbeddingConfiguration_initialDashboardId :: Lens' AnonymousUserDashboardEmbeddingConfiguration Text Source #

The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard.

The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

AnonymousUserDashboardVisualEmbeddingConfiguration

anonymousUserDashboardVisualEmbeddingConfiguration_initialDashboardVisualId :: Lens' AnonymousUserDashboardVisualEmbeddingConfiguration DashboardVisualId Source #

The visual ID for the visual that you want the user to see. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

AnonymousUserEmbeddingExperienceConfiguration

anonymousUserEmbeddingExperienceConfiguration_dashboard :: Lens' AnonymousUserEmbeddingExperienceConfiguration (Maybe AnonymousUserDashboardEmbeddingConfiguration) Source #

The type of embedding experience. In this case, Amazon QuickSight dashboards.

anonymousUserEmbeddingExperienceConfiguration_dashboardVisual :: Lens' AnonymousUserEmbeddingExperienceConfiguration (Maybe AnonymousUserDashboardVisualEmbeddingConfiguration) Source #

The type of embedding experience. In this case, Amazon QuickSight visuals.

anonymousUserEmbeddingExperienceConfiguration_qSearchBar :: Lens' AnonymousUserEmbeddingExperienceConfiguration (Maybe AnonymousUserQSearchBarEmbeddingConfiguration) Source #

The Q search bar that you want to use for anonymous user embedding.

AnonymousUserQSearchBarEmbeddingConfiguration

anonymousUserQSearchBarEmbeddingConfiguration_initialTopicId :: Lens' AnonymousUserQSearchBarEmbeddingConfiguration Text Source #

The QuickSight Q topic ID of the topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this topic pre-selected.

The Amazon Resource Name (ARN) of this Q topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

ArcAxisConfiguration

arcAxisConfiguration_range :: Lens' ArcAxisConfiguration (Maybe ArcAxisDisplayRange) Source #

The arc axis range of a GaugeChartVisual.

arcAxisConfiguration_reserveRange :: Lens' ArcAxisConfiguration (Maybe Int) Source #

The reserved range of the arc axis.

ArcAxisDisplayRange

arcAxisDisplayRange_max :: Lens' ArcAxisDisplayRange (Maybe Double) Source #

The maximum value of the arc axis range.

arcAxisDisplayRange_min :: Lens' ArcAxisDisplayRange (Maybe Double) Source #

The minimum value of the arc axis range.

ArcConfiguration

arcConfiguration_arcAngle :: Lens' ArcConfiguration (Maybe Double) Source #

The option that determines the arc angle of a GaugeChartVisual.

arcConfiguration_arcThickness :: Lens' ArcConfiguration (Maybe ArcThicknessOptions) Source #

The options that determine the arc thickness of a GaugeChartVisual.

ArcOptions

arcOptions_arcThickness :: Lens' ArcOptions (Maybe ArcThickness) Source #

The arc thickness of a GaugeChartVisual.

AthenaParameters

athenaParameters_roleArn :: Lens' AthenaParameters (Maybe Text) Source #

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.

athenaParameters_workGroup :: Lens' AthenaParameters (Maybe Text) Source #

The workgroup that Amazon Athena uses.

AuroraParameters

auroraParameters_host :: Lens' AuroraParameters Text Source #

Host.

auroraParameters_port :: Lens' AuroraParameters Natural Source #

Port.

auroraParameters_database :: Lens' AuroraParameters Text Source #

Database.

AuroraPostgreSqlParameters

auroraPostgreSqlParameters_host :: Lens' AuroraPostgreSqlParameters Text Source #

The Amazon Aurora PostgreSQL-Compatible host to connect to.

auroraPostgreSqlParameters_port :: Lens' AuroraPostgreSqlParameters Natural Source #

The port that Amazon Aurora PostgreSQL is listening on.

auroraPostgreSqlParameters_database :: Lens' AuroraPostgreSqlParameters Text Source #

The Amazon Aurora PostgreSQL database to connect to.

AwsIotAnalyticsParameters

awsIotAnalyticsParameters_dataSetName :: Lens' AwsIotAnalyticsParameters Text Source #

Dataset name.

AxisDataOptions

axisDataOptions_dateAxisOptions :: Lens' AxisDataOptions (Maybe DateAxisOptions) Source #

The options for an axis with a date field.

axisDataOptions_numericAxisOptions :: Lens' AxisDataOptions (Maybe NumericAxisOptions) Source #

The options for an axis with a numeric field.

AxisDisplayDataDrivenRange

AxisDisplayMinMaxRange

axisDisplayMinMaxRange_maximum :: Lens' AxisDisplayMinMaxRange (Maybe Double) Source #

The maximum setup for an axis display range.

axisDisplayMinMaxRange_minimum :: Lens' AxisDisplayMinMaxRange (Maybe Double) Source #

The minimum setup for an axis display range.

AxisDisplayOptions

axisDisplayOptions_axisLineVisibility :: Lens' AxisDisplayOptions (Maybe Visibility) Source #

Determines whether or not the axis line is visible.

axisDisplayOptions_axisOffset :: Lens' AxisDisplayOptions (Maybe Text) Source #

The offset value that determines the starting placement of the axis within a visual's bounds.

axisDisplayOptions_dataOptions :: Lens' AxisDisplayOptions (Maybe AxisDataOptions) Source #

The data options for an axis.

axisDisplayOptions_gridLineVisibility :: Lens' AxisDisplayOptions (Maybe Visibility) Source #

Determines whether or not the grid line is visible.

axisDisplayOptions_scrollbarOptions :: Lens' AxisDisplayOptions (Maybe ScrollBarOptions) Source #

The scroll bar options for an axis.

axisDisplayOptions_tickLabelOptions :: Lens' AxisDisplayOptions (Maybe AxisTickLabelOptions) Source #

The tick label options of an axis.

AxisDisplayRange

axisDisplayRange_dataDriven :: Lens' AxisDisplayRange (Maybe AxisDisplayDataDrivenRange) Source #

The data-driven setup of an axis display range.

axisDisplayRange_minMax :: Lens' AxisDisplayRange (Maybe AxisDisplayMinMaxRange) Source #

The minimum and maximum setup of an axis display range.

AxisLabelOptions

axisLabelOptions_applyTo :: Lens' AxisLabelOptions (Maybe AxisLabelReferenceOptions) Source #

The options that indicate which field the label belongs to.

axisLabelOptions_customLabel :: Lens' AxisLabelOptions (Maybe Text) Source #

The text for the axis label.

axisLabelOptions_fontConfiguration :: Lens' AxisLabelOptions (Maybe FontConfiguration) Source #

The font configuration of the axis label.

AxisLabelReferenceOptions

axisLabelReferenceOptions_fieldId :: Lens' AxisLabelReferenceOptions Text Source #

The field that the axis label is targeted to.

axisLabelReferenceOptions_column :: Lens' AxisLabelReferenceOptions ColumnIdentifier Source #

The column that the axis label is targeted to.

AxisLinearScale

axisLinearScale_stepCount :: Lens' AxisLinearScale (Maybe Int) Source #

The step count setup of a linear axis.

axisLinearScale_stepSize :: Lens' AxisLinearScale (Maybe Double) Source #

The step size setup of a linear axis.

AxisLogarithmicScale

axisLogarithmicScale_base :: Lens' AxisLogarithmicScale (Maybe Double) Source #

The base setup of a logarithmic axis scale.

AxisScale

axisScale_linear :: Lens' AxisScale (Maybe AxisLinearScale) Source #

The linear axis scale setup.

axisScale_logarithmic :: Lens' AxisScale (Maybe AxisLogarithmicScale) Source #

The logarithmic axis scale setup.

AxisTickLabelOptions

axisTickLabelOptions_labelOptions :: Lens' AxisTickLabelOptions (Maybe LabelOptions) Source #

Determines whether or not the axis ticks are visible.

axisTickLabelOptions_rotationAngle :: Lens' AxisTickLabelOptions (Maybe Double) Source #

The rotation angle of the axis tick labels.

BarChartAggregatedFieldWells

barChartAggregatedFieldWells_category :: Lens' BarChartAggregatedFieldWells (Maybe [DimensionField]) Source #

The category (y-axis) field well of a bar chart.

barChartAggregatedFieldWells_colors :: Lens' BarChartAggregatedFieldWells (Maybe [DimensionField]) Source #

The color (group/color) field well of a bar chart.

barChartAggregatedFieldWells_smallMultiples :: Lens' BarChartAggregatedFieldWells (Maybe [DimensionField]) Source #

The small multiples field well of a bar chart.

barChartAggregatedFieldWells_values :: Lens' BarChartAggregatedFieldWells (Maybe [MeasureField]) Source #

The value field wells of a bar chart. Values are aggregated by category.

BarChartConfiguration

barChartConfiguration_barsArrangement :: Lens' BarChartConfiguration (Maybe BarsArrangement) Source #

Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.

barChartConfiguration_categoryAxis :: Lens' BarChartConfiguration (Maybe AxisDisplayOptions) Source #

The label display options (grid line, range, scale, axis step) for bar chart category.

barChartConfiguration_categoryLabelOptions :: Lens' BarChartConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options (label text, label visibility and sort icon visibility) for a bar chart.

barChartConfiguration_colorLabelOptions :: Lens' BarChartConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.

barChartConfiguration_contributionAnalysisDefaults :: Lens' BarChartConfiguration (Maybe (NonEmpty ContributionAnalysisDefault)) Source #

The contribution analysis (anomaly configuration) setup of the visual.

barChartConfiguration_dataLabels :: Lens' BarChartConfiguration (Maybe DataLabelOptions) Source #

The options that determine if visual data labels are displayed.

barChartConfiguration_fieldWells :: Lens' BarChartConfiguration (Maybe BarChartFieldWells) Source #

The field wells of the visual.

barChartConfiguration_legend :: Lens' BarChartConfiguration (Maybe LegendOptions) Source #

The legend display setup of the visual.

barChartConfiguration_orientation :: Lens' BarChartConfiguration (Maybe BarChartOrientation) Source #

The orientation of the bars in a bar chart visual. There are two valid values in this structure:

HORIZONTAL: Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.
VERTICAL: Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.

barChartConfiguration_referenceLines :: Lens' BarChartConfiguration (Maybe [ReferenceLine]) Source #

The reference line setup of the visual.

barChartConfiguration_smallMultiplesOptions :: Lens' BarChartConfiguration (Maybe SmallMultiplesOptions) Source #

The small multiples setup for the visual.

barChartConfiguration_sortConfiguration :: Lens' BarChartConfiguration (Maybe BarChartSortConfiguration) Source #

The sort configuration of a BarChartVisual.

barChartConfiguration_tooltip :: Lens' BarChartConfiguration (Maybe TooltipOptions) Source #

The tooltip display setup of the visual.

barChartConfiguration_valueAxis :: Lens' BarChartConfiguration (Maybe AxisDisplayOptions) Source #

The label display options (grid line, range, scale, axis step) for a bar chart value.

barChartConfiguration_valueLabelOptions :: Lens' BarChartConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options (label text, label visibility and sort icon visibility) for a bar chart value.

barChartConfiguration_visualPalette :: Lens' BarChartConfiguration (Maybe VisualPalette) Source #

The palette (chart color) display setup of the visual.

BarChartFieldWells

barChartFieldWells_barChartAggregatedFieldWells :: Lens' BarChartFieldWells (Maybe BarChartAggregatedFieldWells) Source #

The aggregated field wells of a bar chart.

BarChartSortConfiguration

barChartSortConfiguration_categoryItemsLimit :: Lens' BarChartSortConfiguration (Maybe ItemsLimitConfiguration) Source #

The limit on the number of categories displayed in a bar chart.

barChartSortConfiguration_categorySort :: Lens' BarChartSortConfiguration (Maybe [FieldSortOptions]) Source #

The sort configuration of category fields.

barChartSortConfiguration_colorItemsLimit :: Lens' BarChartSortConfiguration (Maybe ItemsLimitConfiguration) Source #

The limit on the number of values displayed in a bar chart.

barChartSortConfiguration_colorSort :: Lens' BarChartSortConfiguration (Maybe [FieldSortOptions]) Source #

The sort configuration of color fields in a bar chart.

barChartSortConfiguration_smallMultiplesLimitConfiguration :: Lens' BarChartSortConfiguration (Maybe ItemsLimitConfiguration) Source #

The limit on the number of small multiples panels that are displayed.

barChartSortConfiguration_smallMultiplesSort :: Lens' BarChartSortConfiguration (Maybe [FieldSortOptions]) Source #

The sort configuration of the small multiples field.

BarChartVisual

barChartVisual_actions :: Lens' BarChartVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

barChartVisual_chartConfiguration :: Lens' BarChartVisual (Maybe BarChartConfiguration) Source #

The configuration settings of the visual.

barChartVisual_columnHierarchies :: Lens' BarChartVisual (Maybe [ColumnHierarchy]) Source #

The column hierarchy that is used during drill-downs and drill-ups.

barChartVisual_subtitle :: Lens' BarChartVisual (Maybe VisualSubtitleLabelOptions) Source #

The subtitle that is displayed on the visual.

barChartVisual_title :: Lens' BarChartVisual (Maybe VisualTitleLabelOptions) Source #

The title that is displayed on the visual.

barChartVisual_visualId :: Lens' BarChartVisual Text Source #

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.

BinCountOptions

binCountOptions_value :: Lens' BinCountOptions (Maybe Natural) Source #

The options that determine the bin count value.

BinWidthOptions

binWidthOptions_binCountLimit :: Lens' BinWidthOptions (Maybe Natural) Source #

The options that determine the bin count limit.

binWidthOptions_value :: Lens' BinWidthOptions (Maybe Double) Source #

The options that determine the bin width value.

BodySectionConfiguration

bodySectionConfiguration_pageBreakConfiguration :: Lens' BodySectionConfiguration (Maybe SectionPageBreakConfiguration) Source #

The configuration of a page break for a section.

bodySectionConfiguration_style :: Lens' BodySectionConfiguration (Maybe SectionStyle) Source #

The style options of a body section.

bodySectionConfiguration_sectionId :: Lens' BodySectionConfiguration Text Source #

The unique identifier of a body section.

bodySectionConfiguration_content :: Lens' BodySectionConfiguration BodySectionContent Source #

The configuration of content in a body section.

BodySectionContent

bodySectionContent_layout :: Lens' BodySectionContent (Maybe SectionLayoutConfiguration) Source #

The layout configuration of a body section.

BorderStyle

borderStyle_show :: Lens' BorderStyle (Maybe Bool) Source #

The option to enable display of borders for visuals.

BoxPlotAggregatedFieldWells

boxPlotAggregatedFieldWells_groupBy :: Lens' BoxPlotAggregatedFieldWells (Maybe [DimensionField]) Source #

The group by field well of a box plot chart. Values are grouped based on group by fields.

boxPlotAggregatedFieldWells_values :: Lens' BoxPlotAggregatedFieldWells (Maybe [MeasureField]) Source #

The value field well of a box plot chart. Values are aggregated based on group by fields.

BoxPlotChartConfiguration

boxPlotChartConfiguration_boxPlotOptions :: Lens' BoxPlotChartConfiguration (Maybe BoxPlotOptions) Source #

The box plot chart options for a box plot visual

boxPlotChartConfiguration_categoryAxis :: Lens' BoxPlotChartConfiguration (Maybe AxisDisplayOptions) Source #

The label display options (grid line, range, scale, axis step) of a box plot category.

boxPlotChartConfiguration_categoryLabelOptions :: Lens' BoxPlotChartConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options (label text, label visibility and sort Icon visibility) of a box plot category.

boxPlotChartConfiguration_fieldWells :: Lens' BoxPlotChartConfiguration (Maybe BoxPlotFieldWells) Source #

The field wells of the visual.

boxPlotChartConfiguration_legend :: Lens' BoxPlotChartConfiguration (Maybe LegendOptions) Source #

Undocumented member.

boxPlotChartConfiguration_primaryYAxisDisplayOptions :: Lens' BoxPlotChartConfiguration (Maybe AxisDisplayOptions) Source #

The label display options (grid line, range, scale, axis step) of a box plot category.

boxPlotChartConfiguration_primaryYAxisLabelOptions :: Lens' BoxPlotChartConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options (label text, label visibility and sort icon visibility) of a box plot value.

boxPlotChartConfiguration_referenceLines :: Lens' BoxPlotChartConfiguration (Maybe [ReferenceLine]) Source #

The reference line setup of the visual.

boxPlotChartConfiguration_sortConfiguration :: Lens' BoxPlotChartConfiguration (Maybe BoxPlotSortConfiguration) Source #

The sort configuration of a BoxPlotVisual.

boxPlotChartConfiguration_tooltip :: Lens' BoxPlotChartConfiguration (Maybe TooltipOptions) Source #

The tooltip display setup of the visual.

boxPlotChartConfiguration_visualPalette :: Lens' BoxPlotChartConfiguration (Maybe VisualPalette) Source #

The palette (chart color) display setup of the visual.

BoxPlotFieldWells

boxPlotFieldWells_boxPlotAggregatedFieldWells :: Lens' BoxPlotFieldWells (Maybe BoxPlotAggregatedFieldWells) Source #

The aggregated field wells of a box plot.

BoxPlotOptions

boxPlotOptions_allDataPointsVisibility :: Lens' BoxPlotOptions (Maybe Visibility) Source #

Determines the visibility of all data points of the box plot.

boxPlotOptions_outlierVisibility :: Lens' BoxPlotOptions (Maybe Visibility) Source #

Determines the visibility of the outlier in a box plot.

boxPlotOptions_styleOptions :: Lens' BoxPlotOptions (Maybe BoxPlotStyleOptions) Source #

The style options of the box plot.

BoxPlotSortConfiguration

boxPlotSortConfiguration_categorySort :: Lens' BoxPlotSortConfiguration (Maybe [FieldSortOptions]) Source #

The sort configuration of a group by fields.

boxPlotSortConfiguration_paginationConfiguration :: Lens' BoxPlotSortConfiguration (Maybe PaginationConfiguration) Source #

The pagination configuration of a table visual or box plot.

BoxPlotStyleOptions

boxPlotStyleOptions_fillStyle :: Lens' BoxPlotStyleOptions (Maybe BoxPlotFillStyle) Source #

The fill styles (solid, transparent) of the box plot.

BoxPlotVisual

boxPlotVisual_actions :: Lens' BoxPlotVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

boxPlotVisual_chartConfiguration :: Lens' BoxPlotVisual (Maybe BoxPlotChartConfiguration) Source #

The configuration settings of the visual.

boxPlotVisual_columnHierarchies :: Lens' BoxPlotVisual (Maybe [ColumnHierarchy]) Source #

The column hierarchy that is used during drill-downs and drill-ups.

boxPlotVisual_subtitle :: Lens' BoxPlotVisual (Maybe VisualSubtitleLabelOptions) Source #

The subtitle that is displayed on the visual.

boxPlotVisual_title :: Lens' BoxPlotVisual (Maybe VisualTitleLabelOptions) Source #

The title that is displayed on the visual.

boxPlotVisual_visualId :: Lens' BoxPlotVisual Text Source #

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..

CalculatedColumn

calculatedColumn_columnName :: Lens' CalculatedColumn Text Source #

Column name.

calculatedColumn_columnId :: Lens' CalculatedColumn Text Source #

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, Amazon QuickSight preserves the existing calculated column.

calculatedColumn_expression :: Lens' CalculatedColumn Text Source #

An expression that defines the calculated column.

CalculatedField

calculatedField_dataSetIdentifier :: Lens' CalculatedField Text Source #

The data set that is used in this calculated field.

calculatedField_name :: Lens' CalculatedField Text Source #

The name of the calculated field.

calculatedField_expression :: Lens' CalculatedField Text Source #

The expression of the calculated field.

CalculatedMeasureField

calculatedMeasureField_fieldId :: Lens' CalculatedMeasureField Text Source #

The custom field ID.

calculatedMeasureField_expression :: Lens' CalculatedMeasureField Text Source #

The expression in the table calculation.

CascadingControlConfiguration

cascadingControlConfiguration_sourceControls :: Lens' CascadingControlConfiguration (Maybe [CascadingControlSource]) Source #

A list of source controls that determine the values that are used in the current control.

CascadingControlSource

cascadingControlSource_columnToMatch :: Lens' CascadingControlSource (Maybe ColumnIdentifier) Source #

The column identifier that determines which column to look up for the source sheet control.

cascadingControlSource_sourceSheetControlId :: Lens' CascadingControlSource (Maybe Text) Source #

The source sheet control ID of a CascadingControlSource.

CastColumnTypeOperation

castColumnTypeOperation_format :: Lens' CastColumnTypeOperation (Maybe Text) Source #

When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.

castColumnTypeOperation_columnName :: Lens' CastColumnTypeOperation Text Source #

Column name.

castColumnTypeOperation_newColumnType :: Lens' CastColumnTypeOperation ColumnDataType Source #

New column data type.

CategoricalDimensionField

categoricalDimensionField_formatConfiguration :: Lens' CategoricalDimensionField (Maybe StringFormatConfiguration) Source #

The format configuration of the field.

categoricalDimensionField_hierarchyId :: Lens' CategoricalDimensionField (Maybe Text) Source #

The custom hierarchy ID.

categoricalDimensionField_fieldId :: Lens' CategoricalDimensionField Text Source #

The custom field ID.

categoricalDimensionField_column :: Lens' CategoricalDimensionField ColumnIdentifier Source #

The column that is used in the CategoricalDimensionField.

CategoricalMeasureField

categoricalMeasureField_aggregationFunction :: Lens' CategoricalMeasureField (Maybe CategoricalAggregationFunction) Source #

The aggregation function of the measure field.

categoricalMeasureField_formatConfiguration :: Lens' CategoricalMeasureField (Maybe StringFormatConfiguration) Source #

The format configuration of the field.

categoricalMeasureField_fieldId :: Lens' CategoricalMeasureField Text Source #

The custom field ID.

categoricalMeasureField_column :: Lens' CategoricalMeasureField ColumnIdentifier Source #

The column that is used in the CategoricalMeasureField.

CategoryDrillDownFilter

categoryDrillDownFilter_column :: Lens' CategoryDrillDownFilter ColumnIdentifier Source #

The column that the filter is applied to.

categoryDrillDownFilter_categoryValues :: Lens' CategoryDrillDownFilter [Text] Source #

A list of the string inputs that are the values of the category drill down filter.

CategoryFilter

categoryFilter_configuration :: Lens' CategoryFilter (Maybe CategoryFilterConfiguration) Source #

The configuration for a CategoryFilter.

categoryFilter_filterId :: Lens' CategoryFilter Text Source #

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

categoryFilter_column :: Lens' CategoryFilter ColumnIdentifier Source #

The column that the filter is applied to.

CategoryFilterConfiguration

categoryFilterConfiguration_customFilterConfiguration :: Lens' CategoryFilterConfiguration (Maybe CustomFilterConfiguration) Source #

A custom filter that filters based on a single value. This filter can be partially matched.

categoryFilterConfiguration_customFilterListConfiguration :: Lens' CategoryFilterConfiguration (Maybe CustomFilterListConfiguration) Source #

A list of custom filter values. In the Amazon QuickSight console, this filter type is called a custom filter list.

categoryFilterConfiguration_filterListConfiguration :: Lens' CategoryFilterConfiguration (Maybe FilterListConfiguration) Source #

A list of filter configurations. In the Amazon QuickSight console, this filter type is called a filter list.

ChartAxisLabelOptions

chartAxisLabelOptions_axisLabelOptions :: Lens' ChartAxisLabelOptions (Maybe [AxisLabelOptions]) Source #

The label options for a chart axis.

chartAxisLabelOptions_sortIconVisibility :: Lens' ChartAxisLabelOptions (Maybe Visibility) Source #

The visibility configuration of the sort icon on a chart's axis label.

chartAxisLabelOptions_visibility :: Lens' ChartAxisLabelOptions (Maybe Visibility) Source #

The visibility of an axis label on a chart. Choose one of the following options:

VISIBLE: Shows the axis.
HIDDEN: Hides the axis.

ClusterMarker

clusterMarker_simpleClusterMarker :: Lens' ClusterMarker (Maybe SimpleClusterMarker) Source #

The simple cluster marker of the cluster marker.

ClusterMarkerConfiguration

clusterMarkerConfiguration_clusterMarker :: Lens' ClusterMarkerConfiguration (Maybe ClusterMarker) Source #

The cluster marker that is a part of the cluster marker configuration

ColorScale

colorScale_nullValueColor :: Lens' ColorScale (Maybe DataColor) Source #

Determines the color that is applied to null values.

colorScale_colors :: Lens' ColorScale (NonEmpty DataColor) Source #

Determines the list of colors that are applied to the visual.

colorScale_colorFillType :: Lens' ColorScale ColorFillType Source #

Determines the color fill type.

ColumnConfiguration

columnConfiguration_formatConfiguration :: Lens' ColumnConfiguration (Maybe FormatConfiguration) Source #

The format configuration of a column.

columnConfiguration_role :: Lens' ColumnConfiguration (Maybe ColumnRole) Source #

The role of the column.

columnConfiguration_column :: Lens' ColumnConfiguration ColumnIdentifier Source #

The column.

ColumnDescription

columnDescription_text :: Lens' ColumnDescription (Maybe Text) Source #

The text of a description for a column.

ColumnGroup

columnGroup_geoSpatialColumnGroup :: Lens' ColumnGroup (Maybe GeoSpatialColumnGroup) Source #

Geospatial column group that denotes a hierarchy.

ColumnGroupColumnSchema

columnGroupColumnSchema_name :: Lens' ColumnGroupColumnSchema (Maybe Text) Source #

The name of the column group's column schema.

ColumnGroupSchema

columnGroupSchema_columnGroupColumnSchemaList :: Lens' ColumnGroupSchema (Maybe [ColumnGroupColumnSchema]) Source #

A structure containing the list of schemas for column group columns.

columnGroupSchema_name :: Lens' ColumnGroupSchema (Maybe Text) Source #

The name of the column group schema.

ColumnHierarchy

columnHierarchy_dateTimeHierarchy :: Lens' ColumnHierarchy (Maybe DateTimeHierarchy) Source #

The option that determines the hierarchy of any DateTime fields.

columnHierarchy_explicitHierarchy :: Lens' ColumnHierarchy (Maybe ExplicitHierarchy) Source #

The option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.

columnHierarchy_predefinedHierarchy :: Lens' ColumnHierarchy (Maybe PredefinedHierarchy) Source #

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

ColumnIdentifier

columnIdentifier_dataSetIdentifier :: Lens' ColumnIdentifier Text Source #

The data set that the column belongs to.

columnIdentifier_columnName :: Lens' ColumnIdentifier Text Source #

The name of the column.

ColumnLevelPermissionRule

columnLevelPermissionRule_columnNames :: Lens' ColumnLevelPermissionRule (Maybe (NonEmpty Text)) Source #

An array of column names.

columnLevelPermissionRule_principals :: Lens' ColumnLevelPermissionRule (Maybe (NonEmpty Text)) Source #

An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.

ColumnSchema

columnSchema_dataType :: Lens' ColumnSchema (Maybe Text) Source #

The data type of the column schema.

columnSchema_geographicRole :: Lens' ColumnSchema (Maybe Text) Source #

The geographic role of the column schema.

columnSchema_name :: Lens' ColumnSchema (Maybe Text) Source #

The name of the column schema.

ColumnSort

columnSort_aggregationFunction :: Lens' ColumnSort (Maybe AggregationFunction) Source #

The aggregation function that is defined in the column sort.

columnSort_sortBy :: Lens' ColumnSort ColumnIdentifier Source #

Undocumented member.

columnSort_direction :: Lens' ColumnSort SortDirection Source #

The sort direction.

ColumnTag

columnTag_columnDescription :: Lens' ColumnTag (Maybe ColumnDescription) Source #

A description for a column.

columnTag_columnGeographicRole :: Lens' ColumnTag (Maybe GeoSpatialDataRole) Source #

A geospatial role for a column.

ColumnTooltipItem

columnTooltipItem_aggregation :: Lens' ColumnTooltipItem (Maybe AggregationFunction) Source #

The aggregation function of the column tooltip item.

columnTooltipItem_label :: Lens' ColumnTooltipItem (Maybe Text) Source #

The label of the tooltip item.

columnTooltipItem_visibility :: Lens' ColumnTooltipItem (Maybe Visibility) Source #

The visibility of the tooltip item.

columnTooltipItem_column :: Lens' ColumnTooltipItem ColumnIdentifier Source #

The target column of the tooltip item.

ComboChartAggregatedFieldWells

comboChartAggregatedFieldWells_barValues :: Lens' ComboChartAggregatedFieldWells (Maybe [MeasureField]) Source #

The aggregated BarValues field well of a combo chart.

comboChartAggregatedFieldWells_category :: Lens' ComboChartAggregatedFieldWells (Maybe [DimensionField]) Source #

The aggregated category field wells of a combo chart.

comboChartAggregatedFieldWells_colors :: Lens' ComboChartAggregatedFieldWells (Maybe [DimensionField]) Source #

The aggregated colors field well of a combo chart.

comboChartAggregatedFieldWells_lineValues :: Lens' ComboChartAggregatedFieldWells (Maybe [MeasureField]) Source #

The aggregated LineValues field well of a combo chart.

ComboChartConfiguration

comboChartConfiguration_barDataLabels :: Lens' ComboChartConfiguration (Maybe DataLabelOptions) Source #

The options that determine if visual data labels are displayed.

The data label options for a bar in a combo chart.

comboChartConfiguration_barsArrangement :: Lens' ComboChartConfiguration (Maybe BarsArrangement) Source #

Determines the bar arrangement in a combo chart. The following are valid values in this structure:

CLUSTERED: For clustered bar combo charts.
STACKED: For stacked bar combo charts.
STACKED_PERCENT: Do not use. If you use this value, the operation returns a validation error.

comboChartConfiguration_categoryAxis :: Lens' ComboChartConfiguration (Maybe AxisDisplayOptions) Source #

The category axis of a combo chart.

comboChartConfiguration_categoryLabelOptions :: Lens' ComboChartConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.

comboChartConfiguration_colorLabelOptions :: Lens' ComboChartConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.

comboChartConfiguration_fieldWells :: Lens' ComboChartConfiguration (Maybe ComboChartFieldWells) Source #

The field wells of the visual.

comboChartConfiguration_legend :: Lens' ComboChartConfiguration (Maybe LegendOptions) Source #

The legend display setup of the visual.

comboChartConfiguration_lineDataLabels :: Lens' ComboChartConfiguration (Maybe DataLabelOptions) Source #

The options that determine if visual data labels are displayed.

The data label options for a line in a combo chart.

comboChartConfiguration_primaryYAxisDisplayOptions :: Lens' ComboChartConfiguration (Maybe AxisDisplayOptions) Source #

The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.

comboChartConfiguration_primaryYAxisLabelOptions :: Lens' ComboChartConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.

comboChartConfiguration_referenceLines :: Lens' ComboChartConfiguration (Maybe [ReferenceLine]) Source #

The reference line setup of the visual.

comboChartConfiguration_secondaryYAxisDisplayOptions :: Lens' ComboChartConfiguration (Maybe AxisDisplayOptions) Source #

The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.

comboChartConfiguration_secondaryYAxisLabelOptions :: Lens' ComboChartConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.

comboChartConfiguration_sortConfiguration :: Lens' ComboChartConfiguration (Maybe ComboChartSortConfiguration) Source #

The sort configuration of a ComboChartVisual.

comboChartConfiguration_tooltip :: Lens' ComboChartConfiguration (Maybe TooltipOptions) Source #

The legend display setup of the visual.

comboChartConfiguration_visualPalette :: Lens' ComboChartConfiguration (Maybe VisualPalette) Source #

The palette (chart color) display setup of the visual.

ComboChartFieldWells

comboChartFieldWells_comboChartAggregatedFieldWells :: Lens' ComboChartFieldWells (Maybe ComboChartAggregatedFieldWells) Source #

The aggregated field wells of a combo chart. Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category.

ComboChartSortConfiguration

comboChartSortConfiguration_categoryItemsLimit :: Lens' ComboChartSortConfiguration (Maybe ItemsLimitConfiguration) Source #

The item limit configuration for the category field well of a combo chart.

comboChartSortConfiguration_categorySort :: Lens' ComboChartSortConfiguration (Maybe [FieldSortOptions]) Source #

The sort configuration of the category field well in a combo chart.

comboChartSortConfiguration_colorItemsLimit :: Lens' ComboChartSortConfiguration (Maybe ItemsLimitConfiguration) Source #

The item limit configuration of the color field well in a combo chart.

comboChartSortConfiguration_colorSort :: Lens' ComboChartSortConfiguration (Maybe [FieldSortOptions]) Source #

The sort configuration of the color field well in a combo chart.

ComboChartVisual

comboChartVisual_actions :: Lens' ComboChartVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

comboChartVisual_chartConfiguration :: Lens' ComboChartVisual (Maybe ComboChartConfiguration) Source #

The configuration settings of the visual.

comboChartVisual_columnHierarchies :: Lens' ComboChartVisual (Maybe [ColumnHierarchy]) Source #

The column hierarchy that is used during drill-downs and drill-ups.

comboChartVisual_subtitle :: Lens' ComboChartVisual (Maybe VisualSubtitleLabelOptions) Source #

The subtitle that is displayed on the visual.

comboChartVisual_title :: Lens' ComboChartVisual (Maybe VisualTitleLabelOptions) Source #

The title that is displayed on the visual.

comboChartVisual_visualId :: Lens' ComboChartVisual Text Source #

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.

ComparisonConfiguration

comparisonConfiguration_comparisonFormat :: Lens' ComparisonConfiguration (Maybe ComparisonFormatConfiguration) Source #

The format of the comparison.

comparisonConfiguration_comparisonMethod :: Lens' ComparisonConfiguration (Maybe ComparisonMethod) Source #

The method of the comparison. Choose from the following options:

```
DIFFERENCE
```
```
PERCENT_DIFFERENCE
```
```
PERCENT
```

ComparisonFormatConfiguration

comparisonFormatConfiguration_numberDisplayFormatConfiguration :: Lens' ComparisonFormatConfiguration (Maybe NumberDisplayFormatConfiguration) Source #

The number display format.

comparisonFormatConfiguration_percentageDisplayFormatConfiguration :: Lens' ComparisonFormatConfiguration (Maybe PercentageDisplayFormatConfiguration) Source #

The percentage display format.

Computation

computation_forecast :: Lens' Computation (Maybe ForecastComputation) Source #

The forecast computation configuration.

computation_growthRate :: Lens' Computation (Maybe GrowthRateComputation) Source #

The growth rate computation configuration.

computation_maximumMinimum :: Lens' Computation (Maybe MaximumMinimumComputation) Source #

The maximum and minimum computation configuration.

computation_metricComparison :: Lens' Computation (Maybe MetricComparisonComputation) Source #

The metric comparison computation configuration.

computation_periodOverPeriod :: Lens' Computation (Maybe PeriodOverPeriodComputation) Source #

The period over period computation configuration.

computation_periodToDate :: Lens' Computation (Maybe PeriodToDateComputation) Source #

The period to DataSetIdentifier computation configuration.

computation_topBottomMovers :: Lens' Computation (Maybe TopBottomMoversComputation) Source #

The top movers and bottom movers computation configuration.

computation_topBottomRanked :: Lens' Computation (Maybe TopBottomRankedComputation) Source #

The top ranked and bottom ranked computation configuration.

computation_totalAggregation :: Lens' Computation (Maybe TotalAggregationComputation) Source #

The total aggregation computation configuration.

computation_uniqueValues :: Lens' Computation (Maybe UniqueValuesComputation) Source #

The unique values computation configuration.

ConditionalFormattingColor

conditionalFormattingColor_gradient :: Lens' ConditionalFormattingColor (Maybe ConditionalFormattingGradientColor) Source #

Formatting configuration for gradient color.

conditionalFormattingColor_solid :: Lens' ConditionalFormattingColor (Maybe ConditionalFormattingSolidColor) Source #

Formatting configuration for solid color.

ConditionalFormattingCustomIconCondition

conditionalFormattingCustomIconCondition_color :: Lens' ConditionalFormattingCustomIconCondition (Maybe Text) Source #

Determines the color of the icon.

conditionalFormattingCustomIconCondition_displayConfiguration :: Lens' ConditionalFormattingCustomIconCondition (Maybe ConditionalFormattingIconDisplayConfiguration) Source #

Determines the icon display configuration.

conditionalFormattingCustomIconCondition_expression :: Lens' ConditionalFormattingCustomIconCondition Text Source #

The expression that determines the condition of the icon set.

conditionalFormattingCustomIconCondition_iconOptions :: Lens' ConditionalFormattingCustomIconCondition ConditionalFormattingCustomIconOptions Source #

Custom icon options for an icon set.

ConditionalFormattingCustomIconOptions

conditionalFormattingCustomIconOptions_icon :: Lens' ConditionalFormattingCustomIconOptions (Maybe Icon) Source #

Determines the type of icon.

conditionalFormattingCustomIconOptions_unicodeIcon :: Lens' ConditionalFormattingCustomIconOptions (Maybe Text) Source #

Determines the Unicode icon type.

ConditionalFormattingGradientColor

conditionalFormattingGradientColor_expression :: Lens' ConditionalFormattingGradientColor Text Source #

The expression that determines the formatting configuration for gradient color.

conditionalFormattingGradientColor_color :: Lens' ConditionalFormattingGradientColor GradientColor Source #

Determines the color.

ConditionalFormattingIcon

conditionalFormattingIcon_customCondition :: Lens' ConditionalFormattingIcon (Maybe ConditionalFormattingCustomIconCondition) Source #

Determines the custom condition for an icon set.

conditionalFormattingIcon_iconSet :: Lens' ConditionalFormattingIcon (Maybe ConditionalFormattingIconSet) Source #

Formatting configuration for icon set.

ConditionalFormattingIconDisplayConfiguration

conditionalFormattingIconDisplayConfiguration_iconDisplayOption :: Lens' ConditionalFormattingIconDisplayConfiguration (Maybe ConditionalFormattingIconDisplayOption) Source #

Determines the icon display configuration.

ConditionalFormattingIconSet

conditionalFormattingIconSet_iconSetType :: Lens' ConditionalFormattingIconSet (Maybe ConditionalFormattingIconSetType) Source #

Determines the icon set type.

conditionalFormattingIconSet_expression :: Lens' ConditionalFormattingIconSet Text Source #

The expression that determines the formatting configuration for the icon set.

ConditionalFormattingSolidColor

conditionalFormattingSolidColor_color :: Lens' ConditionalFormattingSolidColor (Maybe Text) Source #

Determines the color.

conditionalFormattingSolidColor_expression :: Lens' ConditionalFormattingSolidColor Text Source #

The expression that determines the formatting configuration for solid color.

ContributionAnalysisDefault

contributionAnalysisDefault_measureFieldId :: Lens' ContributionAnalysisDefault Text Source #

The measure field that is used in the contribution analysis.

contributionAnalysisDefault_contributorDimensions :: Lens' ContributionAnalysisDefault (NonEmpty ColumnIdentifier) Source #

The dimensions columns that are used in the contribution analysis, usually a list of ColumnIdentifiers.

CreateColumnsOperation

createColumnsOperation_columns :: Lens' CreateColumnsOperation (NonEmpty CalculatedColumn) Source #

Calculated columns to create.

CredentialPair

credentialPair_alternateDataSourceParameters :: Lens' CredentialPair (Maybe (NonEmpty DataSourceParameters)) Source #

A set of alternate data source parameters that you want to share for these credentials. 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 new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.

credentialPair_username :: Lens' CredentialPair Text Source #

User name.

credentialPair_password :: Lens' CredentialPair Text Source #

Password.

CurrencyDisplayFormatConfiguration

currencyDisplayFormatConfiguration_decimalPlacesConfiguration :: Lens' CurrencyDisplayFormatConfiguration (Maybe DecimalPlacesConfiguration) Source #

The option that determines the decimal places configuration.

currencyDisplayFormatConfiguration_negativeValueConfiguration :: Lens' CurrencyDisplayFormatConfiguration (Maybe NegativeValueConfiguration) Source #

The options that determine the negative value configuration.

currencyDisplayFormatConfiguration_nullValueFormatConfiguration :: Lens' CurrencyDisplayFormatConfiguration (Maybe NullValueFormatConfiguration) Source #

The options that determine the null value format configuration.

currencyDisplayFormatConfiguration_numberScale :: Lens' CurrencyDisplayFormatConfiguration (Maybe NumberScale) Source #

Determines the number scale value for the currency format.

currencyDisplayFormatConfiguration_prefix :: Lens' CurrencyDisplayFormatConfiguration (Maybe Text) Source #

Determines the prefix value of the currency format.

currencyDisplayFormatConfiguration_separatorConfiguration :: Lens' CurrencyDisplayFormatConfiguration (Maybe NumericSeparatorConfiguration) Source #

The options that determine the numeric separator configuration.

currencyDisplayFormatConfiguration_suffix :: Lens' CurrencyDisplayFormatConfiguration (Maybe Text) Source #

Determines the suffix value of the currency format.

currencyDisplayFormatConfiguration_symbol :: Lens' CurrencyDisplayFormatConfiguration (Maybe Text) Source #

Determines the symbol for the currency format.

CustomActionFilterOperation

customActionFilterOperation_selectedFieldsConfiguration :: Lens' CustomActionFilterOperation FilterOperationSelectedFieldsConfiguration Source #

The configuration that chooses the fields to be filtered.

customActionFilterOperation_targetVisualsConfiguration :: Lens' CustomActionFilterOperation FilterOperationTargetVisualsConfiguration Source #

The configuration that chooses the target visuals to be filtered.

CustomActionNavigationOperation

customActionNavigationOperation_localNavigationConfiguration :: Lens' CustomActionNavigationOperation (Maybe LocalNavigationConfiguration) Source #

The configuration that chooses the navigation target.

CustomActionSetParametersOperation

customActionSetParametersOperation_parameterValueConfigurations :: Lens' CustomActionSetParametersOperation (NonEmpty SetParameterValueConfiguration) Source #

The parameter that determines the value configuration.

CustomActionURLOperation

customActionURLOperation_uRLTemplate :: Lens' CustomActionURLOperation Text Source #

THe URL link of the CustomActionURLOperation.

customActionURLOperation_uRLTarget :: Lens' CustomActionURLOperation URLTargetConfiguration Source #

The target of the CustomActionURLOperation.

Valid values are defined as follows:

NEW_TAB: Opens the target URL in a new browser tab.
NEW_WINDOW: Opens the target URL in a new browser window.
SAME_TAB: Opens the target URL in the same browser tab.

CustomContentConfiguration

customContentConfiguration_contentType :: Lens' CustomContentConfiguration (Maybe CustomContentType) Source #

The content type of the custom content visual. You can use this to have the visual render as an image.

customContentConfiguration_contentUrl :: Lens' CustomContentConfiguration (Maybe Text) Source #

The input URL that links to the custom content that you want in the custom visual.

customContentConfiguration_imageScaling :: Lens' CustomContentConfiguration (Maybe CustomContentImageScalingConfiguration) Source #

The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is 'IMAGE'.

CustomContentVisual

customContentVisual_actions :: Lens' CustomContentVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

customContentVisual_chartConfiguration :: Lens' CustomContentVisual (Maybe CustomContentConfiguration) Source #

The configuration of a CustomContentVisual.

customContentVisual_subtitle :: Lens' CustomContentVisual (Maybe VisualSubtitleLabelOptions) Source #

The subtitle that is displayed on the visual.

customContentVisual_title :: Lens' CustomContentVisual (Maybe VisualTitleLabelOptions) Source #

The title that is displayed on the visual.

customContentVisual_visualId :: Lens' CustomContentVisual Text Source #

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.

customContentVisual_dataSetIdentifier :: Lens' CustomContentVisual Text Source #

The dataset that is used to create the custom content visual. You can't create a visual without a dataset.

CustomFilterConfiguration

customFilterConfiguration_categoryValue :: Lens' CustomFilterConfiguration (Maybe Text) Source #

The category value for the filter.

This field is mutually exclusive to ParameterName.

customFilterConfiguration_parameterName :: Lens' CustomFilterConfiguration (Maybe Text) Source #

The parameter whose value should be used for the filter value.

This field is mutually exclusive to CategoryValue.

customFilterConfiguration_selectAllOptions :: Lens' CustomFilterConfiguration (Maybe CategoryFilterSelectAllOptions) Source #

Select all of the values. Null is not the assigned value of select all.

```
FILTER_ALL_VALUES
```

customFilterConfiguration_matchOperator :: Lens' CustomFilterConfiguration CategoryFilterMatchOperator Source #

The match operator that is used to determine if a filter should be applied.

customFilterConfiguration_nullOption :: Lens' CustomFilterConfiguration FilterNullOption Source #

This option determines how null values should be treated when filtering data.

ALL_VALUES: Include null values in filtered results.
NULLS_ONLY: Only include null values in filtered results.
NON_NULLS_ONLY: Exclude null values from filtered results.

CustomFilterListConfiguration

customFilterListConfiguration_categoryValues :: Lens' CustomFilterListConfiguration (Maybe [Text]) Source #

The list of category values for the filter.

customFilterListConfiguration_selectAllOptions :: Lens' CustomFilterListConfiguration (Maybe CategoryFilterSelectAllOptions) Source #

Select all of the values. Null is not the assigned value of select all.

```
FILTER_ALL_VALUES
```

customFilterListConfiguration_matchOperator :: Lens' CustomFilterListConfiguration CategoryFilterMatchOperator Source #

The match operator that is used to determine if a filter should be applied.

customFilterListConfiguration_nullOption :: Lens' CustomFilterListConfiguration FilterNullOption Source #

This option determines how null values should be treated when filtering data.

ALL_VALUES: Include null values in filtered results.
NULLS_ONLY: Only include null values in filtered results.
NON_NULLS_ONLY: Exclude null values from filtered results.

CustomNarrativeOptions

customNarrativeOptions_narrative :: Lens' CustomNarrativeOptions Text Source #

The string input of custom narrative.

CustomParameterValues

customParameterValues_dateTimeValues :: Lens' CustomParameterValues (Maybe [UTCTime]) Source #

A list of datetime-type parameter values.

customParameterValues_decimalValues :: Lens' CustomParameterValues (Maybe [Double]) Source #

A list of decimal-type parameter values.

customParameterValues_integerValues :: Lens' CustomParameterValues (Maybe [Integer]) Source #

A list of integer-type parameter values.

customParameterValues_stringValues :: Lens' CustomParameterValues (Maybe [Text]) Source #

A list of string-type parameter values.

CustomSql

customSql_columns :: Lens' CustomSql (Maybe (NonEmpty InputColumn)) Source #

The column schema from the SQL query result set.

customSql_dataSourceArn :: Lens' CustomSql Text Source #

The Amazon Resource Name (ARN) of the data source.

customSql_name :: Lens' CustomSql Text Source #

A display name for the SQL query result.

customSql_sqlQuery :: Lens' CustomSql Text Source #

The SQL query.

CustomValuesConfiguration

customValuesConfiguration_includeNullValue :: Lens' CustomValuesConfiguration (Maybe Bool) Source #

Includes the null value in custom action parameter values.

customValuesConfiguration_customValues :: Lens' CustomValuesConfiguration CustomParameterValues Source #

Undocumented member.

Dashboard

dashboard_arn :: Lens' Dashboard (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource.

dashboard_createdTime :: Lens' Dashboard (Maybe UTCTime) Source #

The time that this dashboard was created.

dashboard_dashboardId :: Lens' Dashboard (Maybe Text) Source #

Dashboard ID.

dashboard_lastPublishedTime :: Lens' Dashboard (Maybe UTCTime) Source #

The last time that this dashboard was published.

dashboard_lastUpdatedTime :: Lens' Dashboard (Maybe UTCTime) Source #

The last time that this dashboard was updated.

dashboard_name :: Lens' Dashboard (Maybe Text) Source #

A display name for the dashboard.

dashboard_version :: Lens' Dashboard (Maybe DashboardVersion) Source #

Version.

DashboardError

dashboardError_message :: Lens' DashboardError (Maybe Text) Source #

Message.

dashboardError_type :: Lens' DashboardError (Maybe DashboardErrorType) Source #

Type.

dashboardError_violatedEntities :: Lens' DashboardError (Maybe [Entity]) Source #

DashboardPublishOptions

dashboardPublishOptions_adHocFilteringOption :: Lens' DashboardPublishOptions (Maybe AdHocFilteringOption) Source #

Ad hoc (one-time) filtering option.

dashboardPublishOptions_exportToCSVOption :: Lens' DashboardPublishOptions (Maybe ExportToCSVOption) Source #

Export to .csv option.

dashboardPublishOptions_sheetControlsOption :: Lens' DashboardPublishOptions (Maybe SheetControlsOption) Source #

Sheet controls option.

dashboardPublishOptions_visualPublishOptions :: Lens' DashboardPublishOptions (Maybe DashboardVisualPublishOptions) Source #

DashboardSearchFilter

dashboardSearchFilter_name :: Lens' DashboardSearchFilter (Maybe DashboardFilterAttribute) Source #

The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_OWNER".

Valid values are defined as follows:

QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the dashboards's owners or viewers are returned. Implicit permissions from folders or groups are considered.
QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are considered.
DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as the only owner of the dashboard are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners or viewers of the dashboards are returned. Implicit permissions from folders or groups are not considered.
DASHBOARD_NAME: Any dashboards whose names have a substring match to this value will be returned.

dashboardSearchFilter_value :: Lens' DashboardSearchFilter (Maybe Text) Source #

The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

dashboardSearchFilter_operator :: Lens' DashboardSearchFilter FilterOperator Source #

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"DASHBOARD_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DASHBOARD_NAME.

DashboardSourceEntity

dashboardSourceEntity_sourceTemplate :: Lens' DashboardSourceEntity (Maybe DashboardSourceTemplate) Source #

Source template.

DashboardSourceTemplate

dashboardSourceTemplate_dataSetReferences :: Lens' DashboardSourceTemplate (NonEmpty DataSetReference) Source #

Dataset references.

dashboardSourceTemplate_arn :: Lens' DashboardSourceTemplate Text Source #

The Amazon Resource Name (ARN) of the resource.

DashboardSummary

dashboardSummary_arn :: Lens' DashboardSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource.

dashboardSummary_createdTime :: Lens' DashboardSummary (Maybe UTCTime) Source #

The time that this dashboard was created.

dashboardSummary_dashboardId :: Lens' DashboardSummary (Maybe Text) Source #

Dashboard ID.

dashboardSummary_lastPublishedTime :: Lens' DashboardSummary (Maybe UTCTime) Source #

The last time that this dashboard was published.

dashboardSummary_lastUpdatedTime :: Lens' DashboardSummary (Maybe UTCTime) Source #

The last time that this dashboard was updated.

dashboardSummary_name :: Lens' DashboardSummary (Maybe Text) Source #

A display name for the dashboard.

dashboardSummary_publishedVersionNumber :: Lens' DashboardSummary (Maybe Natural) Source #

Published version number.

DashboardVersion

dashboardVersion_arn :: Lens' DashboardVersion (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource.

dashboardVersion_createdTime :: Lens' DashboardVersion (Maybe UTCTime) Source #

The time that this dashboard version was created.

dashboardVersion_dataSetArns :: Lens' DashboardVersion (Maybe [Text]) Source #

The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard.

dashboardVersion_description :: Lens' DashboardVersion (Maybe Text) Source #

Description.

dashboardVersion_errors :: Lens' DashboardVersion (Maybe (NonEmpty DashboardError)) Source #

Errors associated with this dashboard version.

dashboardVersion_sheets :: Lens' DashboardVersion (Maybe [Sheet]) Source #

A list of the associated sheets with the unique identifier and name of each sheet.

dashboardVersion_sourceEntityArn :: Lens' DashboardVersion (Maybe Text) Source #

Source entity ARN.

dashboardVersion_status :: Lens' DashboardVersion (Maybe ResourceStatus) Source #

The HTTP status of the request.

dashboardVersion_themeArn :: Lens' DashboardVersion (Maybe Text) Source #

The ARN of the theme associated with a version of the dashboard.

dashboardVersion_versionNumber :: Lens' DashboardVersion (Maybe Natural) Source #

Version number for this version of the dashboard.

DashboardVersionDefinition

dashboardVersionDefinition_analysisDefaults :: Lens' DashboardVersionDefinition (Maybe AnalysisDefaults) Source #

Undocumented member.

dashboardVersionDefinition_calculatedFields :: Lens' DashboardVersionDefinition (Maybe [CalculatedField]) Source #

An array of calculated field definitions for the dashboard.

dashboardVersionDefinition_columnConfigurations :: Lens' DashboardVersionDefinition (Maybe [ColumnConfiguration]) Source #

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.

dashboardVersionDefinition_filterGroups :: Lens' DashboardVersionDefinition (Maybe [FilterGroup]) Source #

The filter definitions for a dashboard.

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

dashboardVersionDefinition_parameterDeclarations :: Lens' DashboardVersionDefinition (Maybe [ParameterDeclaration]) Source #

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 QuickSight in the Amazon QuickSight User Guide.

dashboardVersionDefinition_sheets :: Lens' DashboardVersionDefinition (Maybe [SheetDefinition]) Source #

An array of sheet definitions for a dashboard.

dashboardVersionDefinition_dataSetIdentifierDeclarations :: Lens' DashboardVersionDefinition (NonEmpty DataSetIdentifierDeclaration) Source #

An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.

DashboardVersionSummary

dashboardVersionSummary_arn :: Lens' DashboardVersionSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource.

dashboardVersionSummary_createdTime :: Lens' DashboardVersionSummary (Maybe UTCTime) Source #

The time that this dashboard version was created.

dashboardVersionSummary_description :: Lens' DashboardVersionSummary (Maybe Text) Source #

Description.

dashboardVersionSummary_sourceEntityArn :: Lens' DashboardVersionSummary (Maybe Text) Source #

Source entity ARN.

dashboardVersionSummary_status :: Lens' DashboardVersionSummary (Maybe ResourceStatus) Source #

The HTTP status of the request.

dashboardVersionSummary_versionNumber :: Lens' DashboardVersionSummary (Maybe Natural) Source #

Version number.

DashboardVisualId

dashboardVisualId_dashboardId :: Lens' DashboardVisualId Text Source #

The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

dashboardVisualId_sheetId :: Lens' DashboardVisualId Text Source #

The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.

dashboardVisualId_visualId :: Lens' DashboardVisualId Text Source #

The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.

DashboardVisualPublishOptions

dashboardVisualPublishOptions_exportHiddenFieldsOption :: Lens' DashboardVisualPublishOptions (Maybe ExportHiddenFieldsOption) Source #

DataColor

dataColor_color :: Lens' DataColor (Maybe Text) Source #

The color that is applied to the data value.

dataColor_dataValue :: Lens' DataColor (Maybe Double) Source #

The data value that the color is applied to.

DataColorPalette

dataColorPalette_colors :: Lens' DataColorPalette (Maybe [Text]) Source #

The hexadecimal codes for the colors.

dataColorPalette_emptyFillColor :: Lens' DataColorPalette (Maybe Text) Source #

The hexadecimal code of a color that applies to charts where a lack of data is highlighted.

dataColorPalette_minMaxGradient :: Lens' DataColorPalette (Maybe [Text]) Source #

The minimum and maximum hexadecimal codes that describe a color gradient.

DataFieldSeriesItem

dataFieldSeriesItem_fieldValue :: Lens' DataFieldSeriesItem (Maybe Text) Source #

The field value of the field that you are setting the axis binding to.

dataFieldSeriesItem_settings :: Lens' DataFieldSeriesItem (Maybe LineChartSeriesSettings) Source #

The options that determine the presentation of line series associated to the field.

dataFieldSeriesItem_fieldId :: Lens' DataFieldSeriesItem Text Source #

The field ID of the field that you are setting the axis binding to.

dataFieldSeriesItem_axisBinding :: Lens' DataFieldSeriesItem AxisBinding Source #

The axis that you are binding the field to.

DataLabelOptions

dataLabelOptions_categoryLabelVisibility :: Lens' DataLabelOptions (Maybe Visibility) Source #

Determines the visibility of the category field labels.

dataLabelOptions_dataLabelTypes :: Lens' DataLabelOptions (Maybe [DataLabelType]) Source #

The option that determines the data label type.

dataLabelOptions_labelColor :: Lens' DataLabelOptions (Maybe Text) Source #

Determines the color of the data labels.

dataLabelOptions_labelContent :: Lens' DataLabelOptions (Maybe DataLabelContent) Source #

Determines the content of the data labels.

dataLabelOptions_labelFontConfiguration :: Lens' DataLabelOptions (Maybe FontConfiguration) Source #

Determines the font configuration of the data labels.

dataLabelOptions_measureLabelVisibility :: Lens' DataLabelOptions (Maybe Visibility) Source #

Determines the visibility of the measure field labels.

dataLabelOptions_overlap :: Lens' DataLabelOptions (Maybe DataLabelOverlap) Source #

Determines whether overlap is enabled or disabled for the data labels.

dataLabelOptions_position :: Lens' DataLabelOptions (Maybe DataLabelPosition) Source #

Determines the position of the data labels.

dataLabelOptions_visibility :: Lens' DataLabelOptions (Maybe Visibility) Source #

Determines the visibility of the data labels.

DataLabelType

dataLabelType_dataPathLabelType :: Lens' DataLabelType (Maybe DataPathLabelType) Source #

The option that specifies individual data values for labels.

dataLabelType_fieldLabelType :: Lens' DataLabelType (Maybe FieldLabelType) Source #

Determines the label configuration for the entire field.

dataLabelType_maximumLabelType :: Lens' DataLabelType (Maybe MaximumLabelType) Source #

Determines the label configuration for the maximum value in a visual.

dataLabelType_minimumLabelType :: Lens' DataLabelType (Maybe MinimumLabelType) Source #

Determines the label configuration for the minimum value in a visual.

dataLabelType_rangeEndsLabelType :: Lens' DataLabelType (Maybe RangeEndsLabelType) Source #

Determines the label configuration for range end value in a visual.

DataPathColor

dataPathColor_timeGranularity :: Lens' DataPathColor (Maybe TimeGranularity) Source #

The time granularity of the field that the color needs to be applied to.

dataPathColor_element :: Lens' DataPathColor DataPathValue Source #

The element that the color needs to be applied to.

dataPathColor_color :: Lens' DataPathColor Text Source #

The color that needs to be applied to the element.

DataPathLabelType

dataPathLabelType_fieldId :: Lens' DataPathLabelType (Maybe Text) Source #

The field ID of the field that the data label needs to be applied to.

dataPathLabelType_fieldValue :: Lens' DataPathLabelType (Maybe Text) Source #

The actual value of the field that is labeled.

dataPathLabelType_visibility :: Lens' DataPathLabelType (Maybe Visibility) Source #

The visibility of the data label.

DataPathSort

dataPathSort_direction :: Lens' DataPathSort SortDirection Source #

Determines the sort direction.

dataPathSort_sortPaths :: Lens' DataPathSort [DataPathValue] Source #

The list of data paths that need to be sorted.

DataPathValue

dataPathValue_fieldId :: Lens' DataPathValue Text Source #

The field ID of the field that needs to be sorted.

dataPathValue_fieldValue :: Lens' DataPathValue Text Source #

The actual value of the field that needs to be sorted.

DataSet

dataSet_arn :: Lens' DataSet (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource.

dataSet_columnGroups :: Lens' DataSet (Maybe (NonEmpty ColumnGroup)) Source #

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

dataSet_columnLevelPermissionRules :: Lens' DataSet (Maybe (NonEmpty ColumnLevelPermissionRule)) Source #

A set of one or more definitions of a ColumnLevelPermissionRule .

dataSet_consumedSpiceCapacityInBytes :: Lens' DataSet (Maybe Integer) Source #

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.

dataSet_createdTime :: Lens' DataSet (Maybe UTCTime) Source #

The time that this dataset was created.

dataSet_dataSetId :: Lens' DataSet (Maybe Text) Source #

The ID of the dataset.

dataSet_dataSetUsageConfiguration :: Lens' DataSet (Maybe DataSetUsageConfiguration) Source #

The usage configuration to apply to child datasets that reference this dataset as a source.

dataSet_fieldFolders :: Lens' DataSet (Maybe (HashMap Text FieldFolder)) Source #

The folder that contains fields and nested subfolders for your dataset.

dataSet_importMode :: Lens' DataSet (Maybe DataSetImportMode) Source #

A value that indicates whether you want to import the data into SPICE.

dataSet_lastUpdatedTime :: Lens' DataSet (Maybe UTCTime) Source #

The last time that this dataset was updated.

dataSet_logicalTableMap :: Lens' DataSet (Maybe (HashMap Text LogicalTable)) Source #

Configures the combination and transformation of the data from the physical tables.

dataSet_name :: Lens' DataSet (Maybe Text) Source #

A display name for the dataset.

dataSet_outputColumns :: Lens' DataSet (Maybe [OutputColumn]) Source #

The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.

dataSet_physicalTableMap :: Lens' DataSet (Maybe (HashMap Text PhysicalTable)) Source #

Declares the physical tables that are available in the underlying data sources.

dataSet_rowLevelPermissionDataSet :: Lens' DataSet (Maybe RowLevelPermissionDataSet) Source #

The row-level security configuration for the dataset.

dataSet_rowLevelPermissionTagConfiguration :: Lens' DataSet (Maybe RowLevelPermissionTagConfiguration) Source #

The element you can use to define tags for row-level security.

DataSetConfiguration

dataSetConfiguration_columnGroupSchemaList :: Lens' DataSetConfiguration (Maybe [ColumnGroupSchema]) Source #

A structure containing the list of column group schemas.

dataSetConfiguration_dataSetSchema :: Lens' DataSetConfiguration (Maybe DataSetSchema) Source #

Dataset schema.

dataSetConfiguration_placeholder :: Lens' DataSetConfiguration (Maybe Text) Source #

Placeholder.

DataSetIdentifierDeclaration

dataSetIdentifierDeclaration_identifier :: Lens' DataSetIdentifierDeclaration Text Source #

The identifier of the data set, typically the data set's name.

dataSetIdentifierDeclaration_dataSetArn :: Lens' DataSetIdentifierDeclaration Text Source #

The Amazon Resource Name (ARN) of the data set.

DataSetReference

dataSetReference_dataSetPlaceholder :: Lens' DataSetReference Text Source #

Dataset placeholder.

dataSetReference_dataSetArn :: Lens' DataSetReference Text Source #

Dataset Amazon Resource Name (ARN).

DataSetSchema

dataSetSchema_columnSchemaList :: Lens' DataSetSchema (Maybe [ColumnSchema]) Source #

A structure containing the list of column schemas.

DataSetSearchFilter

dataSetSearchFilter_operator :: Lens' DataSetSearchFilter FilterOperator Source #

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose datasets you want to search in the "Value" field. For example, "Name":"QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east- 1:1:user/default/UserName1".

If you set the value to "StringLike", you need to provide the name of the datasets you are searching for. For example, "Name":"DATASET_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASET_NAME.

dataSetSearchFilter_name :: Lens' DataSetSearchFilter DataSetFilterAttribute Source #

The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_OWNER".

Valid values are defined as follows:

QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the dataset owners or viewers are returned. Implicit permissions from folders or groups are considered.
QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners of the dataset are returned. Implicit permissions from folders or groups are considered.
DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as the only owner of the dataset are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners if the dataset are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners or viewers of the dataset are returned. Implicit permissions from folders or groups are not considered.
DATASET_NAME: Any datasets whose names have a substring match to this value will be returned.

dataSetSearchFilter_value :: Lens' DataSetSearchFilter Text Source #

The value of the named item, in this case QUICKSIGHT_OWNER, that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

DataSetSummary

dataSetSummary_arn :: Lens' DataSetSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset.

dataSetSummary_columnLevelPermissionRulesApplied :: Lens' DataSetSummary (Maybe Bool) Source #

A value that indicates if the dataset has column level permission configured.

dataSetSummary_createdTime :: Lens' DataSetSummary (Maybe UTCTime) Source #

The time that this dataset was created.

dataSetSummary_dataSetId :: Lens' DataSetSummary (Maybe Text) Source #

The ID of the dataset.

dataSetSummary_importMode :: Lens' DataSetSummary (Maybe DataSetImportMode) Source #

A value that indicates whether you want to import the data into SPICE.

dataSetSummary_lastUpdatedTime :: Lens' DataSetSummary (Maybe UTCTime) Source #

The last time that this dataset was updated.

dataSetSummary_name :: Lens' DataSetSummary (Maybe Text) Source #

A display name for the dataset.

dataSetSummary_rowLevelPermissionDataSet :: Lens' DataSetSummary (Maybe RowLevelPermissionDataSet) Source #

The row-level security configuration for the dataset.

dataSetSummary_rowLevelPermissionTagConfigurationApplied :: Lens' DataSetSummary (Maybe Bool) Source #

Whether or not the row level permission tags are applied.

DataSetUsageConfiguration

dataSetUsageConfiguration_disableUseAsDirectQuerySource :: Lens' DataSetUsageConfiguration (Maybe Bool) Source #

An option that controls whether a child dataset of a direct query can use this dataset as a source.

dataSetUsageConfiguration_disableUseAsImportedSource :: Lens' DataSetUsageConfiguration (Maybe Bool) Source #

An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.

DataSource

dataSource_alternateDataSourceParameters :: Lens' DataSource (Maybe (NonEmpty DataSourceParameters)) Source #

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.

dataSource_arn :: Lens' DataSource (Maybe Text) Source #

The Amazon Resource Name (ARN) of the data source.

dataSource_createdTime :: Lens' DataSource (Maybe UTCTime) Source #

The time that this data source was created.

dataSource_dataSourceId :: Lens' DataSource (Maybe Text) Source #

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

dataSource_dataSourceParameters :: Lens' DataSource (Maybe DataSourceParameters) Source #

The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

dataSource_errorInfo :: Lens' DataSource (Maybe DataSourceErrorInfo) Source #

Error information from the last update or the creation of the data source.

dataSource_lastUpdatedTime :: Lens' DataSource (Maybe UTCTime) Source #

The last time that this data source was updated.

dataSource_name :: Lens' DataSource (Maybe Text) Source #

A display name for the data source.

dataSource_secretArn :: Lens' DataSource (Maybe Text) Source #

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

dataSource_sslProperties :: Lens' DataSource (Maybe SslProperties) Source #

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

dataSource_status :: Lens' DataSource (Maybe ResourceStatus) Source #

The HTTP status of the request.

dataSource_type :: Lens' DataSource (Maybe DataSourceType) Source #

The type of the data source. This type indicates which database engine the data source connects to.

dataSource_vpcConnectionProperties :: Lens' DataSource (Maybe VpcConnectionProperties) Source #

The VPC connection information. You need to use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

DataSourceCredentials

dataSourceCredentials_copySourceArn :: Lens' DataSourceCredentials (Maybe Text) Source #

The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.

dataSourceCredentials_credentialPair :: Lens' DataSourceCredentials (Maybe CredentialPair) Source #

Credential pair. For more information, see CredentialPair .

dataSourceCredentials_secretArn :: Lens' DataSourceCredentials (Maybe Text) Source #

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

DataSourceErrorInfo

dataSourceErrorInfo_message :: Lens' DataSourceErrorInfo (Maybe Text) Source #

Error message.

dataSourceErrorInfo_type :: Lens' DataSourceErrorInfo (Maybe DataSourceErrorInfoType) Source #

Error type.

DataSourceParameters

dataSourceParameters_amazonElasticsearchParameters :: Lens' DataSourceParameters (Maybe AmazonElasticsearchParameters) Source #

The parameters for OpenSearch.

dataSourceParameters_amazonOpenSearchParameters :: Lens' DataSourceParameters (Maybe AmazonOpenSearchParameters) Source #

The parameters for OpenSearch.

dataSourceParameters_athenaParameters :: Lens' DataSourceParameters (Maybe AthenaParameters) Source #

The parameters for Amazon Athena.

dataSourceParameters_auroraParameters :: Lens' DataSourceParameters (Maybe AuroraParameters) Source #

The parameters for Amazon Aurora MySQL.

dataSourceParameters_auroraPostgreSqlParameters :: Lens' DataSourceParameters (Maybe AuroraPostgreSqlParameters) Source #

The parameters for Amazon Aurora.

dataSourceParameters_awsIotAnalyticsParameters :: Lens' DataSourceParameters (Maybe AwsIotAnalyticsParameters) Source #

The parameters for IoT Analytics.

dataSourceParameters_databricksParameters :: Lens' DataSourceParameters (Maybe DatabricksParameters) Source #

The required parameters that are needed to connect to a Databricks data source.

dataSourceParameters_exasolParameters :: Lens' DataSourceParameters (Maybe ExasolParameters) Source #

The parameters for Exasol.

dataSourceParameters_jiraParameters :: Lens' DataSourceParameters (Maybe JiraParameters) Source #

The parameters for Jira.

dataSourceParameters_mariaDbParameters :: Lens' DataSourceParameters (Maybe MariaDbParameters) Source #

The parameters for MariaDB.

dataSourceParameters_mySqlParameters :: Lens' DataSourceParameters (Maybe MySqlParameters) Source #

The parameters for MySQL.

dataSourceParameters_oracleParameters :: Lens' DataSourceParameters (Maybe OracleParameters) Source #

The parameters for Oracle.

dataSourceParameters_postgreSqlParameters :: Lens' DataSourceParameters (Maybe PostgreSqlParameters) Source #

The parameters for PostgreSQL.

dataSourceParameters_prestoParameters :: Lens' DataSourceParameters (Maybe PrestoParameters) Source #

The parameters for Presto.

dataSourceParameters_rdsParameters :: Lens' DataSourceParameters (Maybe RdsParameters) Source #

The parameters for Amazon RDS.

dataSourceParameters_redshiftParameters :: Lens' DataSourceParameters (Maybe RedshiftParameters) Source #

The parameters for Amazon Redshift.

dataSourceParameters_s3Parameters :: Lens' DataSourceParameters (Maybe S3Parameters) Source #

The parameters for S3.

dataSourceParameters_serviceNowParameters :: Lens' DataSourceParameters (Maybe ServiceNowParameters) Source #

The parameters for ServiceNow.

dataSourceParameters_snowflakeParameters :: Lens' DataSourceParameters (Maybe SnowflakeParameters) Source #

The parameters for Snowflake.

dataSourceParameters_sparkParameters :: Lens' DataSourceParameters (Maybe SparkParameters) Source #

The parameters for Spark.

dataSourceParameters_sqlServerParameters :: Lens' DataSourceParameters (Maybe SqlServerParameters) Source #

The parameters for SQL Server.

dataSourceParameters_teradataParameters :: Lens' DataSourceParameters (Maybe TeradataParameters) Source #

The parameters for Teradata.

dataSourceParameters_twitterParameters :: Lens' DataSourceParameters (Maybe TwitterParameters) Source #

The parameters for Twitter.

DataSourceSearchFilter

dataSourceSearchFilter_operator :: Lens' DataSourceSearchFilter FilterOperator Source #

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose data sources you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

If you set the value to "StringLike", you need to provide the name of the data sources you are searching for. For example, "Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASOURCE_NAME.

dataSourceSearchFilter_name :: Lens' DataSourceSearchFilter DataSourceFilterAttribute Source #

The name of the value that you want to use as a filter, for example, "Name": "DIRECT_QUICKSIGHT_OWNER".

Valid values are defined as follows:

DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners or viewers of the data sources are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners if the data source are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as the only owner of the data source are returned. Implicit permissions from folders or groups are not considered.
DATASOURCE_NAME: Any data sources whose names have a substring match to the provided value are returned.

dataSourceSearchFilter_value :: Lens' DataSourceSearchFilter Text Source #

The value of the named item, for example DIRECT_QUICKSIGHT_OWNER, that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

DataSourceSummary

dataSourceSummary_arn :: Lens' DataSourceSummary (Maybe Text) Source #

The arn of the datasource.

dataSourceSummary_createdTime :: Lens' DataSourceSummary (Maybe UTCTime) Source #

The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.

dataSourceSummary_dataSourceId :: Lens' DataSourceSummary (Maybe Text) Source #

The unique ID of the data source.

dataSourceSummary_lastUpdatedTime :: Lens' DataSourceSummary (Maybe UTCTime) Source #

The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.

dataSourceSummary_name :: Lens' DataSourceSummary (Maybe Text) Source #

The name of the data source.

dataSourceSummary_type :: Lens' DataSourceSummary (Maybe DataSourceType) Source #

The type of the data source.

DatabricksParameters

databricksParameters_host :: Lens' DatabricksParameters Text Source #

The host name of the Databricks data source.

databricksParameters_port :: Lens' DatabricksParameters Natural Source #

The port for the Databricks data source.

databricksParameters_sqlEndpointPath :: Lens' DatabricksParameters Text Source #

The HTTP path of the Databricks data source.

DateAxisOptions

dateAxisOptions_missingDateVisibility :: Lens' DateAxisOptions (Maybe Visibility) Source #

Determines whether or not missing dates are displayed.

DateDimensionField

dateDimensionField_dateGranularity :: Lens' DateDimensionField (Maybe TimeGranularity) Source #

The date granularity of the DateDimensionField. Choose one of the following options:

```
YEAR
```
```
QUARTER
```
```
MONTH
```
```
WEEK
```
```
DAY
```
```
HOUR
```
```
MINUTE
```
```
SECOND
```
```
MILLISECOND
```

dateDimensionField_formatConfiguration :: Lens' DateDimensionField (Maybe DateTimeFormatConfiguration) Source #

The format configuration of the field.

dateDimensionField_hierarchyId :: Lens' DateDimensionField (Maybe Text) Source #

The custom hierarchy ID.

dateDimensionField_fieldId :: Lens' DateDimensionField Text Source #

The custom field ID.

dateDimensionField_column :: Lens' DateDimensionField ColumnIdentifier Source #

The column that is used in the DateDimensionField.

DateMeasureField

dateMeasureField_aggregationFunction :: Lens' DateMeasureField (Maybe DateAggregationFunction) Source #

The aggregation function of the measure field.

dateMeasureField_formatConfiguration :: Lens' DateMeasureField (Maybe DateTimeFormatConfiguration) Source #

The format configuration of the field.

dateMeasureField_fieldId :: Lens' DateMeasureField Text Source #

The custom field ID.

dateMeasureField_column :: Lens' DateMeasureField ColumnIdentifier Source #

The column that is used in the DateMeasureField.

DateTimeDefaultValues

dateTimeDefaultValues_dynamicValue :: Lens' DateTimeDefaultValues (Maybe DynamicDefaultValue) Source #

The dynamic value of the DataTimeDefaultValues. Different defaults are displayed according to users, groups, and values mapping.

dateTimeDefaultValues_rollingDate :: Lens' DateTimeDefaultValues (Maybe RollingDateConfiguration) Source #

The rolling date of the DataTimeDefaultValues. The date is determined from the dataset based on input expression.

dateTimeDefaultValues_staticValues :: Lens' DateTimeDefaultValues (Maybe [UTCTime]) Source #

The static values of the DataTimeDefaultValues.

DateTimeFormatConfiguration

dateTimeFormatConfiguration_dateTimeFormat :: Lens' DateTimeFormatConfiguration (Maybe Text) Source #

Determines the DateTime format.

dateTimeFormatConfiguration_nullValueFormatConfiguration :: Lens' DateTimeFormatConfiguration (Maybe NullValueFormatConfiguration) Source #

The options that determine the null value format configuration.

dateTimeFormatConfiguration_numericFormatConfiguration :: Lens' DateTimeFormatConfiguration (Maybe NumericFormatConfiguration) Source #

The formatting configuration for numeric DateTime fields.

DateTimeHierarchy

dateTimeHierarchy_drillDownFilters :: Lens' DateTimeHierarchy (Maybe [DrillDownFilter]) Source #

The option that determines the drill down filters for the DateTime hierarchy.

dateTimeHierarchy_hierarchyId :: Lens' DateTimeHierarchy Text Source #

The hierarchy ID of the DateTime hierarchy.

DateTimeParameter

dateTimeParameter_name :: Lens' DateTimeParameter Text Source #

A display name for the date-time parameter.

dateTimeParameter_values :: Lens' DateTimeParameter [UTCTime] Source #

The values for the date-time parameter.

DateTimeParameterDeclaration

dateTimeParameterDeclaration_defaultValues :: Lens' DateTimeParameterDeclaration (Maybe DateTimeDefaultValues) Source #

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

dateTimeParameterDeclaration_timeGranularity :: Lens' DateTimeParameterDeclaration (Maybe TimeGranularity) Source #

The level of time precision that is used to aggregate DateTime values.

dateTimeParameterDeclaration_valueWhenUnset :: Lens' DateTimeParameterDeclaration (Maybe DateTimeValueWhenUnsetConfiguration) Source #

The configuration that defines the default value of a DateTime parameter when a value has not been set.

dateTimeParameterDeclaration_name :: Lens' DateTimeParameterDeclaration Text Source #

The name of the parameter that is being declared.

DateTimePickerControlDisplayOptions

dateTimePickerControlDisplayOptions_dateTimeFormat :: Lens' DateTimePickerControlDisplayOptions (Maybe Text) Source #

Customize how dates are formatted in controls.

dateTimePickerControlDisplayOptions_titleOptions :: Lens' DateTimePickerControlDisplayOptions (Maybe LabelOptions) Source #

The options to configure the title visibility, name, and font size.

DateTimeValueWhenUnsetConfiguration

dateTimeValueWhenUnsetConfiguration_customValue :: Lens' DateTimeValueWhenUnsetConfiguration (Maybe UTCTime) Source #

A custom value that's used when the value of a parameter isn't set.

dateTimeValueWhenUnsetConfiguration_valueWhenUnsetOption :: Lens' DateTimeValueWhenUnsetConfiguration (Maybe ValueWhenUnsetOption) Source #

The built-in options for default values. The value can be one of the following:

RECOMMENDED: The recommended value.
NULL: The NULL value.

DecimalDefaultValues

decimalDefaultValues_dynamicValue :: Lens' DecimalDefaultValues (Maybe DynamicDefaultValue) Source #

The dynamic value of the DecimalDefaultValues. Different defaults are displayed according to users, groups, and values mapping.

decimalDefaultValues_staticValues :: Lens' DecimalDefaultValues (Maybe [Double]) Source #

The static values of the DecimalDefaultValues.

DecimalParameter

decimalParameter_name :: Lens' DecimalParameter Text Source #

A display name for the decimal parameter.

decimalParameter_values :: Lens' DecimalParameter [Double] Source #

The values for the decimal parameter.

DecimalParameterDeclaration

decimalParameterDeclaration_defaultValues :: Lens' DecimalParameterDeclaration (Maybe DecimalDefaultValues) Source #

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

decimalParameterDeclaration_valueWhenUnset :: Lens' DecimalParameterDeclaration (Maybe DecimalValueWhenUnsetConfiguration) Source #

The configuration that defines the default value of a Decimal parameter when a value has not been set.

decimalParameterDeclaration_parameterValueType :: Lens' DecimalParameterDeclaration ParameterValueType Source #

The value type determines whether the parameter is a single-value or multi-value parameter.

decimalParameterDeclaration_name :: Lens' DecimalParameterDeclaration Text Source #

The name of the parameter that is being declared.

DecimalPlacesConfiguration

decimalPlacesConfiguration_decimalPlaces :: Lens' DecimalPlacesConfiguration Natural Source #

The values of the decimal places.

DecimalValueWhenUnsetConfiguration

decimalValueWhenUnsetConfiguration_customValue :: Lens' DecimalValueWhenUnsetConfiguration (Maybe Double) Source #

A custom value that's used when the value of a parameter isn't set.

decimalValueWhenUnsetConfiguration_valueWhenUnsetOption :: Lens' DecimalValueWhenUnsetConfiguration (Maybe ValueWhenUnsetOption) Source #

The built-in options for default values. The value can be one of the following:

RECOMMENDED: The recommended value.
NULL: The NULL value.

DefaultFreeFormLayoutConfiguration

defaultFreeFormLayoutConfiguration_canvasSizeOptions :: Lens' DefaultFreeFormLayoutConfiguration FreeFormLayoutCanvasSizeOptions Source #

Determines the screen canvas size options for a free-form layout.

DefaultGridLayoutConfiguration

defaultGridLayoutConfiguration_canvasSizeOptions :: Lens' DefaultGridLayoutConfiguration GridLayoutCanvasSizeOptions Source #

Determines the screen canvas size options for a grid layout.

DefaultInteractiveLayoutConfiguration

defaultInteractiveLayoutConfiguration_freeForm :: Lens' DefaultInteractiveLayoutConfiguration (Maybe DefaultFreeFormLayoutConfiguration) Source #

The options that determine the default settings of a free-form layout configuration.

defaultInteractiveLayoutConfiguration_grid :: Lens' DefaultInteractiveLayoutConfiguration (Maybe DefaultGridLayoutConfiguration) Source #

The options that determine the default settings for a grid layout configuration.

DefaultNewSheetConfiguration

defaultNewSheetConfiguration_interactiveLayoutConfiguration :: Lens' DefaultNewSheetConfiguration (Maybe DefaultInteractiveLayoutConfiguration) Source #

The options that determine the default settings for interactive layout configuration.

defaultNewSheetConfiguration_paginatedLayoutConfiguration :: Lens' DefaultNewSheetConfiguration (Maybe DefaultPaginatedLayoutConfiguration) Source #

The options that determine the default settings for a paginated layout configuration.

defaultNewSheetConfiguration_sheetContentType :: Lens' DefaultNewSheetConfiguration (Maybe SheetContentType) Source #

The option that determines the sheet content type.

DefaultPaginatedLayoutConfiguration

defaultPaginatedLayoutConfiguration_sectionBased :: Lens' DefaultPaginatedLayoutConfiguration (Maybe DefaultSectionBasedLayoutConfiguration) Source #

The options that determine the default settings for a section-based layout configuration.

DefaultSectionBasedLayoutConfiguration

defaultSectionBasedLayoutConfiguration_canvasSizeOptions :: Lens' DefaultSectionBasedLayoutConfiguration SectionBasedLayoutCanvasSizeOptions Source #

Determines the screen canvas size options for a section-based layout.

DestinationParameterValueConfiguration

destinationParameterValueConfiguration_customValuesConfiguration :: Lens' DestinationParameterValueConfiguration (Maybe CustomValuesConfiguration) Source #

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration.

destinationParameterValueConfiguration_selectAllValueOptions :: Lens' DestinationParameterValueConfiguration (Maybe SelectAllValueOptions) Source #

The configuration that selects all options.

destinationParameterValueConfiguration_sourceField :: Lens' DestinationParameterValueConfiguration (Maybe Text) Source #

The source field ID of the destination parameter.

destinationParameterValueConfiguration_sourceParameterName :: Lens' DestinationParameterValueConfiguration (Maybe Text) Source #

The source parameter name of the destination parameter.

DimensionField

dimensionField_categoricalDimensionField :: Lens' DimensionField (Maybe CategoricalDimensionField) Source #

The dimension type field with categorical type columns.

dimensionField_dateDimensionField :: Lens' DimensionField (Maybe DateDimensionField) Source #

The dimension type field with date type columns.

dimensionField_numericalDimensionField :: Lens' DimensionField (Maybe NumericalDimensionField) Source #

The dimension type field with numerical type columns.

DonutCenterOptions

donutCenterOptions_labelVisibility :: Lens' DonutCenterOptions (Maybe Visibility) Source #

Determines the visibility of the label in a donut chart. In the Amazon QuickSight console, this option is called 'Show total'.

DonutOptions

donutOptions_arcOptions :: Lens' DonutOptions (Maybe ArcOptions) Source #

The option for define the arc of the chart shape. Valid values are as follows:

WHOLE - A pie chart
SMALL- A small-sized donut chart
MEDIUM- A medium-sized donut chart
LARGE- A large-sized donut chart

donutOptions_donutCenterOptions :: Lens' DonutOptions (Maybe DonutCenterOptions) Source #

The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.

DrillDownFilter

drillDownFilter_categoryFilter :: Lens' DrillDownFilter (Maybe CategoryDrillDownFilter) Source #

The category type drill down filter. This filter is used for string type columns.

drillDownFilter_numericEqualityFilter :: Lens' DrillDownFilter (Maybe NumericEqualityDrillDownFilter) Source #

The numeric equality type drill down filter. This filter is used for number type columns.

drillDownFilter_timeRangeFilter :: Lens' DrillDownFilter (Maybe TimeRangeDrillDownFilter) Source #

The time range drill down filter. This filter is used for date time columns.

DropDownControlDisplayOptions

dropDownControlDisplayOptions_selectAllOptions :: Lens' DropDownControlDisplayOptions (Maybe ListControlSelectAllOptions) Source #

The configuration of the Select all options in a dropdown control.

dropDownControlDisplayOptions_titleOptions :: Lens' DropDownControlDisplayOptions (Maybe LabelOptions) Source #

The options to configure the title visibility, name, and font size.

DynamicDefaultValue

dynamicDefaultValue_groupNameColumn :: Lens' DynamicDefaultValue (Maybe ColumnIdentifier) Source #

The column that contains the group name.

dynamicDefaultValue_userNameColumn :: Lens' DynamicDefaultValue (Maybe ColumnIdentifier) Source #

The column that contains the username.

dynamicDefaultValue_defaultValueColumn :: Lens' DynamicDefaultValue ColumnIdentifier Source #

The column that contains the default value of each user or group.

EmptyVisual

emptyVisual_actions :: Lens' EmptyVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

emptyVisual_visualId :: Lens' EmptyVisual Text Source #

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.

emptyVisual_dataSetIdentifier :: Lens' EmptyVisual Text Source #

The data set that is used in the empty visual. Every visual requires a dataset to render.

Entity

entity_path :: Lens' Entity (Maybe Text) Source #

The hierarchical path of the entity within the analysis, template, or dashboard definition tree.

ErrorInfo

errorInfo_message :: Lens' ErrorInfo (Maybe Text) Source #

Error message.

errorInfo_type :: Lens' ErrorInfo (Maybe IngestionErrorType) Source #

Error type.

ExasolParameters

exasolParameters_host :: Lens' ExasolParameters Text Source #

The hostname or IP address of the Exasol data source.

exasolParameters_port :: Lens' ExasolParameters Natural Source #

The port for the Exasol data source.

ExcludePeriodConfiguration

excludePeriodConfiguration_status :: Lens' ExcludePeriodConfiguration (Maybe WidgetStatus) Source #

The status of the exclude period. Choose from the following options:

```
ENABLED
```
```
DISABLED
```

excludePeriodConfiguration_amount :: Lens' ExcludePeriodConfiguration Int Source #

The amount or number of the exclude period.

excludePeriodConfiguration_granularity :: Lens' ExcludePeriodConfiguration TimeGranularity Source #

The granularity or unit (day, month, year) of the exclude period.

ExplicitHierarchy

explicitHierarchy_drillDownFilters :: Lens' ExplicitHierarchy (Maybe [DrillDownFilter]) Source #

The option that determines the drill down filters for the explicit hierarchy.

explicitHierarchy_hierarchyId :: Lens' ExplicitHierarchy Text Source #

The hierarchy ID of the explicit hierarchy.

explicitHierarchy_columns :: Lens' ExplicitHierarchy (NonEmpty ColumnIdentifier) Source #

The list of columns that define the explicit hierarchy.

ExportHiddenFieldsOption

exportHiddenFieldsOption_availabilityStatus :: Lens' ExportHiddenFieldsOption (Maybe DashboardBehavior) Source #

ExportToCSVOption

exportToCSVOption_availabilityStatus :: Lens' ExportToCSVOption (Maybe DashboardBehavior) Source #

Availability status.

FieldBasedTooltip

fieldBasedTooltip_aggregationVisibility :: Lens' FieldBasedTooltip (Maybe Visibility) Source #

The visibility of Show aggregations.

fieldBasedTooltip_tooltipFields :: Lens' FieldBasedTooltip (Maybe [TooltipItem]) Source #

The fields configuration in the tooltip.

fieldBasedTooltip_tooltipTitleType :: Lens' FieldBasedTooltip (Maybe TooltipTitleType) Source #

The type for the >tooltip title. Choose one of the following options:

NONE: Doesn't use the primary value as the title.
PRIMARY_VALUE: Uses primary value as the title.

FieldFolder

fieldFolder_columns :: Lens' FieldFolder (Maybe [Text]) Source #

A folder has a list of columns. A column can only be in one folder.

fieldFolder_description :: Lens' FieldFolder (Maybe Text) Source #

The description for a field folder.

FieldLabelType

fieldLabelType_fieldId :: Lens' FieldLabelType (Maybe Text) Source #

Indicates the field that is targeted by the field label.

fieldLabelType_visibility :: Lens' FieldLabelType (Maybe Visibility) Source #

The visibility of the field label.

FieldSeriesItem

fieldSeriesItem_settings :: Lens' FieldSeriesItem (Maybe LineChartSeriesSettings) Source #

The options that determine the presentation of line series associated to the field.

fieldSeriesItem_fieldId :: Lens' FieldSeriesItem Text Source #

The field ID of the field for which you are setting the axis binding.

fieldSeriesItem_axisBinding :: Lens' FieldSeriesItem AxisBinding Source #

The axis that you are binding the field to.

FieldSort

fieldSort_fieldId :: Lens' FieldSort Text Source #

The sort configuration target field.

fieldSort_direction :: Lens' FieldSort SortDirection Source #

The sort direction. Choose one of the following options:

ASC: Ascending
DESC: Descending

FieldSortOptions

fieldSortOptions_columnSort :: Lens' FieldSortOptions (Maybe ColumnSort) Source #

The sort configuration for a column that is not used in a field well.

fieldSortOptions_fieldSort :: Lens' FieldSortOptions (Maybe FieldSort) Source #

The sort configuration for a field in a field well.

FieldTooltipItem

fieldTooltipItem_label :: Lens' FieldTooltipItem (Maybe Text) Source #

The label of the tooltip item.

fieldTooltipItem_visibility :: Lens' FieldTooltipItem (Maybe Visibility) Source #

The visibility of the tooltip item.

fieldTooltipItem_fieldId :: Lens' FieldTooltipItem Text Source #

The unique ID of the field that is targeted by the tooltip.

FilledMapAggregatedFieldWells

filledMapAggregatedFieldWells_geospatial :: Lens' FilledMapAggregatedFieldWells (Maybe [DimensionField]) Source #

The aggregated location field well of the filled map. Values are grouped by location fields.

filledMapAggregatedFieldWells_values :: Lens' FilledMapAggregatedFieldWells (Maybe [MeasureField]) Source #

The aggregated color field well of a filled map. Values are aggregated based on location fields.

FilledMapConditionalFormatting

filledMapConditionalFormatting_conditionalFormattingOptions :: Lens' FilledMapConditionalFormatting [FilledMapConditionalFormattingOption] Source #

Conditional formatting options of a FilledMapVisual.

FilledMapConditionalFormattingOption

filledMapConditionalFormattingOption_shape :: Lens' FilledMapConditionalFormattingOption FilledMapShapeConditionalFormatting Source #

The conditional formatting that determines the shape of the filled map.

FilledMapConfiguration

filledMapConfiguration_fieldWells :: Lens' FilledMapConfiguration (Maybe FilledMapFieldWells) Source #

The field wells of the visual.

filledMapConfiguration_legend :: Lens' FilledMapConfiguration (Maybe LegendOptions) Source #

The legend display setup of the visual.

filledMapConfiguration_mapStyleOptions :: Lens' FilledMapConfiguration (Maybe GeospatialMapStyleOptions) Source #

The map style options of the filled map visual.

filledMapConfiguration_sortConfiguration :: Lens' FilledMapConfiguration (Maybe FilledMapSortConfiguration) Source #

The sort configuration of a FilledMapVisual.

filledMapConfiguration_tooltip :: Lens' FilledMapConfiguration (Maybe TooltipOptions) Source #

The tooltip display setup of the visual.

filledMapConfiguration_windowOptions :: Lens' FilledMapConfiguration (Maybe GeospatialWindowOptions) Source #

The window options of the filled map visual.

FilledMapFieldWells

filledMapFieldWells_filledMapAggregatedFieldWells :: Lens' FilledMapFieldWells (Maybe FilledMapAggregatedFieldWells) Source #

The aggregated field well of the filled map.

FilledMapShapeConditionalFormatting

filledMapShapeConditionalFormatting_format :: Lens' FilledMapShapeConditionalFormatting (Maybe ShapeConditionalFormat) Source #

The conditional formatting that determines the background color of a filled map's shape.

filledMapShapeConditionalFormatting_fieldId :: Lens' FilledMapShapeConditionalFormatting Text Source #

The field ID of the filled map shape.

FilledMapSortConfiguration

filledMapSortConfiguration_categorySort :: Lens' FilledMapSortConfiguration (Maybe [FieldSortOptions]) Source #

The sort configuration of the location fields.

FilledMapVisual

filledMapVisual_actions :: Lens' FilledMapVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

filledMapVisual_chartConfiguration :: Lens' FilledMapVisual (Maybe FilledMapConfiguration) Source #

The configuration settings of the visual.

filledMapVisual_columnHierarchies :: Lens' FilledMapVisual (Maybe [ColumnHierarchy]) Source #

The column hierarchy that is used during drill-downs and drill-ups.

filledMapVisual_conditionalFormatting :: Lens' FilledMapVisual (Maybe FilledMapConditionalFormatting) Source #

The conditional formatting of a FilledMapVisual.

filledMapVisual_subtitle :: Lens' FilledMapVisual (Maybe VisualSubtitleLabelOptions) Source #

The subtitle that is displayed on the visual.

filledMapVisual_title :: Lens' FilledMapVisual (Maybe VisualTitleLabelOptions) Source #

The title that is displayed on the visual.

filledMapVisual_visualId :: Lens' FilledMapVisual Text Source #

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..

Filter

filter_categoryFilter :: Lens' Filter (Maybe CategoryFilter) Source #

A CategoryFilter filters text values.

For more information, see Adding text filters in the Amazon QuickSight User Guide.

filter_numericEqualityFilter :: Lens' Filter (Maybe NumericEqualityFilter) Source #

A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.

filter_numericRangeFilter :: Lens' Filter (Maybe NumericRangeFilter) Source #

A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.

filter_relativeDatesFilter :: Lens' Filter (Maybe RelativeDatesFilter) Source #

A RelativeDatesFilter filters date values that are relative to a given date.

filter_timeEqualityFilter :: Lens' Filter (Maybe TimeEqualityFilter) Source #

A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value.

filter_timeRangeFilter :: Lens' Filter (Maybe TimeRangeFilter) Source #

A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.

filter_topBottomFilter :: Lens' Filter (Maybe TopBottomFilter) Source #

A TopBottomFilter filters data to the top or bottom values for a given column.

FilterControl

filterControl_dateTimePicker :: Lens' FilterControl (Maybe FilterDateTimePickerControl) Source #

A control from a date filter that is used to specify date and time.

filterControl_dropdown :: Lens' FilterControl (Maybe FilterDropDownControl) Source #

A control to display a dropdown list with buttons that are used to select a single value.

filterControl_list :: Lens' FilterControl (Maybe FilterListControl) Source #

A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.

filterControl_relativeDateTime :: Lens' FilterControl (Maybe FilterRelativeDateTimeControl) Source #

A control from a date filter that is used to specify the relative date.

filterControl_slider :: Lens' FilterControl (Maybe FilterSliderControl) Source #

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

filterControl_textArea :: Lens' FilterControl (Maybe FilterTextAreaControl) Source #

A control to display a text box that is used to enter multiple entries.

filterControl_textField :: Lens' FilterControl (Maybe FilterTextFieldControl) Source #

A control to display a text box that is used to enter a single entry.

FilterDateTimePickerControl

filterDateTimePickerControl_displayOptions :: Lens' FilterDateTimePickerControl (Maybe DateTimePickerControlDisplayOptions) Source #

The display options of a control.

filterDateTimePickerControl_type :: Lens' FilterDateTimePickerControl (Maybe SheetControlDateTimePickerType) Source #

The date time picker type of a FilterDateTimePickerControl. Choose one of the following options:

SINGLE_VALUED: The filter condition is a fixed date.
DATE_RANGE: The filter condition is a date time range.

filterDateTimePickerControl_filterControlId :: Lens' FilterDateTimePickerControl Text Source #

The ID of the FilterDateTimePickerControl.

filterDateTimePickerControl_title :: Lens' FilterDateTimePickerControl Text Source #

The title of the FilterDateTimePickerControl.

filterDateTimePickerControl_sourceFilterId :: Lens' FilterDateTimePickerControl Text Source #

The source filter ID of the FilterDateTimePickerControl.

FilterDropDownControl

filterDropDownControl_cascadingControlConfiguration :: Lens' FilterDropDownControl (Maybe CascadingControlConfiguration) Source #

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

filterDropDownControl_displayOptions :: Lens' FilterDropDownControl (Maybe DropDownControlDisplayOptions) Source #

The display options of the FilterDropDownControl.

filterDropDownControl_selectableValues :: Lens' FilterDropDownControl (Maybe FilterSelectableValues) Source #

A list of selectable values that are used in a control.

filterDropDownControl_type :: Lens' FilterDropDownControl (Maybe SheetControlListType) Source #

The type of the FilterDropDownControl. Choose one of the following options:

MULTI_SELECT: The user can select multiple entries from a dropdown menu.
SINGLE_SELECT: The user can select a single entry from a dropdown menu.

filterDropDownControl_filterControlId :: Lens' FilterDropDownControl Text Source #

The ID of the FilterDropDownControl.

filterDropDownControl_title :: Lens' FilterDropDownControl Text Source #

The title of the FilterDropDownControl.

filterDropDownControl_sourceFilterId :: Lens' FilterDropDownControl Text Source #

The source filter ID of the FilterDropDownControl.

FilterGroup

filterGroup_status :: Lens' FilterGroup (Maybe WidgetStatus) Source #

The status of the FilterGroup.

filterGroup_filterGroupId :: Lens' FilterGroup Text Source #

The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.

filterGroup_filters :: Lens' FilterGroup [Filter] Source #

The list of filters that are present in a FilterGroup.

filterGroup_scopeConfiguration :: Lens' FilterGroup FilterScopeConfiguration Source #

The configuration that specifies what scope to apply to a FilterGroup.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

filterGroup_crossDataset :: Lens' FilterGroup CrossDatasetTypes Source #

The filter new feature which can apply filter group to all data sets. Choose one of the following options:

```
ALL_DATASETS
```
```
SINGLE_DATASET
```

FilterListConfiguration

filterListConfiguration_categoryValues :: Lens' FilterListConfiguration (Maybe [Text]) Source #

The list of category values for the filter.

filterListConfiguration_selectAllOptions :: Lens' FilterListConfiguration (Maybe CategoryFilterSelectAllOptions) Source #

Select all of the values. Null is not the assigned value of select all.

```
FILTER_ALL_VALUES
```

filterListConfiguration_matchOperator :: Lens' FilterListConfiguration CategoryFilterMatchOperator Source #

The match operator that is used to determine if a filter should be applied.

FilterListControl

filterListControl_cascadingControlConfiguration :: Lens' FilterListControl (Maybe CascadingControlConfiguration) Source #

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

filterListControl_displayOptions :: Lens' FilterListControl (Maybe ListControlDisplayOptions) Source #

The display options of a control.

filterListControl_selectableValues :: Lens' FilterListControl (Maybe FilterSelectableValues) Source #

A list of selectable values that are used in a control.

filterListControl_type :: Lens' FilterListControl (Maybe SheetControlListType) Source #

The type of FilterListControl. Choose one of the following options:

MULTI_SELECT: The user can select multiple entries from the list.
SINGLE_SELECT: The user can select a single entry from the list.

filterListControl_filterControlId :: Lens' FilterListControl Text Source #

The ID of the FilterListControl.

filterListControl_title :: Lens' FilterListControl Text Source #

The title of the FilterListControl.

filterListControl_sourceFilterId :: Lens' FilterListControl Text Source #

The source filter ID of the FilterListControl.

FilterOperation

filterOperation_conditionExpression :: Lens' FilterOperation Text Source #

An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.

FilterOperationSelectedFieldsConfiguration

filterOperationSelectedFieldsConfiguration_selectedFieldOptions :: Lens' FilterOperationSelectedFieldsConfiguration (Maybe SelectedFieldOptions) Source #

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation.

Valid values are defined as follows:

ALL_FIELDS: Applies the filter operation to all fields.

filterOperationSelectedFieldsConfiguration_selectedFields :: Lens' FilterOperationSelectedFieldsConfiguration (Maybe (NonEmpty Text)) Source #

Chooses the fields that are filtered in CustomActionFilterOperation.

FilterOperationTargetVisualsConfiguration

filterOperationTargetVisualsConfiguration_sameSheetTargetVisualConfiguration :: Lens' FilterOperationTargetVisualsConfiguration (Maybe SameSheetTargetVisualConfiguration) Source #

The configuration of the same-sheet target visuals that you want to be filtered.

FilterRelativeDateTimeControl

filterRelativeDateTimeControl_displayOptions :: Lens' FilterRelativeDateTimeControl (Maybe RelativeDateTimeControlDisplayOptions) Source #

The display options of a control.

filterRelativeDateTimeControl_filterControlId :: Lens' FilterRelativeDateTimeControl Text Source #

The ID of the FilterTextAreaControl.

filterRelativeDateTimeControl_title :: Lens' FilterRelativeDateTimeControl Text Source #

The title of the FilterTextAreaControl.

filterRelativeDateTimeControl_sourceFilterId :: Lens' FilterRelativeDateTimeControl Text Source #

The source filter ID of the FilterTextAreaControl.

FilterScopeConfiguration

filterScopeConfiguration_selectedSheets :: Lens' FilterScopeConfiguration (Maybe SelectedSheetsFilterScopeConfiguration) Source #

The configuration for applying a filter to specific sheets.

FilterSelectableValues

filterSelectableValues_values :: Lens' FilterSelectableValues (Maybe [Text]) Source #

The values that are used in the FilterSelectableValues.

FilterSliderControl

filterSliderControl_displayOptions :: Lens' FilterSliderControl (Maybe SliderControlDisplayOptions) Source #

The display options of a control.

filterSliderControl_type :: Lens' FilterSliderControl (Maybe SheetControlSliderType) Source #

The type of FilterSliderControl. Choose one of the following options:

SINGLE_POINT: Filter against(equals) a single data point.
RANGE: Filter data that is in a specified range.

filterSliderControl_filterControlId :: Lens' FilterSliderControl Text Source #

The ID of the FilterSliderControl.

filterSliderControl_title :: Lens' FilterSliderControl Text Source #

The title of the FilterSliderControl.

filterSliderControl_sourceFilterId :: Lens' FilterSliderControl Text Source #

The source filter ID of the FilterSliderControl.

filterSliderControl_maximumValue :: Lens' FilterSliderControl Double Source #

The smaller value that is displayed at the left of the slider.

filterSliderControl_minimumValue :: Lens' FilterSliderControl Double Source #

The larger value that is displayed at the right of the slider.

filterSliderControl_stepSize :: Lens' FilterSliderControl Double Source #

The number of increments that the slider bar is divided into.

FilterTextAreaControl

filterTextAreaControl_delimiter :: Lens' FilterTextAreaControl (Maybe Text) Source #

The delimiter that is used to separate the lines in text.

filterTextAreaControl_displayOptions :: Lens' FilterTextAreaControl (Maybe TextAreaControlDisplayOptions) Source #

The display options of a control.

filterTextAreaControl_filterControlId :: Lens' FilterTextAreaControl Text Source #

The ID of the FilterTextAreaControl.

filterTextAreaControl_title :: Lens' FilterTextAreaControl Text Source #

The title of the FilterTextAreaControl.

filterTextAreaControl_sourceFilterId :: Lens' FilterTextAreaControl Text Source #

The source filter ID of the FilterTextAreaControl.

FilterTextFieldControl

filterTextFieldControl_displayOptions :: Lens' FilterTextFieldControl (Maybe TextFieldControlDisplayOptions) Source #

The display options of a control.

filterTextFieldControl_filterControlId :: Lens' FilterTextFieldControl Text Source #

The ID of the FilterTextFieldControl.

filterTextFieldControl_title :: Lens' FilterTextFieldControl Text Source #

The title of the FilterTextFieldControl.

filterTextFieldControl_sourceFilterId :: Lens' FilterTextFieldControl Text Source #

The source filter ID of the FilterTextFieldControl.

Folder

folder_arn :: Lens' Folder (Maybe Text) Source #

The Amazon Resource Name (ARN) for the folder.

folder_createdTime :: Lens' Folder (Maybe UTCTime) Source #

The time that the folder was created.

folder_folderId :: Lens' Folder (Maybe Text) Source #

The ID of the folder.

folder_folderPath :: Lens' Folder (Maybe (NonEmpty Text)) Source #

An array of ancestor ARN strings for the folder.

folder_folderType :: Lens' Folder (Maybe FolderType) Source #

The type of folder it is.

folder_lastUpdatedTime :: Lens' Folder (Maybe UTCTime) Source #

The time that the folder was last updated.

folder_name :: Lens' Folder (Maybe Text) Source #

A display name for the folder.

FolderMember

folderMember_memberId :: Lens' FolderMember (Maybe Text) Source #

The ID of an asset in the folder.

folderMember_memberType :: Lens' FolderMember (Maybe MemberType) Source #

The type of asset that it is.

FolderSearchFilter

folderSearchFilter_name :: Lens' FolderSearchFilter (Maybe FolderFilterAttribute) Source #

The name of a value that you want to use in the filter. For example, "Name": "QUICKSIGHT_OWNER".

Valid values are defined as follows:

QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the folder's owners or viewers are returned. Implicit permissions from folders or groups are considered.
QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are considered.
DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as the only owner of the folder are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners or viewers of the folders are returned. Implicit permissions from folders or groups are not considered.
FOLDER_NAME: Any folders whose names have a substring match to this value will be returned.
PARENT_FOLDER_ARN: Provide an ARN of a folder, and any folders that are directly under that parent folder are returned. If you choose to use this option and leave the value blank, all root-level folders in the account are returned.

folderSearchFilter_operator :: Lens' FolderSearchFilter (Maybe FilterOperator) Source #

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".

If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value FOLDER_NAME.

folderSearchFilter_value :: Lens' FolderSearchFilter (Maybe Text) Source #

The value of the named item (in this example, PARENT_FOLDER_ARN), that you want to use as a filter. For example, "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId".

FolderSummary

folderSummary_arn :: Lens' FolderSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the folder.

folderSummary_createdTime :: Lens' FolderSummary (Maybe UTCTime) Source #

The time that the folder was created.

folderSummary_folderId :: Lens' FolderSummary (Maybe Text) Source #

The ID of the folder.

folderSummary_folderType :: Lens' FolderSummary (Maybe FolderType) Source #

The type of folder.

folderSummary_lastUpdatedTime :: Lens' FolderSummary (Maybe UTCTime) Source #

The time that the folder was last updated.

folderSummary_name :: Lens' FolderSummary (Maybe Text) Source #

The display name of the folder.

Font

font_fontFamily :: Lens' Font (Maybe Text) Source #

Determines the font family settings.

FontConfiguration

fontConfiguration_fontColor :: Lens' FontConfiguration (Maybe Text) Source #

Determines the color of the text.

fontConfiguration_fontDecoration :: Lens' FontConfiguration (Maybe FontDecoration) Source #

Determines the appearance of decorative lines on the text.

fontConfiguration_fontSize :: Lens' FontConfiguration (Maybe FontSize) Source #

The option that determines the text display size.

fontConfiguration_fontStyle :: Lens' FontConfiguration (Maybe FontStyle) Source #

Determines the text display face that is inherited by the given font family.

fontConfiguration_fontWeight :: Lens' FontConfiguration (Maybe FontWeight) Source #

The option that determines the text display weight, or boldness.

FontWeight

fontWeight_name :: Lens' FontWeight (Maybe FontWeightName) Source #

The lexical name for the level of boldness of the text display.

ForecastComputation

forecastComputation_customSeasonalityValue :: Lens' ForecastComputation (Maybe Natural) Source #

The custom seasonality value setup of a forecast computation.

forecastComputation_lowerBoundary :: Lens' ForecastComputation (Maybe Double) Source #

The lower boundary setup of a forecast computation.

forecastComputation_name :: Lens' ForecastComputation (Maybe Text) Source #

The name of a computation.

forecastComputation_periodsBackward :: Lens' ForecastComputation (Maybe Natural) Source #

The periods backward setup of a forecast computation.

forecastComputation_periodsForward :: Lens' ForecastComputation (Maybe Natural) Source #

The periods forward setup of a forecast computation.

forecastComputation_predictionInterval :: Lens' ForecastComputation (Maybe Natural) Source #

The prediction interval setup of a forecast computation.

forecastComputation_seasonality :: Lens' ForecastComputation (Maybe ForecastComputationSeasonality) Source #

The seasonality setup of a forecast computation. Choose one of the following options:

```
AUTOMATIC
```
CUSTOM: Checks the custom seasonality value.

forecastComputation_upperBoundary :: Lens' ForecastComputation (Maybe Double) Source #

The upper boundary setup of a forecast computation.

forecastComputation_value :: Lens' ForecastComputation (Maybe MeasureField) Source #

The value field that is used in a computation.

forecastComputation_computationId :: Lens' ForecastComputation Text Source #

The ID for a computation.

forecastComputation_time :: Lens' ForecastComputation DimensionField Source #

The time field that is used in a computation.

ForecastConfiguration

forecastConfiguration_forecastProperties :: Lens' ForecastConfiguration (Maybe TimeBasedForecastProperties) Source #

The forecast properties setup of a forecast in the line chart.

forecastConfiguration_scenario :: Lens' ForecastConfiguration (Maybe ForecastScenario) Source #

The forecast scenario of a forecast in the line chart.

ForecastScenario

forecastScenario_whatIfPointScenario :: Lens' ForecastScenario (Maybe WhatIfPointScenario) Source #

The what-if analysis forecast setup with the target date.

forecastScenario_whatIfRangeScenario :: Lens' ForecastScenario (Maybe WhatIfRangeScenario) Source #

The what-if analysis forecast setup with the date range.

FormatConfiguration

formatConfiguration_dateTimeFormatConfiguration :: Lens' FormatConfiguration (Maybe DateTimeFormatConfiguration) Source #

Formatting configuration for DateTime fields.

formatConfiguration_numberFormatConfiguration :: Lens' FormatConfiguration (Maybe NumberFormatConfiguration) Source #

Formatting configuration for number fields.

formatConfiguration_stringFormatConfiguration :: Lens' FormatConfiguration (Maybe StringFormatConfiguration) Source #

Formatting configuration for string fields.

FreeFormLayoutCanvasSizeOptions

freeFormLayoutCanvasSizeOptions_screenCanvasSizeOptions :: Lens' FreeFormLayoutCanvasSizeOptions (Maybe FreeFormLayoutScreenCanvasSizeOptions) Source #

The options that determine the sizing of the canvas used in a free-form layout.

FreeFormLayoutConfiguration

freeFormLayoutConfiguration_canvasSizeOptions :: Lens' FreeFormLayoutConfiguration (Maybe FreeFormLayoutCanvasSizeOptions) Source #

Undocumented member.

freeFormLayoutConfiguration_elements :: Lens' FreeFormLayoutConfiguration [FreeFormLayoutElement] Source #

The elements that are included in a free-form layout.

FreeFormLayoutElement

freeFormLayoutElement_backgroundStyle :: Lens' FreeFormLayoutElement (Maybe FreeFormLayoutElementBackgroundStyle) Source #

The background style configuration of a free-form layout element.

freeFormLayoutElement_borderStyle :: Lens' FreeFormLayoutElement (Maybe FreeFormLayoutElementBorderStyle) Source #

The border style configuration of a free-form layout element.

freeFormLayoutElement_loadingAnimation :: Lens' FreeFormLayoutElement (Maybe LoadingAnimation) Source #

The loading animation configuration of a free-form layout element.

freeFormLayoutElement_renderingRules :: Lens' FreeFormLayoutElement (Maybe [SheetElementRenderingRule]) Source #

The rendering rules that determine when an element should be displayed within a free-form layout.

freeFormLayoutElement_selectedBorderStyle :: Lens' FreeFormLayoutElement (Maybe FreeFormLayoutElementBorderStyle) Source #

The border style configuration of a free-form layout element. This border style is used when the element is selected.

freeFormLayoutElement_visibility :: Lens' FreeFormLayoutElement (Maybe Visibility) Source #

The visibility of an element within a free-form layout.

freeFormLayoutElement_elementId :: Lens' FreeFormLayoutElement Text Source #

A unique identifier for an element within a free-form layout.

freeFormLayoutElement_elementType :: Lens' FreeFormLayoutElement LayoutElementType Source #

The type of element.

freeFormLayoutElement_xAxisLocation :: Lens' FreeFormLayoutElement Text Source #

The x-axis coordinate of the element.

freeFormLayoutElement_yAxisLocation :: Lens' FreeFormLayoutElement Text Source #

The y-axis coordinate of the element.

freeFormLayoutElement_width :: Lens' FreeFormLayoutElement Text Source #

The width of an element within a free-form layout.

freeFormLayoutElement_height :: Lens' FreeFormLayoutElement Text Source #

The height of an element within a free-form layout.

FreeFormLayoutElementBackgroundStyle

freeFormLayoutElementBackgroundStyle_color :: Lens' FreeFormLayoutElementBackgroundStyle (Maybe Text) Source #

The background color of a free-form layout element.

freeFormLayoutElementBackgroundStyle_visibility :: Lens' FreeFormLayoutElementBackgroundStyle (Maybe Visibility) Source #

The background visibility of a free-form layout element.

FreeFormLayoutElementBorderStyle

freeFormLayoutElementBorderStyle_color :: Lens' FreeFormLayoutElementBorderStyle (Maybe Text) Source #

The border color of a free-form layout element.

freeFormLayoutElementBorderStyle_visibility :: Lens' FreeFormLayoutElementBorderStyle (Maybe Visibility) Source #

The border visibility of a free-form layout element.

FreeFormLayoutScreenCanvasSizeOptions

freeFormLayoutScreenCanvasSizeOptions_optimizedViewPortWidth :: Lens' FreeFormLayoutScreenCanvasSizeOptions Text Source #

The width that the view port will be optimized for when the layout renders.

FreeFormSectionLayoutConfiguration

freeFormSectionLayoutConfiguration_elements :: Lens' FreeFormSectionLayoutConfiguration [FreeFormLayoutElement] Source #

The elements that are included in the free-form layout.

FunnelChartAggregatedFieldWells

funnelChartAggregatedFieldWells_category :: Lens' FunnelChartAggregatedFieldWells (Maybe [DimensionField]) Source #

The category field wells of a funnel chart. Values are grouped by category fields.

funnelChartAggregatedFieldWells_values :: Lens' FunnelChartAggregatedFieldWells (Maybe [MeasureField]) Source #

The value field wells of a funnel chart. Values are aggregated based on categories.

FunnelChartConfiguration

funnelChartConfiguration_categoryLabelOptions :: Lens' FunnelChartConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options of the categories that are displayed in a FunnelChartVisual.

funnelChartConfiguration_dataLabelOptions :: Lens' FunnelChartConfiguration (Maybe FunnelChartDataLabelOptions) Source #

The options that determine the presentation of the data labels.

funnelChartConfiguration_fieldWells :: Lens' FunnelChartConfiguration (Maybe FunnelChartFieldWells) Source #

The field well configuration of a FunnelChartVisual.

funnelChartConfiguration_sortConfiguration :: Lens' FunnelChartConfiguration (Maybe FunnelChartSortConfiguration) Source #

The sort configuration of a FunnelChartVisual.

funnelChartConfiguration_tooltip :: Lens' FunnelChartConfiguration (Maybe TooltipOptions) Source #

The tooltip configuration of a FunnelChartVisual.

funnelChartConfiguration_valueLabelOptions :: Lens' FunnelChartConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options for the values that are displayed in a FunnelChartVisual.

funnelChartConfiguration_visualPalette :: Lens' FunnelChartConfiguration (Maybe VisualPalette) Source #

The visual palette configuration of a FunnelChartVisual.

FunnelChartDataLabelOptions

funnelChartDataLabelOptions_categoryLabelVisibility :: Lens' FunnelChartDataLabelOptions (Maybe Visibility) Source #

The visibility of the category labels within the data labels.

funnelChartDataLabelOptions_labelColor :: Lens' FunnelChartDataLabelOptions (Maybe Text) Source #

The color of the data label text.

funnelChartDataLabelOptions_labelFontConfiguration :: Lens' FunnelChartDataLabelOptions (Maybe FontConfiguration) Source #

The font configuration for the data labels.

Only the FontSize attribute of the font configuration is used for data labels.

funnelChartDataLabelOptions_measureDataLabelStyle :: Lens' FunnelChartDataLabelOptions (Maybe FunnelChartMeasureDataLabelStyle) Source #

Determines the style of the metric labels.

funnelChartDataLabelOptions_measureLabelVisibility :: Lens' FunnelChartDataLabelOptions (Maybe Visibility) Source #

The visibility of the measure labels within the data labels.

funnelChartDataLabelOptions_position :: Lens' FunnelChartDataLabelOptions (Maybe DataLabelPosition) Source #

Determines the positioning of the data label relative to a section of the funnel.

funnelChartDataLabelOptions_visibility :: Lens' FunnelChartDataLabelOptions (Maybe Visibility) Source #

The visibility option that determines if data labels are displayed.

FunnelChartFieldWells

funnelChartFieldWells_funnelChartAggregatedFieldWells :: Lens' FunnelChartFieldWells (Maybe FunnelChartAggregatedFieldWells) Source #

The field well configuration of a FunnelChartVisual.

FunnelChartSortConfiguration

funnelChartSortConfiguration_categoryItemsLimit :: Lens' FunnelChartSortConfiguration (Maybe ItemsLimitConfiguration) Source #

The limit on the number of categories displayed.

funnelChartSortConfiguration_categorySort :: Lens' FunnelChartSortConfiguration (Maybe [FieldSortOptions]) Source #

The sort configuration of the category fields.

FunnelChartVisual

funnelChartVisual_actions :: Lens' FunnelChartVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

funnelChartVisual_chartConfiguration :: Lens' FunnelChartVisual (Maybe FunnelChartConfiguration) Source #

The configuration of a FunnelChartVisual.

funnelChartVisual_columnHierarchies :: Lens' FunnelChartVisual (Maybe [ColumnHierarchy]) Source #

The column hierarchy that is used during drill-downs and drill-ups.

funnelChartVisual_subtitle :: Lens' FunnelChartVisual (Maybe VisualSubtitleLabelOptions) Source #

The subtitle that is displayed on the visual.

funnelChartVisual_title :: Lens' FunnelChartVisual (Maybe VisualTitleLabelOptions) Source #

The title that is displayed on the visual.

funnelChartVisual_visualId :: Lens' FunnelChartVisual Text Source #

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..

GaugeChartArcConditionalFormatting

gaugeChartArcConditionalFormatting_foregroundColor :: Lens' GaugeChartArcConditionalFormatting (Maybe ConditionalFormattingColor) Source #

The conditional formatting of the arc foreground color.

GaugeChartConditionalFormatting

gaugeChartConditionalFormatting_conditionalFormattingOptions :: Lens' GaugeChartConditionalFormatting (Maybe [GaugeChartConditionalFormattingOption]) Source #

Conditional formatting options of a GaugeChartVisual.

GaugeChartConditionalFormattingOption

gaugeChartConditionalFormattingOption_arc :: Lens' GaugeChartConditionalFormattingOption (Maybe GaugeChartArcConditionalFormatting) Source #

The options that determine the presentation of the arc of a GaugeChartVisual.

gaugeChartConditionalFormattingOption_primaryValue :: Lens' GaugeChartConditionalFormattingOption (Maybe GaugeChartPrimaryValueConditionalFormatting) Source #

The conditional formatting for the primary value of a GaugeChartVisual.

GaugeChartConfiguration

gaugeChartConfiguration_dataLabels :: Lens' GaugeChartConfiguration (Maybe DataLabelOptions) Source #

The data label configuration of a GaugeChartVisual.

gaugeChartConfiguration_fieldWells :: Lens' GaugeChartConfiguration (Maybe GaugeChartFieldWells) Source #

The field well configuration of a GaugeChartVisual.

gaugeChartConfiguration_gaugeChartOptions :: Lens' GaugeChartConfiguration (Maybe GaugeChartOptions) Source #

The options that determine the presentation of the GaugeChartVisual.

gaugeChartConfiguration_tooltipOptions :: Lens' GaugeChartConfiguration (Maybe TooltipOptions) Source #

The tooltip configuration of a GaugeChartVisual.

gaugeChartConfiguration_visualPalette :: Lens' GaugeChartConfiguration (Maybe VisualPalette) Source #

The visual palette configuration of a GaugeChartVisual.

GaugeChartFieldWells

gaugeChartFieldWells_targetValues :: Lens' GaugeChartFieldWells (Maybe [MeasureField]) Source #

The target value field wells of a GaugeChartVisual.

gaugeChartFieldWells_values :: Lens' GaugeChartFieldWells (Maybe [MeasureField]) Source #

The value field wells of a GaugeChartVisual.

GaugeChartOptions

gaugeChartOptions_arc :: Lens' GaugeChartOptions (Maybe ArcConfiguration) Source #

The arc configuration of a GaugeChartVisual.

gaugeChartOptions_arcAxis :: Lens' GaugeChartOptions (Maybe ArcAxisConfiguration) Source #

The arc axis configuration of a GaugeChartVisual.

gaugeChartOptions_comparison :: Lens' GaugeChartOptions (Maybe ComparisonConfiguration) Source #

The comparison configuration of a GaugeChartVisual.

gaugeChartOptions_primaryValueDisplayType :: Lens' GaugeChartOptions (Maybe PrimaryValueDisplayType) Source #

The options that determine the primary value display type.

gaugeChartOptions_primaryValueFontConfiguration :: Lens' GaugeChartOptions (Maybe FontConfiguration) Source #

The options that determine the primary value font configuration.

GaugeChartPrimaryValueConditionalFormatting

gaugeChartPrimaryValueConditionalFormatting_icon :: Lens' GaugeChartPrimaryValueConditionalFormatting (Maybe ConditionalFormattingIcon) Source #

The conditional formatting of the primary value icon.

gaugeChartPrimaryValueConditionalFormatting_textColor :: Lens' GaugeChartPrimaryValueConditionalFormatting (Maybe ConditionalFormattingColor) Source #

The conditional formatting of the primary value text color.

GaugeChartVisual

gaugeChartVisual_actions :: Lens' GaugeChartVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

gaugeChartVisual_chartConfiguration :: Lens' GaugeChartVisual (Maybe GaugeChartConfiguration) Source #

The configuration of a GaugeChartVisual.

gaugeChartVisual_conditionalFormatting :: Lens' GaugeChartVisual (Maybe GaugeChartConditionalFormatting) Source #

The conditional formatting of a GaugeChartVisual.

gaugeChartVisual_subtitle :: Lens' GaugeChartVisual (Maybe VisualSubtitleLabelOptions) Source #

The subtitle that is displayed on the visual.

gaugeChartVisual_title :: Lens' GaugeChartVisual (Maybe VisualTitleLabelOptions) Source #

The title that is displayed on the visual.

gaugeChartVisual_visualId :: Lens' GaugeChartVisual Text Source #

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.

GeoSpatialColumnGroup

geoSpatialColumnGroup_countryCode :: Lens' GeoSpatialColumnGroup (Maybe GeoSpatialCountryCode) Source #

Country code.

geoSpatialColumnGroup_name :: Lens' GeoSpatialColumnGroup Text Source #

A display name for the hierarchy.

geoSpatialColumnGroup_columns :: Lens' GeoSpatialColumnGroup (NonEmpty Text) Source #

Columns in this hierarchy.

GeospatialCoordinateBounds

geospatialCoordinateBounds_north :: Lens' GeospatialCoordinateBounds Double Source #

The latitude of the north bound of the geospatial coordinate bounds.

geospatialCoordinateBounds_south :: Lens' GeospatialCoordinateBounds Double Source #

The latitude of the south bound of the geospatial coordinate bounds.

geospatialCoordinateBounds_west :: Lens' GeospatialCoordinateBounds Double Source #

The longitude of the west bound of the geospatial coordinate bounds.

geospatialCoordinateBounds_east :: Lens' GeospatialCoordinateBounds Double Source #

The longitude of the east bound of the geospatial coordinate bounds.

GeospatialMapAggregatedFieldWells

geospatialMapAggregatedFieldWells_colors :: Lens' GeospatialMapAggregatedFieldWells (Maybe [DimensionField]) Source #

The color field wells of a geospatial map.

geospatialMapAggregatedFieldWells_geospatial :: Lens' GeospatialMapAggregatedFieldWells (Maybe [DimensionField]) Source #

The geospatial field wells of a geospatial map. Values are grouped by geospatial fields.

geospatialMapAggregatedFieldWells_values :: Lens' GeospatialMapAggregatedFieldWells (Maybe [MeasureField]) Source #

The size field wells of a geospatial map. Values are aggregated based on geospatial fields.

GeospatialMapConfiguration

geospatialMapConfiguration_fieldWells :: Lens' GeospatialMapConfiguration (Maybe GeospatialMapFieldWells) Source #

The field wells of the visual.

geospatialMapConfiguration_legend :: Lens' GeospatialMapConfiguration (Maybe LegendOptions) Source #

The legend display setup of the visual.

geospatialMapConfiguration_mapStyleOptions :: Lens' GeospatialMapConfiguration (Maybe GeospatialMapStyleOptions) Source #

The map style options of the geospatial map.

geospatialMapConfiguration_pointStyleOptions :: Lens' GeospatialMapConfiguration (Maybe GeospatialPointStyleOptions) Source #

The point style options of the geospatial map.

geospatialMapConfiguration_tooltip :: Lens' GeospatialMapConfiguration (Maybe TooltipOptions) Source #

The tooltip display setup of the visual.

geospatialMapConfiguration_visualPalette :: Lens' GeospatialMapConfiguration (Maybe VisualPalette) Source #

Undocumented member.

geospatialMapConfiguration_windowOptions :: Lens' GeospatialMapConfiguration (Maybe GeospatialWindowOptions) Source #

The window options of the geospatial map.

GeospatialMapFieldWells

geospatialMapFieldWells_geospatialMapAggregatedFieldWells :: Lens' GeospatialMapFieldWells (Maybe GeospatialMapAggregatedFieldWells) Source #

The aggregated field well for a geospatial map.

GeospatialMapStyleOptions

geospatialMapStyleOptions_baseMapStyle :: Lens' GeospatialMapStyleOptions (Maybe BaseMapStyleType) Source #

The base map style of the geospatial map.

GeospatialMapVisual

geospatialMapVisual_actions :: Lens' GeospatialMapVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

geospatialMapVisual_chartConfiguration :: Lens' GeospatialMapVisual (Maybe GeospatialMapConfiguration) Source #

The configuration settings of the visual.

geospatialMapVisual_columnHierarchies :: Lens' GeospatialMapVisual (Maybe [ColumnHierarchy]) Source #

The column hierarchy that is used during drill-downs and drill-ups.

geospatialMapVisual_subtitle :: Lens' GeospatialMapVisual (Maybe VisualSubtitleLabelOptions) Source #

The subtitle that is displayed on the visual.

geospatialMapVisual_title :: Lens' GeospatialMapVisual (Maybe VisualTitleLabelOptions) Source #

The title that is displayed on the visual.

geospatialMapVisual_visualId :: Lens' GeospatialMapVisual Text Source #

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..

GeospatialPointStyleOptions

geospatialPointStyleOptions_clusterMarkerConfiguration :: Lens' GeospatialPointStyleOptions (Maybe ClusterMarkerConfiguration) Source #

The cluster marker configuration of the geospatial point style.

geospatialPointStyleOptions_selectedPointStyle :: Lens' GeospatialPointStyleOptions (Maybe GeospatialSelectedPointStyle) Source #

The selected point styles (point, cluster) of the geospatial map.

GeospatialWindowOptions

geospatialWindowOptions_bounds :: Lens' GeospatialWindowOptions (Maybe GeospatialCoordinateBounds) Source #

The bounds options (north, south, west, east) of the geospatial window options.

geospatialWindowOptions_mapZoomMode :: Lens' GeospatialWindowOptions (Maybe MapZoomMode) Source #

The map zoom modes (manual, auto) of the geospatial window options.

GlobalTableBorderOptions

globalTableBorderOptions_sideSpecificBorder :: Lens' GlobalTableBorderOptions (Maybe TableSideBorderOptions) Source #

Determines the options for side specific border.

globalTableBorderOptions_uniformBorder :: Lens' GlobalTableBorderOptions (Maybe TableBorderOptions) Source #

Determines the options for uniform border.

GradientColor

gradientColor_stops :: Lens' GradientColor (Maybe [GradientStop]) Source #

The list of gradient color stops.

GradientStop

gradientStop_color :: Lens' GradientStop (Maybe Text) Source #

Determines the color.

gradientStop_dataValue :: Lens' GradientStop (Maybe Double) Source #

Determines the data value.

gradientStop_gradientOffset :: Lens' GradientStop Double Source #

Determines gradient offset value.

GridLayoutCanvasSizeOptions

gridLayoutCanvasSizeOptions_screenCanvasSizeOptions :: Lens' GridLayoutCanvasSizeOptions (Maybe GridLayoutScreenCanvasSizeOptions) Source #

The options that determine the sizing of the canvas used in a grid layout.

GridLayoutConfiguration

gridLayoutConfiguration_canvasSizeOptions :: Lens' GridLayoutConfiguration (Maybe GridLayoutCanvasSizeOptions) Source #

Undocumented member.

gridLayoutConfiguration_elements :: Lens' GridLayoutConfiguration [GridLayoutElement] Source #

The elements that are included in a grid layout.

GridLayoutElement

gridLayoutElement_columnIndex :: Lens' GridLayoutElement (Maybe Natural) Source #

The column index for the upper left corner of an element.

gridLayoutElement_rowIndex :: Lens' GridLayoutElement (Maybe Natural) Source #

The row index for the upper left corner of an element.

gridLayoutElement_elementId :: Lens' GridLayoutElement Text Source #

A unique identifier for an element within a grid layout.

gridLayoutElement_elementType :: Lens' GridLayoutElement LayoutElementType Source #

The type of element.

gridLayoutElement_columnSpan :: Lens' GridLayoutElement Natural Source #

The width of a grid element expressed as a number of grid columns.

gridLayoutElement_rowSpan :: Lens' GridLayoutElement Natural Source #

The height of a grid element expressed as a number of grid rows.

GridLayoutScreenCanvasSizeOptions

gridLayoutScreenCanvasSizeOptions_optimizedViewPortWidth :: Lens' GridLayoutScreenCanvasSizeOptions (Maybe Text) Source #

The width that the view port will be optimized for when the layout renders.

gridLayoutScreenCanvasSizeOptions_resizeOption :: Lens' GridLayoutScreenCanvasSizeOptions ResizeOption Source #

This value determines the layout behavior when the viewport is resized.

FIXED: A fixed width will be used when optimizing the layout. In the Amazon QuickSight console, this option is called Classic.
RESPONSIVE: The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is called Tiled.

Group

group_arn :: Lens' Group (Maybe Text) Source #

The Amazon Resource Name (ARN) for the group.

group_description :: Lens' Group (Maybe Text) Source #

The group description.

group_groupName :: Lens' Group (Maybe Text) Source #

The name of the group.

group_principalId :: Lens' Group (Maybe Text) Source #

The principal ID of the group.

GroupMember

groupMember_arn :: Lens' GroupMember (Maybe Text) Source #

The Amazon Resource Name (ARN) for the group member (user).

groupMember_memberName :: Lens' GroupMember (Maybe Text) Source #

The name of the group member (user).

GroupSearchFilter

groupSearchFilter_operator :: Lens' GroupSearchFilter GroupFilterOperator Source #

The comparison operator that you want to use as a filter, for example "Operator": "StartsWith". Currently, the only supported operator is StartsWith.

groupSearchFilter_name :: Lens' GroupSearchFilter GroupFilterAttribute Source #

The name of the value that you want to use as a filter, for example "Name": "GROUP_NAME". Currently, the only supported name is GROUP_NAME.

groupSearchFilter_value :: Lens' GroupSearchFilter Text Source #

The value of the named item, in this case GROUP_NAME, that you want to use as a filter.

GrowthRateComputation

growthRateComputation_name :: Lens' GrowthRateComputation (Maybe Text) Source #

The name of a computation.

growthRateComputation_periodSize :: Lens' GrowthRateComputation (Maybe Natural) Source #

The period size setup of a growth rate computation.

growthRateComputation_value :: Lens' GrowthRateComputation (Maybe MeasureField) Source #

The value field that is used in a computation.

growthRateComputation_computationId :: Lens' GrowthRateComputation Text Source #

The ID for a computation.

growthRateComputation_time :: Lens' GrowthRateComputation DimensionField Source #

The time field that is used in a computation.

GutterStyle

gutterStyle_show :: Lens' GutterStyle (Maybe Bool) Source #

This Boolean value controls whether to display a gutter space between sheet tiles.

HeaderFooterSectionConfiguration

headerFooterSectionConfiguration_style :: Lens' HeaderFooterSectionConfiguration (Maybe SectionStyle) Source #

The style options of a header or footer section.

headerFooterSectionConfiguration_sectionId :: Lens' HeaderFooterSectionConfiguration Text Source #

The unique identifier of the header or footer section.

headerFooterSectionConfiguration_layout :: Lens' HeaderFooterSectionConfiguration SectionLayoutConfiguration Source #

The layout configuration of the header or footer section.

HeatMapAggregatedFieldWells

heatMapAggregatedFieldWells_columns :: Lens' HeatMapAggregatedFieldWells (Maybe [DimensionField]) Source #

The columns field well of a heat map.

heatMapAggregatedFieldWells_rows :: Lens' HeatMapAggregatedFieldWells (Maybe [DimensionField]) Source #

The rows field well of a heat map.

heatMapAggregatedFieldWells_values :: Lens' HeatMapAggregatedFieldWells (Maybe [MeasureField]) Source #

The values field well of a heat map.

HeatMapConfiguration

heatMapConfiguration_colorScale :: Lens' HeatMapConfiguration (Maybe ColorScale) Source #

The color options (gradient color, point of divergence) in a heat map.

heatMapConfiguration_columnLabelOptions :: Lens' HeatMapConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options of the column that is displayed in a heat map.

heatMapConfiguration_dataLabels :: Lens' HeatMapConfiguration (Maybe DataLabelOptions) Source #

The options that determine if visual data labels are displayed.

heatMapConfiguration_fieldWells :: Lens' HeatMapConfiguration (Maybe HeatMapFieldWells) Source #

The field wells of the visual.

heatMapConfiguration_legend :: Lens' HeatMapConfiguration (Maybe LegendOptions) Source #

The legend display setup of the visual.

heatMapConfiguration_rowLabelOptions :: Lens' HeatMapConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options of the row that is displayed in a heat map.

heatMapConfiguration_sortConfiguration :: Lens' HeatMapConfiguration (Maybe HeatMapSortConfiguration) Source #

The sort configuration of a heat map.

heatMapConfiguration_tooltip :: Lens' HeatMapConfiguration (Maybe TooltipOptions) Source #

The tooltip display setup of the visual.

HeatMapFieldWells

heatMapFieldWells_heatMapAggregatedFieldWells :: Lens' HeatMapFieldWells (Maybe HeatMapAggregatedFieldWells) Source #

The aggregated field wells of a heat map.

HeatMapSortConfiguration

heatMapSortConfiguration_heatMapColumnItemsLimitConfiguration :: Lens' HeatMapSortConfiguration (Maybe ItemsLimitConfiguration) Source #

The limit on the number of columns that are displayed in a heat map.

heatMapSortConfiguration_heatMapColumnSort :: Lens' HeatMapSortConfiguration (Maybe [FieldSortOptions]) Source #

The column sort configuration for heat map for columns that aren't a part of a field well.

heatMapSortConfiguration_heatMapRowItemsLimitConfiguration :: Lens' HeatMapSortConfiguration (Maybe ItemsLimitConfiguration) Source #

The limit on the number of rows that are displayed in a heat map.

heatMapSortConfiguration_heatMapRowSort :: Lens' HeatMapSortConfiguration (Maybe [FieldSortOptions]) Source #

The field sort configuration of the rows fields.

HeatMapVisual

heatMapVisual_actions :: Lens' HeatMapVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

heatMapVisual_chartConfiguration :: Lens' HeatMapVisual (Maybe HeatMapConfiguration) Source #

The configuration of a heat map.

heatMapVisual_columnHierarchies :: Lens' HeatMapVisual (Maybe [ColumnHierarchy]) Source #

The column hierarchy that is used during drill-downs and drill-ups.

heatMapVisual_subtitle :: Lens' HeatMapVisual (Maybe VisualSubtitleLabelOptions) Source #

The subtitle that is displayed on the visual.

heatMapVisual_title :: Lens' HeatMapVisual (Maybe VisualTitleLabelOptions) Source #

The title that is displayed on the visual.

heatMapVisual_visualId :: Lens' HeatMapVisual Text Source #

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.

HistogramAggregatedFieldWells

histogramAggregatedFieldWells_values :: Lens' HistogramAggregatedFieldWells (Maybe [MeasureField]) Source #

The value field wells of a histogram. Values are aggregated by COUNT or DISTINCT_COUNT.

HistogramBinOptions

histogramBinOptions_binCount :: Lens' HistogramBinOptions (Maybe BinCountOptions) Source #

The options that determine the bin count of a histogram.

histogramBinOptions_binWidth :: Lens' HistogramBinOptions (Maybe BinWidthOptions) Source #

The options that determine the bin width of a histogram.

histogramBinOptions_selectedBinType :: Lens' HistogramBinOptions (Maybe HistogramBinType) Source #

The options that determine the selected bin type.

histogramBinOptions_startValue :: Lens' HistogramBinOptions (Maybe Double) Source #

The options that determine the bin start value.

HistogramConfiguration

histogramConfiguration_binOptions :: Lens' HistogramConfiguration (Maybe HistogramBinOptions) Source #

The options that determine the presentation of histogram bins.

histogramConfiguration_dataLabels :: Lens' HistogramConfiguration (Maybe DataLabelOptions) Source #

The data label configuration of a histogram.

histogramConfiguration_fieldWells :: Lens' HistogramConfiguration (Maybe HistogramFieldWells) Source #

The field well configuration of a histogram.

histogramConfiguration_tooltip :: Lens' HistogramConfiguration (Maybe TooltipOptions) Source #

The tooltip configuration of a histogram.

histogramConfiguration_visualPalette :: Lens' HistogramConfiguration (Maybe VisualPalette) Source #

The visual palette configuration of a histogram.

histogramConfiguration_xAxisDisplayOptions :: Lens' HistogramConfiguration (Maybe AxisDisplayOptions) Source #

The options that determine the presentation of the x-axis.

histogramConfiguration_xAxisLabelOptions :: Lens' HistogramConfiguration (Maybe ChartAxisLabelOptions) Source #

The options that determine the presentation of the x-axis label.

histogramConfiguration_yAxisDisplayOptions :: Lens' HistogramConfiguration (Maybe AxisDisplayOptions) Source #

The options that determine the presentation of the y-axis.

HistogramFieldWells

histogramFieldWells_histogramAggregatedFieldWells :: Lens' HistogramFieldWells (Maybe HistogramAggregatedFieldWells) Source #

The field well configuration of a histogram.

HistogramVisual

histogramVisual_actions :: Lens' HistogramVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

histogramVisual_chartConfiguration :: Lens' HistogramVisual (Maybe HistogramConfiguration) Source #

The configuration for a HistogramVisual.

histogramVisual_subtitle :: Lens' HistogramVisual (Maybe VisualSubtitleLabelOptions) Source #

The subtitle that is displayed on the visual.

histogramVisual_title :: Lens' HistogramVisual (Maybe VisualTitleLabelOptions) Source #

The title that is displayed on the visual.

histogramVisual_visualId :: Lens' HistogramVisual Text Source #

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.

IAMPolicyAssignment

iAMPolicyAssignment_assignmentId :: Lens' IAMPolicyAssignment (Maybe Text) Source #

Assignment ID.

iAMPolicyAssignment_assignmentName :: Lens' IAMPolicyAssignment (Maybe Text) Source #

Assignment name.

iAMPolicyAssignment_assignmentStatus :: Lens' IAMPolicyAssignment (Maybe AssignmentStatus) Source #

Assignment status.

iAMPolicyAssignment_awsAccountId :: Lens' IAMPolicyAssignment (Maybe Text) Source #

The Amazon Web Services account ID.

iAMPolicyAssignment_identities :: Lens' IAMPolicyAssignment (Maybe (HashMap Text [Text])) Source #

Identities.

iAMPolicyAssignment_policyArn :: Lens' IAMPolicyAssignment (Maybe Text) Source #

The Amazon Resource Name (ARN) for the IAM policy.

IAMPolicyAssignmentSummary

iAMPolicyAssignmentSummary_assignmentName :: Lens' IAMPolicyAssignmentSummary (Maybe Text) Source #

Assignment name.

iAMPolicyAssignmentSummary_assignmentStatus :: Lens' IAMPolicyAssignmentSummary (Maybe AssignmentStatus) Source #

Assignment status.

Ingestion

ingestion_errorInfo :: Lens' Ingestion (Maybe ErrorInfo) Source #

Error information for this ingestion.

ingestion_ingestionId :: Lens' Ingestion (Maybe Text) Source #

Ingestion ID.

ingestion_ingestionSizeInBytes :: Lens' Ingestion (Maybe Integer) Source #

The size of the data ingested, in bytes.

ingestion_ingestionTimeInSeconds :: Lens' Ingestion (Maybe Integer) Source #

The time that this ingestion took, measured in seconds.

ingestion_queueInfo :: Lens' Ingestion (Maybe QueueInfo) Source #

Undocumented member.

ingestion_requestSource :: Lens' Ingestion (Maybe IngestionRequestSource) Source #

Event source for this ingestion.

ingestion_requestType :: Lens' Ingestion (Maybe IngestionRequestType) Source #

Type of this ingestion.

ingestion_rowInfo :: Lens' Ingestion (Maybe RowInfo) Source #

Undocumented member.

ingestion_arn :: Lens' Ingestion Text Source #

The Amazon Resource Name (ARN) of the resource.

ingestion_ingestionStatus :: Lens' Ingestion IngestionStatus Source #

Ingestion status.

ingestion_createdTime :: Lens' Ingestion UTCTime Source #

The time that this ingestion started.

InputColumn

inputColumn_name :: Lens' InputColumn Text Source #

The name of this column in the underlying data source.

inputColumn_type :: Lens' InputColumn InputColumnDataType Source #

The data type of the column.

InsightConfiguration

insightConfiguration_computations :: Lens' InsightConfiguration (Maybe [Computation]) Source #

The computations configurations of the insight visual

insightConfiguration_customNarrative :: Lens' InsightConfiguration (Maybe CustomNarrativeOptions) Source #

The custom narrative of the insight visual.

InsightVisual

insightVisual_actions :: Lens' InsightVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

insightVisual_insightConfiguration :: Lens' InsightVisual (Maybe InsightConfiguration) Source #

The configuration of an insight visual.

insightVisual_subtitle :: Lens' InsightVisual (Maybe VisualSubtitleLabelOptions) Source #

The subtitle that is displayed on the visual.

insightVisual_title :: Lens' InsightVisual (Maybe VisualTitleLabelOptions) Source #

The title that is displayed on the visual.

insightVisual_visualId :: Lens' InsightVisual Text Source #

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.

insightVisual_dataSetIdentifier :: Lens' InsightVisual Text Source #

The dataset that is used in the insight visual.

IntegerDefaultValues

integerDefaultValues_dynamicValue :: Lens' IntegerDefaultValues (Maybe DynamicDefaultValue) Source #

The dynamic value of the IntegerDefaultValues. Different defaults are displayed according to users, groups, and values mapping.

integerDefaultValues_staticValues :: Lens' IntegerDefaultValues (Maybe [Integer]) Source #

The static values of the IntegerDefaultValues.

IntegerParameter

integerParameter_name :: Lens' IntegerParameter Text Source #

The name of the integer parameter.

integerParameter_values :: Lens' IntegerParameter [Integer] Source #

The values for the integer parameter.

IntegerParameterDeclaration

integerParameterDeclaration_defaultValues :: Lens' IntegerParameterDeclaration (Maybe IntegerDefaultValues) Source #

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

integerParameterDeclaration_valueWhenUnset :: Lens' IntegerParameterDeclaration (Maybe IntegerValueWhenUnsetConfiguration) Source #

A parameter declaration for the Integer data type.

integerParameterDeclaration_parameterValueType :: Lens' IntegerParameterDeclaration ParameterValueType Source #

The value type determines whether the parameter is a single-value or multi-value parameter.

integerParameterDeclaration_name :: Lens' IntegerParameterDeclaration Text Source #

The name of the parameter that is being declared.

IntegerValueWhenUnsetConfiguration

integerValueWhenUnsetConfiguration_customValue :: Lens' IntegerValueWhenUnsetConfiguration (Maybe Integer) Source #

A custom value that's used when the value of a parameter isn't set.

integerValueWhenUnsetConfiguration_valueWhenUnsetOption :: Lens' IntegerValueWhenUnsetConfiguration (Maybe ValueWhenUnsetOption) Source #

The built-in options for default values. The value can be one of the following:

RECOMMENDED: The recommended value.
NULL: The NULL value.

ItemsLimitConfiguration

itemsLimitConfiguration_itemsLimit :: Lens' ItemsLimitConfiguration (Maybe Integer) Source #

The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.

itemsLimitConfiguration_otherCategories :: Lens' ItemsLimitConfiguration (Maybe OtherCategories) Source #

The Show other of an axis in the chart. Choose one of the following options:

```
INCLUDE
```
```
EXCLUDE
```

JiraParameters

jiraParameters_siteBaseUrl :: Lens' JiraParameters Text Source #

The base URL of the Jira site.

JoinInstruction

joinInstruction_leftJoinKeyProperties :: Lens' JoinInstruction (Maybe JoinKeyProperties) Source #

Join key properties of the left operand.

joinInstruction_rightJoinKeyProperties :: Lens' JoinInstruction (Maybe JoinKeyProperties) Source #

Join key properties of the right operand.

joinInstruction_leftOperand :: Lens' JoinInstruction Text Source #

The operand on the left side of a join.

joinInstruction_rightOperand :: Lens' JoinInstruction Text Source #

The operand on the right side of a join.

joinInstruction_type :: Lens' JoinInstruction JoinType Source #

The type of join that it is.

joinInstruction_onClause :: Lens' JoinInstruction Text Source #

The join instructions provided in the ON clause of a join.

JoinKeyProperties

joinKeyProperties_uniqueKey :: Lens' JoinKeyProperties (Maybe Bool) Source #

A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.

KPIConditionalFormatting

kPIConditionalFormatting_conditionalFormattingOptions :: Lens' KPIConditionalFormatting (Maybe [KPIConditionalFormattingOption]) Source #

The conditional formatting options of a KPI visual.

KPIConditionalFormattingOption

kPIConditionalFormattingOption_primaryValue :: Lens' KPIConditionalFormattingOption (Maybe KPIPrimaryValueConditionalFormatting) Source #

The conditional formatting for the primary value of a KPI visual.

kPIConditionalFormattingOption_progressBar :: Lens' KPIConditionalFormattingOption (Maybe KPIProgressBarConditionalFormatting) Source #

The conditional formatting for the progress bar of a KPI visual.

KPIConfiguration

kPIConfiguration_fieldWells :: Lens' KPIConfiguration (Maybe KPIFieldWells) Source #

The field well configuration of a KPI visual.

kPIConfiguration_kPIOptions :: Lens' KPIConfiguration (Maybe KPIOptions) Source #

The options that determine the presentation of a KPI visual.

kPIConfiguration_sortConfiguration :: Lens' KPIConfiguration (Maybe KPISortConfiguration) Source #

The sort configuration of a KPI visual.

KPIFieldWells

kPIFieldWells_targetValues :: Lens' KPIFieldWells (Maybe [MeasureField]) Source #

The target value field wells of a KPI visual.

kPIFieldWells_trendGroups :: Lens' KPIFieldWells (Maybe [DimensionField]) Source #

The trend group field wells of a KPI visual.

kPIFieldWells_values :: Lens' KPIFieldWells (Maybe [MeasureField]) Source #

The value field wells of a KPI visual.

KPIOptions

kPIOptions_comparison :: Lens' KPIOptions (Maybe ComparisonConfiguration) Source #

The comparison configuration of a KPI visual.

kPIOptions_primaryValueDisplayType :: Lens' KPIOptions (Maybe PrimaryValueDisplayType) Source #

The options that determine the primary value display type.

kPIOptions_primaryValueFontConfiguration :: Lens' KPIOptions (Maybe FontConfiguration) Source #

The options that determine the primary value font configuration.

kPIOptions_progressBar :: Lens' KPIOptions (Maybe ProgressBarOptions) Source #

The options that determine the presentation of the progress bar of a KPI visual.

kPIOptions_secondaryValue :: Lens' KPIOptions (Maybe SecondaryValueOptions) Source #

The options that determine the presentation of the secondary value of a KPI visual.

kPIOptions_secondaryValueFontConfiguration :: Lens' KPIOptions (Maybe FontConfiguration) Source #

The options that determine the secondary value font configuration.

kPIOptions_trendArrows :: Lens' KPIOptions (Maybe TrendArrowOptions) Source #

The options that determine the presentation of trend arrows in a KPI visual.

KPIPrimaryValueConditionalFormatting

kPIPrimaryValueConditionalFormatting_icon :: Lens' KPIPrimaryValueConditionalFormatting (Maybe ConditionalFormattingIcon) Source #

The conditional formatting of the primary value's icon.

kPIPrimaryValueConditionalFormatting_textColor :: Lens' KPIPrimaryValueConditionalFormatting (Maybe ConditionalFormattingColor) Source #

The conditional formatting of the primary value's text color.

KPIProgressBarConditionalFormatting

kPIProgressBarConditionalFormatting_foregroundColor :: Lens' KPIProgressBarConditionalFormatting (Maybe ConditionalFormattingColor) Source #

The conditional formatting of the progress bar's foreground color.

KPISortConfiguration

kPISortConfiguration_trendGroupSort :: Lens' KPISortConfiguration (Maybe [FieldSortOptions]) Source #

The sort configuration of the trend group fields.

KPIVisual

kPIVisual_actions :: Lens' KPIVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

kPIVisual_chartConfiguration :: Lens' KPIVisual (Maybe KPIConfiguration) Source #

The configuration of a KPI visual.

kPIVisual_columnHierarchies :: Lens' KPIVisual (Maybe [ColumnHierarchy]) Source #

The column hierarchy that is used during drill-downs and drill-ups.

kPIVisual_conditionalFormatting :: Lens' KPIVisual (Maybe KPIConditionalFormatting) Source #

The conditional formatting of a KPI visual.

kPIVisual_subtitle :: Lens' KPIVisual (Maybe VisualSubtitleLabelOptions) Source #

The subtitle that is displayed on the visual.

kPIVisual_title :: Lens' KPIVisual (Maybe VisualTitleLabelOptions) Source #

The title that is displayed on the visual.

kPIVisual_visualId :: Lens' KPIVisual Text Source #

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.

LabelOptions

labelOptions_customLabel :: Lens' LabelOptions (Maybe Text) Source #

The text for the label.

labelOptions_fontConfiguration :: Lens' LabelOptions (Maybe FontConfiguration) Source #

The font configuration of the label.

labelOptions_visibility :: Lens' LabelOptions (Maybe Visibility) Source #

Determines whether or not the label is visible.

Layout

layout_configuration :: Lens' Layout LayoutConfiguration Source #

The configuration that determines what the type of layout for a sheet.

LayoutConfiguration

layoutConfiguration_freeFormLayout :: Lens' LayoutConfiguration (Maybe FreeFormLayoutConfiguration) Source #

A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.

layoutConfiguration_gridLayout :: Lens' LayoutConfiguration (Maybe GridLayoutConfiguration) Source #

A type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: FIXED or RESPONSIVE.

layoutConfiguration_sectionBasedLayout :: Lens' LayoutConfiguration (Maybe SectionBasedLayoutConfiguration) Source #

A section based layout organizes visuals into multiple sections and has customized header, footer and page break.

LegendOptions

legendOptions_height :: Lens' LegendOptions (Maybe Text) Source #

The height of the legend. If this value is omitted, a default height is used when rendering.

legendOptions_position :: Lens' LegendOptions (Maybe LegendPosition) Source #

The positions for the legend. Choose one of the following options:

```
AUTO
```
```
RIGHT
```
```
BOTTOM
```
```
LEFT
```

legendOptions_title :: Lens' LegendOptions (Maybe LabelOptions) Source #

The custom title for the legend.

legendOptions_visibility :: Lens' LegendOptions (Maybe Visibility) Source #

Determines whether or not the legend is visible.

legendOptions_width :: Lens' LegendOptions (Maybe Text) Source #

The width of the legend. If this value is omitted, a default width is used when rendering.

LineChartAggregatedFieldWells

lineChartAggregatedFieldWells_category :: Lens' LineChartAggregatedFieldWells (Maybe [DimensionField]) Source #

The category field wells of a line chart. Values are grouped by category fields.

lineChartAggregatedFieldWells_colors :: Lens' LineChartAggregatedFieldWells (Maybe [DimensionField]) Source #

The color field wells of a line chart. Values are grouped by category fields.

lineChartAggregatedFieldWells_smallMultiples :: Lens' LineChartAggregatedFieldWells (Maybe [DimensionField]) Source #

The small multiples field well of a line chart.

lineChartAggregatedFieldWells_values :: Lens' LineChartAggregatedFieldWells (Maybe [MeasureField]) Source #

The value field wells of a line chart. Values are aggregated based on categories.

LineChartConfiguration

lineChartConfiguration_contributionAnalysisDefaults :: Lens' LineChartConfiguration (Maybe (NonEmpty ContributionAnalysisDefault)) Source #

The default configuration of a line chart's contribution analysis.

lineChartConfiguration_dataLabels :: Lens' LineChartConfiguration (Maybe DataLabelOptions) Source #

The data label configuration of a line chart.

lineChartConfiguration_defaultSeriesSettings :: Lens' LineChartConfiguration (Maybe LineChartDefaultSeriesSettings) Source #

The options that determine the default presentation of all line series in LineChartVisual.

lineChartConfiguration_fieldWells :: Lens' LineChartConfiguration (Maybe LineChartFieldWells) Source #

The field well configuration of a line chart.

lineChartConfiguration_forecastConfigurations :: Lens' LineChartConfiguration (Maybe [ForecastConfiguration]) Source #

The forecast configuration of a line chart.

lineChartConfiguration_legend :: Lens' LineChartConfiguration (Maybe LegendOptions) Source #

The legend configuration of a line chart.

lineChartConfiguration_primaryYAxisDisplayOptions :: Lens' LineChartConfiguration (Maybe LineSeriesAxisDisplayOptions) Source #

The series axis configuration of a line chart.

lineChartConfiguration_primaryYAxisLabelOptions :: Lens' LineChartConfiguration (Maybe ChartAxisLabelOptions) Source #

The options that determine the presentation of the y-axis label.

lineChartConfiguration_referenceLines :: Lens' LineChartConfiguration (Maybe [ReferenceLine]) Source #

The reference lines configuration of a line chart.

lineChartConfiguration_secondaryYAxisDisplayOptions :: Lens' LineChartConfiguration (Maybe LineSeriesAxisDisplayOptions) Source #

The series axis configuration of a line chart.

lineChartConfiguration_secondaryYAxisLabelOptions :: Lens' LineChartConfiguration (Maybe ChartAxisLabelOptions) Source #

The options that determine the presentation of the secondary y-axis label.

lineChartConfiguration_series :: Lens' LineChartConfiguration (Maybe [SeriesItem]) Source #

The series item configuration of a line chart.

lineChartConfiguration_smallMultiplesOptions :: Lens' LineChartConfiguration (Maybe SmallMultiplesOptions) Source #

The small multiples setup for the visual.

lineChartConfiguration_sortConfiguration :: Lens' LineChartConfiguration (Maybe LineChartSortConfiguration) Source #

The sort configuration of a line chart.

lineChartConfiguration_tooltip :: Lens' LineChartConfiguration (Maybe TooltipOptions) Source #

The tooltip configuration of a line chart.

lineChartConfiguration_type :: Lens' LineChartConfiguration (Maybe LineChartType) Source #

Determines the type of the line chart.

lineChartConfiguration_visualPalette :: Lens' LineChartConfiguration (Maybe VisualPalette) Source #

The visual palette configuration of a line chart.

lineChartConfiguration_xAxisDisplayOptions :: Lens' LineChartConfiguration (Maybe AxisDisplayOptions) Source #

The options that determine the presentation of the x-axis.

lineChartConfiguration_xAxisLabelOptions :: Lens' LineChartConfiguration (Maybe ChartAxisLabelOptions) Source #

The options that determine the presentation of the x-axis label.

LineChartDefaultSeriesSettings

lineChartDefaultSeriesSettings_axisBinding :: Lens' LineChartDefaultSeriesSettings (Maybe AxisBinding) Source #

The axis to which you are binding all line series to.

lineChartDefaultSeriesSettings_lineStyleSettings :: Lens' LineChartDefaultSeriesSettings (Maybe LineChartLineStyleSettings) Source #

Line styles options for all line series in the visual.

lineChartDefaultSeriesSettings_markerStyleSettings :: Lens' LineChartDefaultSeriesSettings (Maybe LineChartMarkerStyleSettings) Source #

Marker styles options for all line series in the visual.

LineChartFieldWells

lineChartFieldWells_lineChartAggregatedFieldWells :: Lens' LineChartFieldWells (Maybe LineChartAggregatedFieldWells) Source #

The field well configuration of a line chart.

LineChartLineStyleSettings

lineChartLineStyleSettings_lineInterpolation :: Lens' LineChartLineStyleSettings (Maybe LineInterpolation) Source #

Interpolation style for line series.

LINEAR: Show as default, linear style.
SMOOTH: Show as a smooth curve.
STEPPED: Show steps in line.

lineChartLineStyleSettings_lineStyle :: Lens' LineChartLineStyleSettings (Maybe LineChartLineStyle) Source #

Line style for line series.

SOLID: Show as a solid line.
DOTTED: Show as a dotted line.
DASHED: Show as a dashed line.

lineChartLineStyleSettings_lineVisibility :: Lens' LineChartLineStyleSettings (Maybe Visibility) Source #

Configuration option that determines whether to show the line for the series.

lineChartLineStyleSettings_lineWidth :: Lens' LineChartLineStyleSettings (Maybe Text) Source #

Width that determines the line thickness.

LineChartMarkerStyleSettings

lineChartMarkerStyleSettings_markerColor :: Lens' LineChartMarkerStyleSettings (Maybe Text) Source #

Color of marker in the series.

lineChartMarkerStyleSettings_markerShape :: Lens' LineChartMarkerStyleSettings (Maybe LineChartMarkerShape) Source #

Shape option for markers in the series.

CIRCLE: Show marker as a circle.
TRIANGLE: Show marker as a triangle.
SQUARE: Show marker as a square.
DIAMOND: Show marker as a diamond.
ROUNDED_SQUARE: Show marker as a rounded square.

lineChartMarkerStyleSettings_markerSize :: Lens' LineChartMarkerStyleSettings (Maybe Text) Source #

Size of marker in the series.

lineChartMarkerStyleSettings_markerVisibility :: Lens' LineChartMarkerStyleSettings (Maybe Visibility) Source #

Configuration option that determines whether to show the markers in the series.

LineChartSeriesSettings

lineChartSeriesSettings_lineStyleSettings :: Lens' LineChartSeriesSettings (Maybe LineChartLineStyleSettings) Source #

Line styles options for a line series in LineChartVisual.

lineChartSeriesSettings_markerStyleSettings :: Lens' LineChartSeriesSettings (Maybe LineChartMarkerStyleSettings) Source #

Marker styles options for a line series in LineChartVisual.

LineChartSortConfiguration

lineChartSortConfiguration_categoryItemsLimitConfiguration :: Lens' LineChartSortConfiguration (Maybe ItemsLimitConfiguration) Source #

The limit on the number of categories that are displayed in a line chart.

lineChartSortConfiguration_categorySort :: Lens' LineChartSortConfiguration (Maybe [FieldSortOptions]) Source #

The sort configuration of the category fields.

lineChartSortConfiguration_colorItemsLimitConfiguration :: Lens' LineChartSortConfiguration (Maybe ItemsLimitConfiguration) Source #

The limit on the number of lines that are displayed in a line chart.

lineChartSortConfiguration_smallMultiplesLimitConfiguration :: Lens' LineChartSortConfiguration (Maybe ItemsLimitConfiguration) Source #

The limit on the number of small multiples panels that are displayed.

lineChartSortConfiguration_smallMultiplesSort :: Lens' LineChartSortConfiguration (Maybe [FieldSortOptions]) Source #

The sort configuration of the small multiples field.

LineChartVisual

lineChartVisual_actions :: Lens' LineChartVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

lineChartVisual_chartConfiguration :: Lens' LineChartVisual (Maybe LineChartConfiguration) Source #

The configuration of a line chart.

lineChartVisual_columnHierarchies :: Lens' LineChartVisual (Maybe [ColumnHierarchy]) Source #

The column hierarchy that is used during drill-downs and drill-ups.

lineChartVisual_subtitle :: Lens' LineChartVisual (Maybe VisualSubtitleLabelOptions) Source #

The subtitle that is displayed on the visual.

lineChartVisual_title :: Lens' LineChartVisual (Maybe VisualTitleLabelOptions) Source #

The title that is displayed on the visual.

lineChartVisual_visualId :: Lens' LineChartVisual Text Source #

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.

LineSeriesAxisDisplayOptions

lineSeriesAxisDisplayOptions_axisOptions :: Lens' LineSeriesAxisDisplayOptions (Maybe AxisDisplayOptions) Source #

The options that determine the presentation of the line series axis.

lineSeriesAxisDisplayOptions_missingDataConfigurations :: Lens' LineSeriesAxisDisplayOptions (Maybe [MissingDataConfiguration]) Source #

The configuration options that determine how missing data is treated during the rendering of a line chart.

LinkSharingConfiguration

linkSharingConfiguration_permissions :: Lens' LinkSharingConfiguration (Maybe (NonEmpty ResourcePermission)) Source #

A structure that contains the permissions of a shareable link.

ListControlDisplayOptions

listControlDisplayOptions_searchOptions :: Lens' ListControlDisplayOptions (Maybe ListControlSearchOptions) Source #

The configuration of the search options in a list control.

listControlDisplayOptions_selectAllOptions :: Lens' ListControlDisplayOptions (Maybe ListControlSelectAllOptions) Source #

The configuration of the Select all options in a list control.

listControlDisplayOptions_titleOptions :: Lens' ListControlDisplayOptions (Maybe LabelOptions) Source #

The options to configure the title visibility, name, and font size.

ListControlSearchOptions

listControlSearchOptions_visibility :: Lens' ListControlSearchOptions (Maybe Visibility) Source #

The visibility configuration of the search options in a list control.

ListControlSelectAllOptions

listControlSelectAllOptions_visibility :: Lens' ListControlSelectAllOptions (Maybe Visibility) Source #

The visibility configuration of the Select all options in a list control.

LoadingAnimation

loadingAnimation_visibility :: Lens' LoadingAnimation (Maybe Visibility) Source #

The visibility configuration of LoadingAnimation.

LocalNavigationConfiguration

localNavigationConfiguration_targetSheetId :: Lens' LocalNavigationConfiguration Text Source #

The sheet that is targeted for navigation in the same analysis.

LogicalTable

logicalTable_dataTransforms :: Lens' LogicalTable (Maybe (NonEmpty TransformOperation)) Source #

Transform operations that act on this logical table.

logicalTable_alias :: Lens' LogicalTable Text Source #

A display name for the logical table.

logicalTable_source :: Lens' LogicalTable LogicalTableSource Source #

Source of this logical table.

LogicalTableSource

logicalTableSource_dataSetArn :: Lens' LogicalTableSource (Maybe Text) Source #

The Amazon Resource Number (ARN) of the parent dataset.

logicalTableSource_joinInstruction :: Lens' LogicalTableSource (Maybe JoinInstruction) Source #

Specifies the result of a join of two logical tables.

logicalTableSource_physicalTableId :: Lens' LogicalTableSource (Maybe Text) Source #

Physical table ID.

LongFormatText

longFormatText_plainText :: Lens' LongFormatText (Maybe Text) Source #

Plain text format.

longFormatText_richText :: Lens' LongFormatText (Maybe Text) Source #

Rich text. Examples of rich text include bold, underline, and italics.

ManifestFileLocation

manifestFileLocation_bucket :: Lens' ManifestFileLocation Text Source #

Amazon S3 bucket.

manifestFileLocation_key :: Lens' ManifestFileLocation Text Source #

Amazon S3 key that identifies an object.

MarginStyle

marginStyle_show :: Lens' MarginStyle (Maybe Bool) Source #

This Boolean value controls whether to display sheet margins.

MariaDbParameters

mariaDbParameters_host :: Lens' MariaDbParameters Text Source #

Host.

mariaDbParameters_port :: Lens' MariaDbParameters Natural Source #

Port.

mariaDbParameters_database :: Lens' MariaDbParameters Text Source #

Database.

MaximumLabelType

maximumLabelType_visibility :: Lens' MaximumLabelType (Maybe Visibility) Source #

The visibility of the maximum label.

MaximumMinimumComputation

maximumMinimumComputation_name :: Lens' MaximumMinimumComputation (Maybe Text) Source #

The name of a computation.

maximumMinimumComputation_value :: Lens' MaximumMinimumComputation (Maybe MeasureField) Source #

The value field that is used in a computation.

maximumMinimumComputation_computationId :: Lens' MaximumMinimumComputation Text Source #

The ID for a computation.

maximumMinimumComputation_time :: Lens' MaximumMinimumComputation DimensionField Source #

The time field that is used in a computation.

maximumMinimumComputation_type :: Lens' MaximumMinimumComputation MaximumMinimumComputationType Source #

The type of computation. Choose one of the following options:

MAXIMUM: A maximum computation.
MINIMUM: A minimum computation.

MeasureField

measureField_calculatedMeasureField :: Lens' MeasureField (Maybe CalculatedMeasureField) Source #

The calculated measure field only used in pivot tables.

measureField_categoricalMeasureField :: Lens' MeasureField (Maybe CategoricalMeasureField) Source #

The measure type field with categorical type columns.

measureField_dateMeasureField :: Lens' MeasureField (Maybe DateMeasureField) Source #

The measure type field with date type columns.

measureField_numericalMeasureField :: Lens' MeasureField (Maybe NumericalMeasureField) Source #

The measure type field with numerical type columns.

MemberIdArnPair

memberIdArnPair_memberArn :: Lens' MemberIdArnPair (Maybe Text) Source #

The Amazon Resource Name (ARN) of the member.

memberIdArnPair_memberId :: Lens' MemberIdArnPair (Maybe Text) Source #

The ID of the member.

MetricComparisonComputation

metricComparisonComputation_name :: Lens' MetricComparisonComputation (Maybe Text) Source #

The name of a computation.

metricComparisonComputation_computationId :: Lens' MetricComparisonComputation Text Source #

The ID for a computation.

metricComparisonComputation_time :: Lens' MetricComparisonComputation DimensionField Source #

The time field that is used in a computation.

metricComparisonComputation_fromValue :: Lens' MetricComparisonComputation MeasureField Source #

The field that is used in a metric comparison from value setup.

metricComparisonComputation_targetValue :: Lens' MetricComparisonComputation MeasureField Source #

The field that is used in a metric comparison to value setup.

MinimumLabelType

minimumLabelType_visibility :: Lens' MinimumLabelType (Maybe Visibility) Source #

The visibility of the minimum label.

MissingDataConfiguration

missingDataConfiguration_treatmentOption :: Lens' MissingDataConfiguration (Maybe MissingDataTreatmentOption) Source #

The treatment option that determines how missing data should be rendered. Choose from the following options:

INTERPOLATE: Interpolate missing values between the prior and the next known value.
SHOW_AS_ZERO: Show missing values as the value 0.
SHOW_AS_BLANK: Display a blank space when rendering missing data.

MySqlParameters

mySqlParameters_host :: Lens' MySqlParameters Text Source #

Host.

mySqlParameters_port :: Lens' MySqlParameters Natural Source #

Port.

mySqlParameters_database :: Lens' MySqlParameters Text Source #

Database.

NamespaceError

namespaceError_message :: Lens' NamespaceError (Maybe Text) Source #

The message for the error.

namespaceError_type :: Lens' NamespaceError (Maybe NamespaceErrorType) Source #

The error type.

NamespaceInfoV2

namespaceInfoV2_arn :: Lens' NamespaceInfoV2 (Maybe Text) Source #

The namespace ARN.

namespaceInfoV2_capacityRegion :: Lens' NamespaceInfoV2 (Maybe Text) Source #

The namespace Amazon Web Services Region.

namespaceInfoV2_creationStatus :: Lens' NamespaceInfoV2 (Maybe NamespaceStatus) Source #

The creation status of a namespace that is not yet completely created.

namespaceInfoV2_identityStore :: Lens' NamespaceInfoV2 (Maybe IdentityStore) Source #

The identity store used for the namespace.

namespaceInfoV2_name :: Lens' NamespaceInfoV2 (Maybe Text) Source #

The name of the error.

namespaceInfoV2_namespaceError :: Lens' NamespaceInfoV2 (Maybe NamespaceError) Source #

An error that occurred when the namespace was created.

NegativeValueConfiguration

negativeValueConfiguration_displayMode :: Lens' NegativeValueConfiguration NegativeValueDisplayMode Source #

Determines the display mode of the negative value configuration.

NullValueFormatConfiguration

nullValueFormatConfiguration_nullString :: Lens' NullValueFormatConfiguration Text Source #

Determines the null string of null values.

NumberDisplayFormatConfiguration

numberDisplayFormatConfiguration_decimalPlacesConfiguration :: Lens' NumberDisplayFormatConfiguration (Maybe DecimalPlacesConfiguration) Source #

The option that determines the decimal places configuration.

numberDisplayFormatConfiguration_negativeValueConfiguration :: Lens' NumberDisplayFormatConfiguration (Maybe NegativeValueConfiguration) Source #

The options that determine the negative value configuration.

numberDisplayFormatConfiguration_nullValueFormatConfiguration :: Lens' NumberDisplayFormatConfiguration (Maybe NullValueFormatConfiguration) Source #

The options that determine the null value format configuration.

numberDisplayFormatConfiguration_numberScale :: Lens' NumberDisplayFormatConfiguration (Maybe NumberScale) Source #

Determines the number scale value of the number format.

numberDisplayFormatConfiguration_prefix :: Lens' NumberDisplayFormatConfiguration (Maybe Text) Source #

Determines the prefix value of the number format.

numberDisplayFormatConfiguration_separatorConfiguration :: Lens' NumberDisplayFormatConfiguration (Maybe NumericSeparatorConfiguration) Source #

The options that determine the numeric separator configuration.

numberDisplayFormatConfiguration_suffix :: Lens' NumberDisplayFormatConfiguration (Maybe Text) Source #

Determines the suffix value of the number format.

NumberFormatConfiguration

numberFormatConfiguration_formatConfiguration :: Lens' NumberFormatConfiguration (Maybe NumericFormatConfiguration) Source #

The options that determine the numeric format configuration.

NumericAxisOptions

numericAxisOptions_range :: Lens' NumericAxisOptions (Maybe AxisDisplayRange) Source #

The range setup of a numeric axis.

numericAxisOptions_scale :: Lens' NumericAxisOptions (Maybe AxisScale) Source #

The scale setup of a numeric axis.

NumericEqualityDrillDownFilter

numericEqualityDrillDownFilter_column :: Lens' NumericEqualityDrillDownFilter ColumnIdentifier Source #

The column that the filter is applied to.

numericEqualityDrillDownFilter_value :: Lens' NumericEqualityDrillDownFilter Double Source #

The value of the double input numeric drill down filter.

NumericEqualityFilter

numericEqualityFilter_aggregationFunction :: Lens' NumericEqualityFilter (Maybe AggregationFunction) Source #

The aggregation function of the filter.

numericEqualityFilter_parameterName :: Lens' NumericEqualityFilter (Maybe Text) Source #

The parameter whose value should be used for the filter value.

numericEqualityFilter_selectAllOptions :: Lens' NumericEqualityFilter (Maybe NumericFilterSelectAllOptions) Source #

Select all of the values. Null is not the assigned value of select all.

```
FILTER_ALL_VALUES
```

numericEqualityFilter_value :: Lens' NumericEqualityFilter (Maybe Double) Source #

The input value.

numericEqualityFilter_filterId :: Lens' NumericEqualityFilter Text Source #

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

numericEqualityFilter_column :: Lens' NumericEqualityFilter ColumnIdentifier Source #

The column that the filter is applied to.

numericEqualityFilter_matchOperator :: Lens' NumericEqualityFilter NumericEqualityMatchOperator Source #

The match operator that is used to determine if a filter should be applied.

numericEqualityFilter_nullOption :: Lens' NumericEqualityFilter FilterNullOption Source #

This option determines how null values should be treated when filtering data.

ALL_VALUES: Include null values in filtered results.
NULLS_ONLY: Only include null values in filtered results.
NON_NULLS_ONLY: Exclude null values from filtered results.

NumericFormatConfiguration

numericFormatConfiguration_currencyDisplayFormatConfiguration :: Lens' NumericFormatConfiguration (Maybe CurrencyDisplayFormatConfiguration) Source #

The options that determine the currency display format configuration.

numericFormatConfiguration_numberDisplayFormatConfiguration :: Lens' NumericFormatConfiguration (Maybe NumberDisplayFormatConfiguration) Source #

The options that determine the number display format configuration.

numericFormatConfiguration_percentageDisplayFormatConfiguration :: Lens' NumericFormatConfiguration (Maybe PercentageDisplayFormatConfiguration) Source #

The options that determine the percentage display format configuration.

NumericRangeFilter

numericRangeFilter_aggregationFunction :: Lens' NumericRangeFilter (Maybe AggregationFunction) Source #

The aggregation function of the filter.

numericRangeFilter_includeMaximum :: Lens' NumericRangeFilter (Maybe Bool) Source #

Determines whether the maximum value in the filter value range should be included in the filtered results.

numericRangeFilter_includeMinimum :: Lens' NumericRangeFilter (Maybe Bool) Source #

Determines whether the minimum value in the filter value range should be included in the filtered results.

numericRangeFilter_rangeMaximum :: Lens' NumericRangeFilter (Maybe NumericRangeFilterValue) Source #

The maximum value for the filter value range.

numericRangeFilter_rangeMinimum :: Lens' NumericRangeFilter (Maybe NumericRangeFilterValue) Source #

The minimum value for the filter value range.

numericRangeFilter_selectAllOptions :: Lens' NumericRangeFilter (Maybe NumericFilterSelectAllOptions) Source #

Select all of the values. Null is not the assigned value of select all.

```
FILTER_ALL_VALUES
```

numericRangeFilter_filterId :: Lens' NumericRangeFilter Text Source #

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

numericRangeFilter_column :: Lens' NumericRangeFilter ColumnIdentifier Source #

The column that the filter is applied to.

numericRangeFilter_nullOption :: Lens' NumericRangeFilter FilterNullOption Source #

This option determines how null values should be treated when filtering data.

ALL_VALUES: Include null values in filtered results.
NULLS_ONLY: Only include null values in filtered results.
NON_NULLS_ONLY: Exclude null values from filtered results.

NumericRangeFilterValue

numericRangeFilterValue_parameter :: Lens' NumericRangeFilterValue (Maybe Text) Source #

The parameter that is used in the numeric range.

numericRangeFilterValue_staticValue :: Lens' NumericRangeFilterValue (Maybe Double) Source #

The static value of the numeric range filter.

NumericSeparatorConfiguration

numericSeparatorConfiguration_decimalSeparator :: Lens' NumericSeparatorConfiguration (Maybe NumericSeparatorSymbol) Source #

Determines the decimal separator.

numericSeparatorConfiguration_thousandsSeparator :: Lens' NumericSeparatorConfiguration (Maybe ThousandSeparatorOptions) Source #

The options that determine the thousands separator configuration.

NumericalAggregationFunction

numericalAggregationFunction_percentileAggregation :: Lens' NumericalAggregationFunction (Maybe PercentileAggregation) Source #

An aggregation based on the percentile of values in a dimension or measure.

numericalAggregationFunction_simpleNumericalAggregation :: Lens' NumericalAggregationFunction (Maybe SimpleNumericalAggregationFunction) Source #

Built-in aggregation functions for numerical values.

SUM: The sum of a dimension or measure.
AVERAGE: The average of a dimension or measure.
MIN: The minimum value of a dimension or measure.
MAX: The maximum value of a dimension or measure.
COUNT: The count of a dimension or measure.
DISTINCT_COUNT: The count of distinct values in a dimension or measure.
VAR: The variance of a dimension or measure.
VARP: The partitioned variance of a dimension or measure.
STDEV: The standard deviation of a dimension or measure.
STDEVP: The partitioned standard deviation of a dimension or measure.
MEDIAN: The median value of a dimension or measure.

NumericalDimensionField

numericalDimensionField_formatConfiguration :: Lens' NumericalDimensionField (Maybe NumberFormatConfiguration) Source #

The format configuration of the field.

numericalDimensionField_hierarchyId :: Lens' NumericalDimensionField (Maybe Text) Source #

The custom hierarchy ID.

numericalDimensionField_fieldId :: Lens' NumericalDimensionField Text Source #

The custom field ID.

numericalDimensionField_column :: Lens' NumericalDimensionField ColumnIdentifier Source #

The column that is used in the NumericalDimensionField.

NumericalMeasureField

numericalMeasureField_aggregationFunction :: Lens' NumericalMeasureField (Maybe NumericalAggregationFunction) Source #

The aggregation function of the measure field.

numericalMeasureField_formatConfiguration :: Lens' NumericalMeasureField (Maybe NumberFormatConfiguration) Source #

The format configuration of the field.

numericalMeasureField_fieldId :: Lens' NumericalMeasureField Text Source #

The custom field ID.

numericalMeasureField_column :: Lens' NumericalMeasureField ColumnIdentifier Source #

The column that is used in the NumericalMeasureField.

OracleParameters

oracleParameters_host :: Lens' OracleParameters Text Source #

An Oracle host.

oracleParameters_port :: Lens' OracleParameters Natural Source #

Port.

oracleParameters_database :: Lens' OracleParameters Text Source #

Database.

OutputColumn

outputColumn_description :: Lens' OutputColumn (Maybe Text) Source #

A description for a column.

outputColumn_name :: Lens' OutputColumn (Maybe Text) Source #

A display name for the dataset.

outputColumn_type :: Lens' OutputColumn (Maybe ColumnDataType) Source #

Type.

PaginationConfiguration

paginationConfiguration_pageSize :: Lens' PaginationConfiguration Integer Source #

Indicates how many items render in one page.

paginationConfiguration_pageNumber :: Lens' PaginationConfiguration Natural Source #

Indicates the page number.

PanelConfiguration

panelConfiguration_backgroundColor :: Lens' PanelConfiguration (Maybe Text) Source #

Sets the background color for each panel.

panelConfiguration_backgroundVisibility :: Lens' PanelConfiguration (Maybe Visibility) Source #

Determines whether or not a background for each small multiples panel is rendered.

panelConfiguration_borderColor :: Lens' PanelConfiguration (Maybe Text) Source #

Sets the line color of panel borders.

panelConfiguration_borderStyle :: Lens' PanelConfiguration (Maybe PanelBorderStyle) Source #

Sets the line style of panel borders.

panelConfiguration_borderThickness :: Lens' PanelConfiguration (Maybe Text) Source #

Sets the line thickness of panel borders.

panelConfiguration_borderVisibility :: Lens' PanelConfiguration (Maybe Visibility) Source #

Determines whether or not each panel displays a border.

panelConfiguration_gutterSpacing :: Lens' PanelConfiguration (Maybe Text) Source #

Sets the total amount of negative space to display between sibling panels.

panelConfiguration_gutterVisibility :: Lens' PanelConfiguration (Maybe Visibility) Source #

Determines whether or not negative space between sibling panels is rendered.

panelConfiguration_title :: Lens' PanelConfiguration (Maybe PanelTitleOptions) Source #

Configures the title display within each small multiples panel.

PanelTitleOptions

panelTitleOptions_fontConfiguration :: Lens' PanelTitleOptions (Maybe FontConfiguration) Source #

Undocumented member.

panelTitleOptions_horizontalTextAlignment :: Lens' PanelTitleOptions (Maybe HorizontalTextAlignment) Source #

Sets the horizontal text alignment of the title within each panel.

panelTitleOptions_visibility :: Lens' PanelTitleOptions (Maybe Visibility) Source #

Determines whether or not panel titles are displayed.

ParameterControl

parameterControl_dateTimePicker :: Lens' ParameterControl (Maybe ParameterDateTimePickerControl) Source #

A control from a date parameter that specifies date and time.

parameterControl_dropdown :: Lens' ParameterControl (Maybe ParameterDropDownControl) Source #

A control to display a dropdown list with buttons that are used to select a single value.

parameterControl_list :: Lens' ParameterControl (Maybe ParameterListControl) Source #

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

parameterControl_slider :: Lens' ParameterControl (Maybe ParameterSliderControl) Source #

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

parameterControl_textArea :: Lens' ParameterControl (Maybe ParameterTextAreaControl) Source #

A control to display a text box that is used to enter multiple entries.

parameterControl_textField :: Lens' ParameterControl (Maybe ParameterTextFieldControl) Source #

A control to display a text box that is used to enter a single entry.

ParameterDateTimePickerControl

parameterDateTimePickerControl_displayOptions :: Lens' ParameterDateTimePickerControl (Maybe DateTimePickerControlDisplayOptions) Source #

The display options of a control.

parameterDateTimePickerControl_parameterControlId :: Lens' ParameterDateTimePickerControl Text Source #

The ID of the ParameterDateTimePickerControl.

parameterDateTimePickerControl_title :: Lens' ParameterDateTimePickerControl Text Source #

The title of the ParameterDateTimePickerControl.

parameterDateTimePickerControl_sourceParameterName :: Lens' ParameterDateTimePickerControl Text Source #

The name of the ParameterDateTimePickerControl.

ParameterDeclaration

parameterDeclaration_dateTimeParameterDeclaration :: Lens' ParameterDeclaration (Maybe DateTimeParameterDeclaration) Source #

A parameter declaration for the DateTime data type.

parameterDeclaration_decimalParameterDeclaration :: Lens' ParameterDeclaration (Maybe DecimalParameterDeclaration) Source #

A parameter declaration for the Decimal data type.

parameterDeclaration_integerParameterDeclaration :: Lens' ParameterDeclaration (Maybe IntegerParameterDeclaration) Source #

A parameter declaration for the Integer data type.

parameterDeclaration_stringParameterDeclaration :: Lens' ParameterDeclaration (Maybe StringParameterDeclaration) Source #

A parameter declaration for the String data type.

ParameterDropDownControl

parameterDropDownControl_cascadingControlConfiguration :: Lens' ParameterDropDownControl (Maybe CascadingControlConfiguration) Source #

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

parameterDropDownControl_displayOptions :: Lens' ParameterDropDownControl (Maybe DropDownControlDisplayOptions) Source #

The display options of a control.

parameterDropDownControl_selectableValues :: Lens' ParameterDropDownControl (Maybe ParameterSelectableValues) Source #

A list of selectable values that are used in a control.

parameterDropDownControl_type :: Lens' ParameterDropDownControl (Maybe SheetControlListType) Source #

The type parameter name of the ParameterDropDownControl.

parameterDropDownControl_parameterControlId :: Lens' ParameterDropDownControl Text Source #

The ID of the ParameterDropDownControl.

parameterDropDownControl_title :: Lens' ParameterDropDownControl Text Source #

The title of the ParameterDropDownControl.

parameterDropDownControl_sourceParameterName :: Lens' ParameterDropDownControl Text Source #

The source parameter name of the ParameterDropDownControl.

ParameterListControl

parameterListControl_cascadingControlConfiguration :: Lens' ParameterListControl (Maybe CascadingControlConfiguration) Source #

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

parameterListControl_displayOptions :: Lens' ParameterListControl (Maybe ListControlDisplayOptions) Source #

The display options of a control.

parameterListControl_selectableValues :: Lens' ParameterListControl (Maybe ParameterSelectableValues) Source #

A list of selectable values that are used in a control.

parameterListControl_type :: Lens' ParameterListControl (Maybe SheetControlListType) Source #

The type of ParameterListControl.

parameterListControl_parameterControlId :: Lens' ParameterListControl Text Source #

The ID of the ParameterListControl.

parameterListControl_title :: Lens' ParameterListControl Text Source #

The title of the ParameterListControl.

parameterListControl_sourceParameterName :: Lens' ParameterListControl Text Source #

The source parameter name of the ParameterListControl.

ParameterSelectableValues

parameterSelectableValues_linkToDataSetColumn :: Lens' ParameterSelectableValues (Maybe ColumnIdentifier) Source #

The column identifier that fetches values from the data set.

parameterSelectableValues_values :: Lens' ParameterSelectableValues (Maybe [Text]) Source #

The values that are used in ParameterSelectableValues.

ParameterSliderControl

parameterSliderControl_displayOptions :: Lens' ParameterSliderControl (Maybe SliderControlDisplayOptions) Source #

The display options of a control.

parameterSliderControl_parameterControlId :: Lens' ParameterSliderControl Text Source #

The ID of the ParameterSliderControl.

parameterSliderControl_title :: Lens' ParameterSliderControl Text Source #

The title of the ParameterSliderControl.

parameterSliderControl_sourceParameterName :: Lens' ParameterSliderControl Text Source #

The source parameter name of the ParameterSliderControl.

parameterSliderControl_maximumValue :: Lens' ParameterSliderControl Double Source #

The smaller value that is displayed at the left of the slider.

parameterSliderControl_minimumValue :: Lens' ParameterSliderControl Double Source #

The larger value that is displayed at the right of the slider.

parameterSliderControl_stepSize :: Lens' ParameterSliderControl Double Source #

The number of increments that the slider bar is divided into.

ParameterTextAreaControl

parameterTextAreaControl_delimiter :: Lens' ParameterTextAreaControl (Maybe Text) Source #

The delimiter that is used to separate the lines in text.

parameterTextAreaControl_displayOptions :: Lens' ParameterTextAreaControl (Maybe TextAreaControlDisplayOptions) Source #

The display options of a control.

parameterTextAreaControl_parameterControlId :: Lens' ParameterTextAreaControl Text Source #

The ID of the ParameterTextAreaControl.

parameterTextAreaControl_title :: Lens' ParameterTextAreaControl Text Source #

The title of the ParameterTextAreaControl.

parameterTextAreaControl_sourceParameterName :: Lens' ParameterTextAreaControl Text Source #

The source parameter name of the ParameterTextAreaControl.

ParameterTextFieldControl

parameterTextFieldControl_displayOptions :: Lens' ParameterTextFieldControl (Maybe TextFieldControlDisplayOptions) Source #

The display options of a control.

parameterTextFieldControl_parameterControlId :: Lens' ParameterTextFieldControl Text Source #

The ID of the ParameterTextFieldControl.

parameterTextFieldControl_title :: Lens' ParameterTextFieldControl Text Source #

The title of the ParameterTextFieldControl.

parameterTextFieldControl_sourceParameterName :: Lens' ParameterTextFieldControl Text Source #

The source parameter name of the ParameterTextFieldControl.

Parameters

parameters_dateTimeParameters :: Lens' Parameters (Maybe [DateTimeParameter]) Source #

The parameters that have a data type of date-time.

parameters_decimalParameters :: Lens' Parameters (Maybe [DecimalParameter]) Source #

The parameters that have a data type of decimal.

parameters_integerParameters :: Lens' Parameters (Maybe [IntegerParameter]) Source #

The parameters that have a data type of integer.

parameters_stringParameters :: Lens' Parameters (Maybe [StringParameter]) Source #

The parameters that have a data type of string.

PercentVisibleRange

percentVisibleRange_from :: Lens' PercentVisibleRange (Maybe Double) Source #

The lower bound of the range.

percentVisibleRange_to :: Lens' PercentVisibleRange (Maybe Double) Source #

The top bound of the range.

PercentageDisplayFormatConfiguration

percentageDisplayFormatConfiguration_decimalPlacesConfiguration :: Lens' PercentageDisplayFormatConfiguration (Maybe DecimalPlacesConfiguration) Source #

The option that determines the decimal places configuration.

percentageDisplayFormatConfiguration_negativeValueConfiguration :: Lens' PercentageDisplayFormatConfiguration (Maybe NegativeValueConfiguration) Source #

The options that determine the negative value configuration.

percentageDisplayFormatConfiguration_nullValueFormatConfiguration :: Lens' PercentageDisplayFormatConfiguration (Maybe NullValueFormatConfiguration) Source #

The options that determine the null value format configuration.

percentageDisplayFormatConfiguration_prefix :: Lens' PercentageDisplayFormatConfiguration (Maybe Text) Source #

Determines the prefix value of the percentage format.

percentageDisplayFormatConfiguration_separatorConfiguration :: Lens' PercentageDisplayFormatConfiguration (Maybe NumericSeparatorConfiguration) Source #

The options that determine the numeric separator configuration.

percentageDisplayFormatConfiguration_suffix :: Lens' PercentageDisplayFormatConfiguration (Maybe Text) Source #

Determines the suffix value of the percentage format.

PercentileAggregation

percentileAggregation_percentileValue :: Lens' PercentileAggregation (Maybe Double) Source #

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

PeriodOverPeriodComputation

periodOverPeriodComputation_name :: Lens' PeriodOverPeriodComputation (Maybe Text) Source #

The name of a computation.

periodOverPeriodComputation_value :: Lens' PeriodOverPeriodComputation (Maybe MeasureField) Source #

The value field that is used in a computation.

periodOverPeriodComputation_computationId :: Lens' PeriodOverPeriodComputation Text Source #

The ID for a computation.

periodOverPeriodComputation_time :: Lens' PeriodOverPeriodComputation DimensionField Source #

The time field that is used in a computation.

PeriodToDateComputation

periodToDateComputation_name :: Lens' PeriodToDateComputation (Maybe Text) Source #

The name of a computation.

periodToDateComputation_periodTimeGranularity :: Lens' PeriodToDateComputation (Maybe TimeGranularity) Source #

The time granularity setup of period to date computation. Choose from the following options:

YEAR: Year to date.
MONTH: Month to date.

periodToDateComputation_value :: Lens' PeriodToDateComputation (Maybe MeasureField) Source #

The value field that is used in a computation.

periodToDateComputation_computationId :: Lens' PeriodToDateComputation Text Source #

The ID for a computation.

periodToDateComputation_time :: Lens' PeriodToDateComputation DimensionField Source #

The time field that is used in a computation.

PhysicalTable

physicalTable_customSql :: Lens' PhysicalTable (Maybe CustomSql) Source #

A physical table type built from the results of the custom SQL query.

physicalTable_relationalTable :: Lens' PhysicalTable (Maybe RelationalTable) Source #

A physical table type for relational data sources.

physicalTable_s3Source :: Lens' PhysicalTable (Maybe S3Source) Source #

A physical table type for as S3 data source.

PieChartAggregatedFieldWells

pieChartAggregatedFieldWells_category :: Lens' PieChartAggregatedFieldWells (Maybe [DimensionField]) Source #

The category (group/color) field wells of a pie chart.

pieChartAggregatedFieldWells_smallMultiples :: Lens' PieChartAggregatedFieldWells (Maybe [DimensionField]) Source #

The small multiples field well of a pie chart.

pieChartAggregatedFieldWells_values :: Lens' PieChartAggregatedFieldWells (Maybe [MeasureField]) Source #

The value field wells of a pie chart. Values are aggregated based on categories.

PieChartConfiguration

pieChartConfiguration_categoryLabelOptions :: Lens' PieChartConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options of the group/color that is displayed in a pie chart.

pieChartConfiguration_contributionAnalysisDefaults :: Lens' PieChartConfiguration (Maybe (NonEmpty ContributionAnalysisDefault)) Source #

The contribution analysis (anomaly configuration) setup of the visual.

pieChartConfiguration_dataLabels :: Lens' PieChartConfiguration (Maybe DataLabelOptions) Source #

The options that determine if visual data labels are displayed.

pieChartConfiguration_donutOptions :: Lens' PieChartConfiguration (Maybe DonutOptions) Source #

The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.

pieChartConfiguration_fieldWells :: Lens' PieChartConfiguration (Maybe PieChartFieldWells) Source #

The field wells of the visual.

pieChartConfiguration_legend :: Lens' PieChartConfiguration (Maybe LegendOptions) Source #

The legend display setup of the visual.

pieChartConfiguration_smallMultiplesOptions :: Lens' PieChartConfiguration (Maybe SmallMultiplesOptions) Source #

The small multiples setup for the visual.

pieChartConfiguration_sortConfiguration :: Lens' PieChartConfiguration (Maybe PieChartSortConfiguration) Source #

The sort configuration of a pie chart.

pieChartConfiguration_tooltip :: Lens' PieChartConfiguration (Maybe TooltipOptions) Source #

The tooltip display setup of the visual.

pieChartConfiguration_valueLabelOptions :: Lens' PieChartConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options for the value that is displayed in a pie chart.

pieChartConfiguration_visualPalette :: Lens' PieChartConfiguration (Maybe VisualPalette) Source #

The palette (chart color) display setup of the visual.

PieChartFieldWells

pieChartFieldWells_pieChartAggregatedFieldWells :: Lens' PieChartFieldWells (Maybe PieChartAggregatedFieldWells) Source #

The field well configuration of a pie chart.

PieChartSortConfiguration

pieChartSortConfiguration_categoryItemsLimit :: Lens' PieChartSortConfiguration (Maybe ItemsLimitConfiguration) Source #

The limit on the number of categories that are displayed in a pie chart.

pieChartSortConfiguration_categorySort :: Lens' PieChartSortConfiguration (Maybe [FieldSortOptions]) Source #

The sort configuration of the category fields.

pieChartSortConfiguration_smallMultiplesLimitConfiguration :: Lens' PieChartSortConfiguration (Maybe ItemsLimitConfiguration) Source #

The limit on the number of small multiples panels that are displayed.

pieChartSortConfiguration_smallMultiplesSort :: Lens' PieChartSortConfiguration (Maybe [FieldSortOptions]) Source #

The sort configuration of the small multiples field.

PieChartVisual

pieChartVisual_actions :: Lens' PieChartVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

pieChartVisual_chartConfiguration :: Lens' PieChartVisual (Maybe PieChartConfiguration) Source #

The configuration of a pie chart.

pieChartVisual_columnHierarchies :: Lens' PieChartVisual (Maybe [ColumnHierarchy]) Source #

The column hierarchy that is used during drill-downs and drill-ups.

pieChartVisual_subtitle :: Lens' PieChartVisual (Maybe VisualSubtitleLabelOptions) Source #

The subtitle that is displayed on the visual.

pieChartVisual_title :: Lens' PieChartVisual (Maybe VisualTitleLabelOptions) Source #

The title that is displayed on the visual.

pieChartVisual_visualId :: Lens' PieChartVisual Text Source #

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.

PivotFieldSortOptions

pivotFieldSortOptions_fieldId :: Lens' PivotFieldSortOptions Text Source #

The field ID for the field sort options.

pivotFieldSortOptions_sortBy :: Lens' PivotFieldSortOptions PivotTableSortBy Source #

The sort by field for the field sort options.

PivotTableAggregatedFieldWells

pivotTableAggregatedFieldWells_columns :: Lens' PivotTableAggregatedFieldWells (Maybe [DimensionField]) Source #

The columns field well for a pivot table. Values are grouped by columns fields.

pivotTableAggregatedFieldWells_rows :: Lens' PivotTableAggregatedFieldWells (Maybe [DimensionField]) Source #

The rows field well for a pivot table. Values are grouped by rows fields.

pivotTableAggregatedFieldWells_values :: Lens' PivotTableAggregatedFieldWells (Maybe [MeasureField]) Source #

The values field well for a pivot table. Values are aggregated based on rows and columns fields.

PivotTableCellConditionalFormatting

pivotTableCellConditionalFormatting_scope :: Lens' PivotTableCellConditionalFormatting (Maybe PivotTableConditionalFormattingScope) Source #

The scope of the cell for conditional formatting.

pivotTableCellConditionalFormatting_textFormat :: Lens' PivotTableCellConditionalFormatting (Maybe TextConditionalFormat) Source #

The text format of the cell for conditional formatting.

pivotTableCellConditionalFormatting_fieldId :: Lens' PivotTableCellConditionalFormatting Text Source #

The field ID of the cell for conditional formatting.

PivotTableConditionalFormatting

pivotTableConditionalFormatting_conditionalFormattingOptions :: Lens' PivotTableConditionalFormatting (Maybe [PivotTableConditionalFormattingOption]) Source #

Conditional formatting options for a PivotTableVisual.

PivotTableConditionalFormattingOption

pivotTableConditionalFormattingOption_cell :: Lens' PivotTableConditionalFormattingOption (Maybe PivotTableCellConditionalFormatting) Source #

The cell conditional formatting option for a pivot table.

PivotTableConditionalFormattingScope

pivotTableConditionalFormattingScope_role :: Lens' PivotTableConditionalFormattingScope (Maybe PivotTableConditionalFormattingScopeRole) Source #

The role (field, field total, grand total) of the cell for conditional formatting.

PivotTableConfiguration

pivotTableConfiguration_fieldOptions :: Lens' PivotTableConfiguration (Maybe PivotTableFieldOptions) Source #

The field options for a pivot table visual.

pivotTableConfiguration_fieldWells :: Lens' PivotTableConfiguration (Maybe PivotTableFieldWells) Source #

The field wells of the visual.

pivotTableConfiguration_paginatedReportOptions :: Lens' PivotTableConfiguration (Maybe PivotTablePaginatedReportOptions) Source #

The paginated report options for a pivot table visual.

pivotTableConfiguration_sortConfiguration :: Lens' PivotTableConfiguration (Maybe PivotTableSortConfiguration) Source #

The sort configuration for a PivotTableVisual.

pivotTableConfiguration_tableOptions :: Lens' PivotTableConfiguration (Maybe PivotTableOptions) Source #

The table options for a pivot table visual.

pivotTableConfiguration_totalOptions :: Lens' PivotTableConfiguration (Maybe PivotTableTotalOptions) Source #

The total options for a pivot table visual.

PivotTableDataPathOption

pivotTableDataPathOption_width :: Lens' PivotTableDataPathOption (Maybe Text) Source #

The width of the data path option.

pivotTableDataPathOption_dataPathList :: Lens' PivotTableDataPathOption [DataPathValue] Source #

The list of data path values for the data path options.

PivotTableFieldOption

pivotTableFieldOption_customLabel :: Lens' PivotTableFieldOption (Maybe Text) Source #

The custom label of the pivot table field.

pivotTableFieldOption_visibility :: Lens' PivotTableFieldOption (Maybe Visibility) Source #

The visibility of the pivot table field.

pivotTableFieldOption_fieldId :: Lens' PivotTableFieldOption Text Source #

The field ID of the pivot table field.

PivotTableFieldOptions

pivotTableFieldOptions_dataPathOptions :: Lens' PivotTableFieldOptions (Maybe [PivotTableDataPathOption]) Source #

The data path options for the pivot table field options.

pivotTableFieldOptions_selectedFieldOptions :: Lens' PivotTableFieldOptions (Maybe [PivotTableFieldOption]) Source #

The selected field options for the pivot table field options.

PivotTableFieldSubtotalOptions

pivotTableFieldSubtotalOptions_fieldId :: Lens' PivotTableFieldSubtotalOptions (Maybe Text) Source #

The field ID of the subtotal options.

PivotTableFieldWells

pivotTableFieldWells_pivotTableAggregatedFieldWells :: Lens' PivotTableFieldWells (Maybe PivotTableAggregatedFieldWells) Source #

The aggregated field well for the pivot table.

PivotTableOptions

pivotTableOptions_cellStyle :: Lens' PivotTableOptions (Maybe TableCellStyle) Source #

The table cell style of cells.

pivotTableOptions_columnHeaderStyle :: Lens' PivotTableOptions (Maybe TableCellStyle) Source #

The table cell style of the column header.

pivotTableOptions_columnNamesVisibility :: Lens' PivotTableOptions (Maybe Visibility) Source #

The visibility of the column names.

pivotTableOptions_metricPlacement :: Lens' PivotTableOptions (Maybe PivotTableMetricPlacement) Source #

The metric placement (row, column) options.

pivotTableOptions_rowAlternateColorOptions :: Lens' PivotTableOptions (Maybe RowAlternateColorOptions) Source #

The row alternate color options (widget status, row alternate colors).

pivotTableOptions_rowFieldNamesStyle :: Lens' PivotTableOptions (Maybe TableCellStyle) Source #

The table cell style of row field names.

pivotTableOptions_rowHeaderStyle :: Lens' PivotTableOptions (Maybe TableCellStyle) Source #

The table cell style of the row headers.

pivotTableOptions_singleMetricVisibility :: Lens' PivotTableOptions (Maybe Visibility) Source #

The visibility of the single metric options.

pivotTableOptions_toggleButtonsVisibility :: Lens' PivotTableOptions (Maybe Visibility) Source #

Determines the visibility of the pivot table.

PivotTablePaginatedReportOptions

pivotTablePaginatedReportOptions_overflowColumnHeaderVisibility :: Lens' PivotTablePaginatedReportOptions (Maybe Visibility) Source #

The visibility of the repeating header rows on each page.

pivotTablePaginatedReportOptions_verticalOverflowVisibility :: Lens' PivotTablePaginatedReportOptions (Maybe Visibility) Source #

The visibility of the printing table overflow across pages.

PivotTableSortBy

pivotTableSortBy_column :: Lens' PivotTableSortBy (Maybe ColumnSort) Source #

The column sort (field id, direction) for the pivot table sort by options.

pivotTableSortBy_dataPath :: Lens' PivotTableSortBy (Maybe DataPathSort) Source #

The data path sort (data path value, direction) for the pivot table sort by options.

pivotTableSortBy_field :: Lens' PivotTableSortBy (Maybe FieldSort) Source #

The field sort (field id, direction) for the pivot table sort by options.

PivotTableSortConfiguration

pivotTableSortConfiguration_fieldSortOptions :: Lens' PivotTableSortConfiguration (Maybe [PivotFieldSortOptions]) Source #

The field sort options for a pivot table sort configuration.

PivotTableTotalOptions

pivotTableTotalOptions_columnSubtotalOptions :: Lens' PivotTableTotalOptions (Maybe SubtotalOptions) Source #

The column subtotal options.

pivotTableTotalOptions_columnTotalOptions :: Lens' PivotTableTotalOptions (Maybe PivotTotalOptions) Source #

The column total options.

pivotTableTotalOptions_rowSubtotalOptions :: Lens' PivotTableTotalOptions (Maybe SubtotalOptions) Source #

The row subtotal options.

pivotTableTotalOptions_rowTotalOptions :: Lens' PivotTableTotalOptions (Maybe PivotTotalOptions) Source #

The row total options.

PivotTableVisual

pivotTableVisual_actions :: Lens' PivotTableVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

pivotTableVisual_chartConfiguration :: Lens' PivotTableVisual (Maybe PivotTableConfiguration) Source #

The configuration settings of the visual.

pivotTableVisual_conditionalFormatting :: Lens' PivotTableVisual (Maybe PivotTableConditionalFormatting) Source #

The conditional formatting for a PivotTableVisual.

pivotTableVisual_subtitle :: Lens' PivotTableVisual (Maybe VisualSubtitleLabelOptions) Source #

The subtitle that is displayed on the visual.

pivotTableVisual_title :: Lens' PivotTableVisual (Maybe VisualTitleLabelOptions) Source #

The title that is displayed on the visual.

pivotTableVisual_visualId :: Lens' PivotTableVisual Text Source #

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..

PivotTotalOptions

pivotTotalOptions_customLabel :: Lens' PivotTotalOptions (Maybe Text) Source #

The custom label string for the total cells.

pivotTotalOptions_metricHeaderCellStyle :: Lens' PivotTotalOptions (Maybe TableCellStyle) Source #

The cell styling options for the total of header cells.

pivotTotalOptions_placement :: Lens' PivotTotalOptions (Maybe TableTotalsPlacement) Source #

The placement (start, end) for the total cells.

pivotTotalOptions_scrollStatus :: Lens' PivotTotalOptions (Maybe TableTotalsScrollStatus) Source #

The scroll status (pinned, scrolled) for the total cells.

pivotTotalOptions_totalCellStyle :: Lens' PivotTotalOptions (Maybe TableCellStyle) Source #

The cell styling options for the total cells.

pivotTotalOptions_totalsVisibility :: Lens' PivotTotalOptions (Maybe Visibility) Source #

The visibility configuration for the total cells.

pivotTotalOptions_valueCellStyle :: Lens' PivotTotalOptions (Maybe TableCellStyle) Source #

The cell styling options for the totals of value cells.

PostgreSqlParameters

postgreSqlParameters_host :: Lens' PostgreSqlParameters Text Source #

Host.

postgreSqlParameters_port :: Lens' PostgreSqlParameters Natural Source #

Port.

postgreSqlParameters_database :: Lens' PostgreSqlParameters Text Source #

Database.

PredefinedHierarchy

predefinedHierarchy_drillDownFilters :: Lens' PredefinedHierarchy (Maybe [DrillDownFilter]) Source #

The option that determines the drill down filters for the predefined hierarchy.

predefinedHierarchy_hierarchyId :: Lens' PredefinedHierarchy Text Source #

The hierarchy ID of the predefined hierarchy.

predefinedHierarchy_columns :: Lens' PredefinedHierarchy (NonEmpty ColumnIdentifier) Source #

The list of columns that define the predefined hierarchy.

PrestoParameters

prestoParameters_host :: Lens' PrestoParameters Text Source #

Host.

prestoParameters_port :: Lens' PrestoParameters Natural Source #

Port.

prestoParameters_catalog :: Lens' PrestoParameters Text Source #

Catalog.

ProgressBarOptions

progressBarOptions_visibility :: Lens' ProgressBarOptions (Maybe Visibility) Source #

The visibility of the progress bar.

ProjectOperation

projectOperation_projectedColumns :: Lens' ProjectOperation (NonEmpty Text) Source #

Projected columns.

QueueInfo

queueInfo_waitingOnIngestion :: Lens' QueueInfo Text Source #

The ID of the queued ingestion.

queueInfo_queuedIngestion :: Lens' QueueInfo Text Source #

The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete.

RangeEndsLabelType

rangeEndsLabelType_visibility :: Lens' RangeEndsLabelType (Maybe Visibility) Source #

The visibility of the range ends label.

RdsParameters

rdsParameters_instanceId :: Lens' RdsParameters Text Source #

Instance ID.

rdsParameters_database :: Lens' RdsParameters Text Source #

Database.

RedshiftParameters

redshiftParameters_clusterId :: Lens' RedshiftParameters (Maybe Text) Source #

Cluster ID. This field can be blank if the Host and Port are provided.

redshiftParameters_host :: Lens' RedshiftParameters (Maybe Text) Source #

Host. This field can be blank if ClusterId is provided.

redshiftParameters_port :: Lens' RedshiftParameters (Maybe Natural) Source #

Port. This field can be blank if the ClusterId is provided.

redshiftParameters_database :: Lens' RedshiftParameters Text Source #

Database.

ReferenceLine

referenceLine_labelConfiguration :: Lens' ReferenceLine (Maybe ReferenceLineLabelConfiguration) Source #

The label configuration of the reference line.

referenceLine_status :: Lens' ReferenceLine (Maybe WidgetStatus) Source #

The status of the reference line. Choose one of the following options:

```
ENABLE
```
```
DISABLE
```

referenceLine_styleConfiguration :: Lens' ReferenceLine (Maybe ReferenceLineStyleConfiguration) Source #

The style configuration of the reference line.

referenceLine_dataConfiguration :: Lens' ReferenceLine ReferenceLineDataConfiguration Source #

The data configuration of the reference line.

ReferenceLineCustomLabelConfiguration

referenceLineCustomLabelConfiguration_customLabel :: Lens' ReferenceLineCustomLabelConfiguration Text Source #

The string text of the custom label.

ReferenceLineDataConfiguration

referenceLineDataConfiguration_axisBinding :: Lens' ReferenceLineDataConfiguration (Maybe AxisBinding) Source #

The axis binding type of the reference line. Choose one of the following options:

PrimaryY
SecondaryY

referenceLineDataConfiguration_dynamicConfiguration :: Lens' ReferenceLineDataConfiguration (Maybe ReferenceLineDynamicDataConfiguration) Source #

The dynamic configuration of the reference line data configuration.

referenceLineDataConfiguration_staticConfiguration :: Lens' ReferenceLineDataConfiguration (Maybe ReferenceLineStaticDataConfiguration) Source #

The static data configuration of the reference line data configuration.

ReferenceLineDynamicDataConfiguration

referenceLineDynamicDataConfiguration_column :: Lens' ReferenceLineDynamicDataConfiguration ColumnIdentifier Source #

The column that the dynamic data targets.

referenceLineDynamicDataConfiguration_measureAggregationFunction :: Lens' ReferenceLineDynamicDataConfiguration AggregationFunction Source #

The aggregation function that is used in the dynamic data.

referenceLineDynamicDataConfiguration_calculation :: Lens' ReferenceLineDynamicDataConfiguration NumericalAggregationFunction Source #

The calculation that is used in the dynamic data.

ReferenceLineLabelConfiguration

referenceLineLabelConfiguration_customLabelConfiguration :: Lens' ReferenceLineLabelConfiguration (Maybe ReferenceLineCustomLabelConfiguration) Source #

The custom label configuration of the label in a reference line.

referenceLineLabelConfiguration_fontColor :: Lens' ReferenceLineLabelConfiguration (Maybe Text) Source #

The font color configuration of the label in a reference line.

referenceLineLabelConfiguration_fontConfiguration :: Lens' ReferenceLineLabelConfiguration (Maybe FontConfiguration) Source #

The font configuration of the label in a reference line.

referenceLineLabelConfiguration_horizontalPosition :: Lens' ReferenceLineLabelConfiguration (Maybe ReferenceLineLabelHorizontalPosition) Source #

The horizontal position configuration of the label in a reference line. Choose one of the following options:

```
LEFT
```
```
CENTER
```
```
RIGHT
```

referenceLineLabelConfiguration_valueLabelConfiguration :: Lens' ReferenceLineLabelConfiguration (Maybe ReferenceLineValueLabelConfiguration) Source #

The value label configuration of the label in a reference line.

referenceLineLabelConfiguration_verticalPosition :: Lens' ReferenceLineLabelConfiguration (Maybe ReferenceLineLabelVerticalPosition) Source #

The vertical position configuration of the label in a reference line. Choose one of the following options:

```
ABOVE
```
```
BELOW
```

ReferenceLineStaticDataConfiguration

referenceLineStaticDataConfiguration_value :: Lens' ReferenceLineStaticDataConfiguration Double Source #

The double input of the static data.

ReferenceLineStyleConfiguration

referenceLineStyleConfiguration_color :: Lens' ReferenceLineStyleConfiguration (Maybe Text) Source #

The hex color of the reference line.

referenceLineStyleConfiguration_pattern :: Lens' ReferenceLineStyleConfiguration (Maybe ReferenceLinePatternType) Source #

The pattern type of the line style. Choose one of the following options:

```
SOLID
```
```
DASHED
```
```
DOTTED
```

ReferenceLineValueLabelConfiguration

referenceLineValueLabelConfiguration_formatConfiguration :: Lens' ReferenceLineValueLabelConfiguration (Maybe NumericFormatConfiguration) Source #

The format configuration of the value label.

referenceLineValueLabelConfiguration_relativePosition :: Lens' ReferenceLineValueLabelConfiguration (Maybe ReferenceLineValueLabelRelativePosition) Source #

The relative position of the value label. Choose one of the following options:

```
BEFORE_CUSTOM_LABEL
```
```
AFTER_CUSTOM_LABEL
```

RegisteredUserDashboardEmbeddingConfiguration

registeredUserDashboardEmbeddingConfiguration_initialDashboardId :: Lens' RegisteredUserDashboardEmbeddingConfiguration Text Source #

The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.

If the user does not have permission to view this dashboard, they see a permissions error message.

RegisteredUserDashboardVisualEmbeddingConfiguration

registeredUserDashboardVisualEmbeddingConfiguration_initialDashboardVisualId :: Lens' RegisteredUserDashboardVisualEmbeddingConfiguration DashboardVisualId Source #

The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

RegisteredUserEmbeddingExperienceConfiguration

registeredUserEmbeddingExperienceConfiguration_dashboard :: Lens' RegisteredUserEmbeddingExperienceConfiguration (Maybe RegisteredUserDashboardEmbeddingConfiguration) Source #

The configuration details for providing a dashboard embedding experience.

registeredUserEmbeddingExperienceConfiguration_dashboardVisual :: Lens' RegisteredUserEmbeddingExperienceConfiguration (Maybe RegisteredUserDashboardVisualEmbeddingConfiguration) Source #

The type of embedding experience. In this case, Amazon QuickSight visuals.

registeredUserEmbeddingExperienceConfiguration_qSearchBar :: Lens' RegisteredUserEmbeddingExperienceConfiguration (Maybe RegisteredUserQSearchBarEmbeddingConfiguration) Source #

The configuration details for embedding the Q search bar.

For more information about embedding the Q search bar, see Embedding Overview in the Amazon QuickSight User Guide.

registeredUserEmbeddingExperienceConfiguration_quickSightConsole :: Lens' RegisteredUserEmbeddingExperienceConfiguration (Maybe RegisteredUserQuickSightConsoleEmbeddingConfiguration) Source #

The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User Guide.

Use GenerateEmbedUrlForRegisteredUser where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console needs to belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use the RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

RegisteredUserQSearchBarEmbeddingConfiguration

registeredUserQSearchBarEmbeddingConfiguration_initialTopicId :: Lens' RegisteredUserQSearchBarEmbeddingConfiguration (Maybe Text) Source #

The ID of the Q topic that you want to make the starting topic in the Q search bar. You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening a topic. The ID is in the URL for the topic that you open.

If you don't specify an initial topic, a list of all shared topics is shown in the Q bar for your readers. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the available ones in the list.

RegisteredUserQuickSightConsoleEmbeddingConfiguration

registeredUserQuickSightConsoleEmbeddingConfiguration_initialPath :: Lens' RegisteredUserQuickSightConsoleEmbeddingConfiguration (Maybe Text) Source #

The initial URL path for the Amazon QuickSight console. InitialPath is required.

The entry point URL is constrained to the following paths:

```
/start
```
```
/start/analyses
```
```
/start/dashboards
```
```
/start/favorites
```
/dashboards/DashboardId. DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard.
/analyses/AnalysisId. AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis.

RelationalTable

relationalTable_catalog :: Lens' RelationalTable (Maybe Text) Source #

The catalog associated with a table.

relationalTable_schema :: Lens' RelationalTable (Maybe Text) Source #

The schema name. This name applies to certain relational database engines.

relationalTable_dataSourceArn :: Lens' RelationalTable Text Source #

The Amazon Resource Name (ARN) for the data source.

relationalTable_name :: Lens' RelationalTable Text Source #

The name of the relational table.

relationalTable_inputColumns :: Lens' RelationalTable (NonEmpty InputColumn) Source #

The column schema of the table.

RelativeDateTimeControlDisplayOptions

relativeDateTimeControlDisplayOptions_dateTimeFormat :: Lens' RelativeDateTimeControlDisplayOptions (Maybe Text) Source #

Customize how dates are formatted in controls.

relativeDateTimeControlDisplayOptions_titleOptions :: Lens' RelativeDateTimeControlDisplayOptions (Maybe LabelOptions) Source #

The options to configure the title visibility, name, and font size.

RelativeDatesFilter

relativeDatesFilter_excludePeriodConfiguration :: Lens' RelativeDatesFilter (Maybe ExcludePeriodConfiguration) Source #

The configuration for the exclude period of the filter.

relativeDatesFilter_minimumGranularity :: Lens' RelativeDatesFilter (Maybe TimeGranularity) Source #

The minimum granularity (period granularity) of the relative dates filter.

relativeDatesFilter_parameterName :: Lens' RelativeDatesFilter (Maybe Text) Source #

The parameter whose value should be used for the filter value.

relativeDatesFilter_relativeDateValue :: Lens' RelativeDatesFilter (Maybe Int) Source #

The date value of the filter.

relativeDatesFilter_filterId :: Lens' RelativeDatesFilter Text Source #

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

relativeDatesFilter_column :: Lens' RelativeDatesFilter ColumnIdentifier Source #

The column that the filter is applied to.

relativeDatesFilter_anchorDateConfiguration :: Lens' RelativeDatesFilter AnchorDateConfiguration Source #

The date configuration of the filter.

relativeDatesFilter_timeGranularity :: Lens' RelativeDatesFilter TimeGranularity Source #

The level of time precision that is used to aggregate DateTime values.

relativeDatesFilter_relativeDateType :: Lens' RelativeDatesFilter RelativeDateType Source #

The range date type of the filter. Choose one of the options below:

```
PREVIOUS
```
```
THIS
```
```
LAST
```
```
NOW
```
```
NEXT
```

relativeDatesFilter_nullOption :: Lens' RelativeDatesFilter FilterNullOption Source #

This option determines how null values should be treated when filtering data.

ALL_VALUES: Include null values in filtered results.
NULLS_ONLY: Only include null values in filtered results.
NON_NULLS_ONLY: Exclude null values from filtered results.

RenameColumnOperation

renameColumnOperation_columnName :: Lens' RenameColumnOperation Text Source #

The name of the column to be renamed.

renameColumnOperation_newColumnName :: Lens' RenameColumnOperation Text Source #

The new name for the column.

ResourcePermission

resourcePermission_principal :: Lens' ResourcePermission Text Source #

The Amazon Resource Name (ARN) of the principal. This can be one of the following:

The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)

resourcePermission_actions :: Lens' ResourcePermission (NonEmpty Text) Source #

The IAM action to grant or revoke permissions on.

RollingDateConfiguration

rollingDateConfiguration_dataSetIdentifier :: Lens' RollingDateConfiguration (Maybe Text) Source #

The data set that is used in the rolling date configuration.

rollingDateConfiguration_expression :: Lens' RollingDateConfiguration Text Source #

The expression of the rolling date configuration.

RowAlternateColorOptions

rowAlternateColorOptions_rowAlternateColors :: Lens' RowAlternateColorOptions (Maybe [Text]) Source #

Determines the list of row alternate colors.

rowAlternateColorOptions_status :: Lens' RowAlternateColorOptions (Maybe WidgetStatus) Source #

Determines the widget status.

RowInfo

rowInfo_rowsDropped :: Lens' RowInfo (Maybe Integer) Source #

The number of rows that were not ingested.

rowInfo_rowsIngested :: Lens' RowInfo (Maybe Integer) Source #

The number of rows that were ingested.

rowInfo_totalRowsInDataset :: Lens' RowInfo (Maybe Integer) Source #

The total number of rows in the dataset.

RowLevelPermissionDataSet

rowLevelPermissionDataSet_formatVersion :: Lens' RowLevelPermissionDataSet (Maybe RowLevelPermissionFormatVersion) Source #

The user or group rules associated with the dataset that contains permissions for RLS.

By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.

rowLevelPermissionDataSet_namespace :: Lens' RowLevelPermissionDataSet (Maybe Text) Source #

The namespace associated with the dataset that contains permissions for RLS.

rowLevelPermissionDataSet_status :: Lens' RowLevelPermissionDataSet (Maybe Status) Source #

The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

rowLevelPermissionDataSet_arn :: Lens' RowLevelPermissionDataSet Text Source #

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

rowLevelPermissionDataSet_permissionPolicy :: Lens' RowLevelPermissionDataSet RowLevelPermissionPolicy Source #

The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.

RowLevelPermissionTagConfiguration

rowLevelPermissionTagConfiguration_status :: Lens' RowLevelPermissionTagConfiguration (Maybe Status) Source #

The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

rowLevelPermissionTagConfiguration_tagRules :: Lens' RowLevelPermissionTagConfiguration (NonEmpty RowLevelPermissionTagRule) Source #

A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

RowLevelPermissionTagRule

rowLevelPermissionTagRule_matchAllValue :: Lens' RowLevelPermissionTagRule (Maybe Text) Source #

A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.

rowLevelPermissionTagRule_tagMultiValueDelimiter :: Lens' RowLevelPermissionTagRule (Maybe Text) Source #

A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.

rowLevelPermissionTagRule_tagKey :: Lens' RowLevelPermissionTagRule Text Source #

The unique key for a tag.

rowLevelPermissionTagRule_columnName :: Lens' RowLevelPermissionTagRule Text Source #

The column name that a tag key is assigned to.

S3Parameters

s3Parameters_manifestFileLocation :: Lens' S3Parameters ManifestFileLocation Source #

Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.

S3Source

s3Source_uploadSettings :: Lens' S3Source (Maybe UploadSettings) Source #

Information about the format for the S3 source file or files.

s3Source_dataSourceArn :: Lens' S3Source Text Source #

The Amazon Resource Name (ARN) for the data source.

s3Source_inputColumns :: Lens' S3Source (NonEmpty InputColumn) Source #

A physical table type for an S3 data source.

For files that aren't JSON, only STRING data types are supported in input columns.

SameSheetTargetVisualConfiguration

sameSheetTargetVisualConfiguration_targetVisualOptions :: Lens' SameSheetTargetVisualConfiguration (Maybe TargetVisualOptions) Source #

The options that choose the target visual in the same sheet.

Valid values are defined as follows:

ALL_VISUALS: Applies the filter operation to all visuals in the same sheet.

sameSheetTargetVisualConfiguration_targetVisuals :: Lens' SameSheetTargetVisualConfiguration (Maybe (NonEmpty Text)) Source #

A list of the target visual IDs that are located in the same sheet of the analysis.

SankeyDiagramAggregatedFieldWells

sankeyDiagramAggregatedFieldWells_destination :: Lens' SankeyDiagramAggregatedFieldWells (Maybe [DimensionField]) Source #

The destination field wells of a sankey diagram.

sankeyDiagramAggregatedFieldWells_source :: Lens' SankeyDiagramAggregatedFieldWells (Maybe [DimensionField]) Source #

The source field wells of a sankey diagram.

sankeyDiagramAggregatedFieldWells_weight :: Lens' SankeyDiagramAggregatedFieldWells (Maybe [MeasureField]) Source #

The weight field wells of a sankey diagram.

SankeyDiagramChartConfiguration

sankeyDiagramChartConfiguration_dataLabels :: Lens' SankeyDiagramChartConfiguration (Maybe DataLabelOptions) Source #

The data label configuration of a sankey diagram.

sankeyDiagramChartConfiguration_fieldWells :: Lens' SankeyDiagramChartConfiguration (Maybe SankeyDiagramFieldWells) Source #

The field well configuration of a sankey diagram.

sankeyDiagramChartConfiguration_sortConfiguration :: Lens' SankeyDiagramChartConfiguration (Maybe SankeyDiagramSortConfiguration) Source #

The sort configuration of a sankey diagram.

SankeyDiagramFieldWells

sankeyDiagramFieldWells_sankeyDiagramAggregatedFieldWells :: Lens' SankeyDiagramFieldWells (Maybe SankeyDiagramAggregatedFieldWells) Source #

The field well configuration of a sankey diagram.

SankeyDiagramSortConfiguration

sankeyDiagramSortConfiguration_destinationItemsLimit :: Lens' SankeyDiagramSortConfiguration (Maybe ItemsLimitConfiguration) Source #

The limit on the number of destination nodes that are displayed in a sankey diagram.

sankeyDiagramSortConfiguration_sourceItemsLimit :: Lens' SankeyDiagramSortConfiguration (Maybe ItemsLimitConfiguration) Source #

The limit on the number of source nodes that are displayed in a sankey diagram.

sankeyDiagramSortConfiguration_weightSort :: Lens' SankeyDiagramSortConfiguration (Maybe [FieldSortOptions]) Source #

The sort configuration of the weight fields.

SankeyDiagramVisual

sankeyDiagramVisual_actions :: Lens' SankeyDiagramVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

sankeyDiagramVisual_chartConfiguration :: Lens' SankeyDiagramVisual (Maybe SankeyDiagramChartConfiguration) Source #

The configuration of a sankey diagram.

sankeyDiagramVisual_subtitle :: Lens' SankeyDiagramVisual (Maybe VisualSubtitleLabelOptions) Source #

The subtitle that is displayed on the visual.

sankeyDiagramVisual_title :: Lens' SankeyDiagramVisual (Maybe VisualTitleLabelOptions) Source #

The title that is displayed on the visual.

sankeyDiagramVisual_visualId :: Lens' SankeyDiagramVisual Text Source #

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.

ScatterPlotCategoricallyAggregatedFieldWells

scatterPlotCategoricallyAggregatedFieldWells_category :: Lens' ScatterPlotCategoricallyAggregatedFieldWells (Maybe [DimensionField]) Source #

The category field well of a scatter plot.

scatterPlotCategoricallyAggregatedFieldWells_size :: Lens' ScatterPlotCategoricallyAggregatedFieldWells (Maybe [MeasureField]) Source #

The size field well of a scatter plot.

scatterPlotCategoricallyAggregatedFieldWells_xAxis :: Lens' ScatterPlotCategoricallyAggregatedFieldWells (Maybe [MeasureField]) Source #

The x-axis field well of a scatter plot.

The x-axis is aggregated by category.

scatterPlotCategoricallyAggregatedFieldWells_yAxis :: Lens' ScatterPlotCategoricallyAggregatedFieldWells (Maybe [MeasureField]) Source #

The y-axis field well of a scatter plot.

The y-axis is aggregated by category.

ScatterPlotConfiguration

scatterPlotConfiguration_dataLabels :: Lens' ScatterPlotConfiguration (Maybe DataLabelOptions) Source #

The options that determine if visual data labels are displayed.

scatterPlotConfiguration_fieldWells :: Lens' ScatterPlotConfiguration (Maybe ScatterPlotFieldWells) Source #

The field wells of the visual.

scatterPlotConfiguration_legend :: Lens' ScatterPlotConfiguration (Maybe LegendOptions) Source #

The legend display setup of the visual.

scatterPlotConfiguration_tooltip :: Lens' ScatterPlotConfiguration (Maybe TooltipOptions) Source #

The legend display setup of the visual.

scatterPlotConfiguration_visualPalette :: Lens' ScatterPlotConfiguration (Maybe VisualPalette) Source #

The palette (chart color) display setup of the visual.

scatterPlotConfiguration_xAxisDisplayOptions :: Lens' ScatterPlotConfiguration (Maybe AxisDisplayOptions) Source #

The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.

scatterPlotConfiguration_xAxisLabelOptions :: Lens' ScatterPlotConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.

scatterPlotConfiguration_yAxisDisplayOptions :: Lens' ScatterPlotConfiguration (Maybe AxisDisplayOptions) Source #

The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.

scatterPlotConfiguration_yAxisLabelOptions :: Lens' ScatterPlotConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.

ScatterPlotFieldWells

scatterPlotFieldWells_scatterPlotCategoricallyAggregatedFieldWells :: Lens' ScatterPlotFieldWells (Maybe ScatterPlotCategoricallyAggregatedFieldWells) Source #

The aggregated field wells of a scatter plot. Scatter plots that have a field in the category (group/color) field will have aggregated field wells. The x and y-axes of these scatter plots are aggregated by category.

scatterPlotFieldWells_scatterPlotUnaggregatedFieldWells :: Lens' ScatterPlotFieldWells (Maybe ScatterPlotUnaggregatedFieldWells) Source #

The unaggregated field wells of a scatter plot. Scatter plots without a category field well have unaggregated field wells. The x and y-axes of these scatter plots are unaggregated.

ScatterPlotUnaggregatedFieldWells

scatterPlotUnaggregatedFieldWells_size :: Lens' ScatterPlotUnaggregatedFieldWells (Maybe [MeasureField]) Source #

The size field well of a scatter plot.

scatterPlotUnaggregatedFieldWells_xAxis :: Lens' ScatterPlotUnaggregatedFieldWells (Maybe [DimensionField]) Source #

The x-axis field well of a scatter plot.

The x-axis is a dimension field and cannot be aggregated.

scatterPlotUnaggregatedFieldWells_yAxis :: Lens' ScatterPlotUnaggregatedFieldWells (Maybe [DimensionField]) Source #

The y-axis field well of a scatter plot.

The y-axis is a dimension field and cannot be aggregated.

ScatterPlotVisual

scatterPlotVisual_actions :: Lens' ScatterPlotVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

scatterPlotVisual_chartConfiguration :: Lens' ScatterPlotVisual (Maybe ScatterPlotConfiguration) Source #

The configuration settings of the visual.

scatterPlotVisual_columnHierarchies :: Lens' ScatterPlotVisual (Maybe [ColumnHierarchy]) Source #

The column hierarchy that is used during drill-downs and drill-ups.

scatterPlotVisual_subtitle :: Lens' ScatterPlotVisual (Maybe VisualSubtitleLabelOptions) Source #

The subtitle that is displayed on the visual.

scatterPlotVisual_title :: Lens' ScatterPlotVisual (Maybe VisualTitleLabelOptions) Source #

The title that is displayed on the visual.

scatterPlotVisual_visualId :: Lens' ScatterPlotVisual Text Source #

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.

ScrollBarOptions

scrollBarOptions_visibility :: Lens' ScrollBarOptions (Maybe Visibility) Source #

The visibility of the data zoom scroll bar.

scrollBarOptions_visibleRange :: Lens' ScrollBarOptions (Maybe VisibleRangeOptions) Source #

The visibility range for the data zoom scroll bar.

SecondaryValueOptions

secondaryValueOptions_visibility :: Lens' SecondaryValueOptions (Maybe Visibility) Source #

Determines the visibility of the secondary value.

SectionAfterPageBreak

sectionAfterPageBreak_status :: Lens' SectionAfterPageBreak (Maybe SectionPageBreakStatus) Source #

The option that enables or disables a page break at the end of a section.

SectionBasedLayoutCanvasSizeOptions

sectionBasedLayoutCanvasSizeOptions_paperCanvasSizeOptions :: Lens' SectionBasedLayoutCanvasSizeOptions (Maybe SectionBasedLayoutPaperCanvasSizeOptions) Source #

The options for a paper canvas of a section-based layout.

SectionBasedLayoutConfiguration

sectionBasedLayoutConfiguration_headerSections :: Lens' SectionBasedLayoutConfiguration [HeaderFooterSectionConfiguration] Source #

A list of header section configurations.

sectionBasedLayoutConfiguration_bodySections :: Lens' SectionBasedLayoutConfiguration [BodySectionConfiguration] Source #

A list of body section configurations.

sectionBasedLayoutConfiguration_footerSections :: Lens' SectionBasedLayoutConfiguration [HeaderFooterSectionConfiguration] Source #

A list of footer section configurations.

sectionBasedLayoutConfiguration_canvasSizeOptions :: Lens' SectionBasedLayoutConfiguration SectionBasedLayoutCanvasSizeOptions Source #

The options for the canvas of a section-based layout.

SectionBasedLayoutPaperCanvasSizeOptions

sectionBasedLayoutPaperCanvasSizeOptions_paperMargin :: Lens' SectionBasedLayoutPaperCanvasSizeOptions (Maybe Spacing) Source #

Defines the spacing between the canvas content and the top, bottom, left, and right edges.

sectionBasedLayoutPaperCanvasSizeOptions_paperOrientation :: Lens' SectionBasedLayoutPaperCanvasSizeOptions (Maybe PaperOrientation) Source #

The paper orientation that is used to define canvas dimensions. Choose one of the following options:

PORTRAIT
LANDSCAPE

sectionBasedLayoutPaperCanvasSizeOptions_paperSize :: Lens' SectionBasedLayoutPaperCanvasSizeOptions (Maybe PaperSize) Source #

The paper size that is used to define canvas dimensions.

SectionLayoutConfiguration

sectionLayoutConfiguration_freeFormLayout :: Lens' SectionLayoutConfiguration FreeFormSectionLayoutConfiguration Source #

The free-form layout configuration of a section.

SectionPageBreakConfiguration

sectionPageBreakConfiguration_after :: Lens' SectionPageBreakConfiguration (Maybe SectionAfterPageBreak) Source #

The configuration of a page break after a section.

SectionStyle

sectionStyle_height :: Lens' SectionStyle (Maybe Text) Source #

The height of a section.

Heights can only be defined for header and footer sections. The default height margin is 0.5 inches.

sectionStyle_padding :: Lens' SectionStyle (Maybe Spacing) Source #

The spacing between section content and its top, bottom, left, and right edges.

There is no padding by default.

SelectedSheetsFilterScopeConfiguration

selectedSheetsFilterScopeConfiguration_sheetVisualScopingConfigurations :: Lens' SelectedSheetsFilterScopeConfiguration (Maybe (NonEmpty SheetVisualScopingConfiguration)) Source #

The sheet ID and visual IDs of the sheet and visuals that the filter is applied to.

SeriesItem

seriesItem_dataFieldSeriesItem :: Lens' SeriesItem (Maybe DataFieldSeriesItem) Source #

The data field series item configuration of a line chart.

seriesItem_fieldSeriesItem :: Lens' SeriesItem (Maybe FieldSeriesItem) Source #

The field series item configuration of a line chart.

ServiceNowParameters

serviceNowParameters_siteBaseUrl :: Lens' ServiceNowParameters Text Source #

URL of the base site.

SessionTag

sessionTag_key :: Lens' SessionTag Text Source #

The key for the tag.

sessionTag_value :: Lens' SessionTag Text Source #

The value that you want to assign the tag.

SetParameterValueConfiguration

setParameterValueConfiguration_destinationParameterName :: Lens' SetParameterValueConfiguration Text Source #

The destination parameter name of the SetParameterValueConfiguration.

setParameterValueConfiguration_value :: Lens' SetParameterValueConfiguration DestinationParameterValueConfiguration Source #

Undocumented member.

ShapeConditionalFormat

shapeConditionalFormat_backgroundColor :: Lens' ShapeConditionalFormat ConditionalFormattingColor Source #

The conditional formatting for the shape background color of a filled map visual.

Sheet

sheet_name :: Lens' Sheet (Maybe Text) Source #

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.

sheet_sheetId :: Lens' Sheet (Maybe Text) Source #

The unique identifier associated with a sheet.

SheetControlLayout

sheetControlLayout_configuration :: Lens' SheetControlLayout SheetControlLayoutConfiguration Source #

The configuration that determines the elements and canvas size options of sheet control.

SheetControlLayoutConfiguration

sheetControlLayoutConfiguration_gridLayout :: Lens' SheetControlLayoutConfiguration (Maybe GridLayoutConfiguration) Source #

The configuration that determines the elements and canvas size options of sheet control.

SheetControlsOption

sheetControlsOption_visibilityState :: Lens' SheetControlsOption (Maybe DashboardUIState) Source #

Visibility state.

SheetDefinition

sheetDefinition_contentType :: Lens' SheetDefinition (Maybe SheetContentType) Source #

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.

sheetDefinition_description :: Lens' SheetDefinition (Maybe Text) Source #

A description of the sheet.

sheetDefinition_filterControls :: Lens' SheetDefinition (Maybe [FilterControl]) Source #

The list of filter controls that are on a sheet.

For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide.

sheetDefinition_layouts :: Lens' SheetDefinition (Maybe (NonEmpty Layout)) Source #

Layouts define how the components of a sheet are arranged.

For more information, see Types of layout in the Amazon QuickSight User Guide.

sheetDefinition_name :: Lens' SheetDefinition (Maybe Text) Source #

The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.

sheetDefinition_parameterControls :: Lens' SheetDefinition (Maybe [ParameterControl]) Source #

The list of parameter controls that are on a sheet.

For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.

sheetDefinition_sheetControlLayouts :: Lens' SheetDefinition (Maybe [SheetControlLayout]) Source #

The control layouts of the sheet.

sheetDefinition_textBoxes :: Lens' SheetDefinition (Maybe [SheetTextBox]) Source #

The text boxes that are on a sheet.

sheetDefinition_title :: Lens' SheetDefinition (Maybe Text) Source #

The title of the sheet.

sheetDefinition_visuals :: Lens' SheetDefinition (Maybe [Visual]) Source #

A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

sheetDefinition_sheetId :: Lens' SheetDefinition Text Source #

The unique identifier of a sheet.

SheetElementConfigurationOverrides

sheetElementConfigurationOverrides_visibility :: Lens' SheetElementConfigurationOverrides (Maybe Visibility) Source #

Determines whether or not the overrides are visible. Choose one of the following options:

```
VISIBLE
```
```
HIDDEN
```

SheetElementRenderingRule

sheetElementRenderingRule_expression :: Lens' SheetElementRenderingRule Text Source #

The expression of the rendering rules of a sheet.

sheetElementRenderingRule_configurationOverrides :: Lens' SheetElementRenderingRule SheetElementConfigurationOverrides Source #

The override configuration of the rendering rules of a sheet.

SheetStyle

sheetStyle_tile :: Lens' SheetStyle (Maybe TileStyle) Source #

The display options for tiles.

sheetStyle_tileLayout :: Lens' SheetStyle (Maybe TileLayoutStyle) Source #

The layout options for tiles.

SheetTextBox

sheetTextBox_content :: Lens' SheetTextBox (Maybe Text) Source #

The content that is displayed in the text box.

sheetTextBox_sheetTextBoxId :: Lens' SheetTextBox Text Source #

The unique identifier for a text box. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have text boxes that share identifiers.

SheetVisualScopingConfiguration

sheetVisualScopingConfiguration_visualIds :: Lens' SheetVisualScopingConfiguration (Maybe [Text]) Source #

The selected visuals that the filter is applied to.

sheetVisualScopingConfiguration_sheetId :: Lens' SheetVisualScopingConfiguration Text Source #

The selected sheet that the filter is applied to.

sheetVisualScopingConfiguration_scope :: Lens' SheetVisualScopingConfiguration FilterVisualScope Source #

The scope of the applied entities. Choose one of the following options:

```
ALL_VISUALS
```
```
SELECTED_VISUALS
```

ShortFormatText

shortFormatText_plainText :: Lens' ShortFormatText (Maybe Text) Source #

Plain text format.

shortFormatText_richText :: Lens' ShortFormatText (Maybe Text) Source #

Rich text. Examples of rich text include bold, underline, and italics.

SignupResponse

signupResponse_iAMUser :: Lens' SignupResponse (Maybe Bool) Source #

A Boolean that is TRUE if the Amazon QuickSight uses IAM as an authentication method.

signupResponse_accountName :: Lens' SignupResponse (Maybe Text) Source #

The name of your Amazon QuickSight account.

signupResponse_directoryType :: Lens' SignupResponse (Maybe Text) Source #

The type of Active Directory that is being used to authenticate the Amazon QuickSight account. Valid values are SIMPLE_AD, AD_CONNECTOR, and MICROSOFT_AD.

signupResponse_userLoginName :: Lens' SignupResponse (Maybe Text) Source #

The user login name for your Amazon QuickSight account.

SimpleClusterMarker

simpleClusterMarker_color :: Lens' SimpleClusterMarker (Maybe Text) Source #

The color of the simple cluster marker.

SliderControlDisplayOptions

sliderControlDisplayOptions_titleOptions :: Lens' SliderControlDisplayOptions (Maybe LabelOptions) Source #

The options to configure the title visibility, name, and font size.

SmallMultiplesOptions

smallMultiplesOptions_maxVisibleColumns :: Lens' SmallMultiplesOptions (Maybe Natural) Source #

Sets the maximum number of visible columns to display in the grid of small multiples panels.

The default is Auto, which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.

smallMultiplesOptions_maxVisibleRows :: Lens' SmallMultiplesOptions (Maybe Natural) Source #

Sets the maximum number of visible rows to display in the grid of small multiples panels.

The default value is Auto, which automatically adjusts the rows in the grid to fit the overall layout and size of the given chart.

smallMultiplesOptions_panelConfiguration :: Lens' SmallMultiplesOptions (Maybe PanelConfiguration) Source #

Configures the display options for each small multiples panel.

SnowflakeParameters

snowflakeParameters_host :: Lens' SnowflakeParameters Text Source #

Host.

snowflakeParameters_database :: Lens' SnowflakeParameters Text Source #

Database.

snowflakeParameters_warehouse :: Lens' SnowflakeParameters Text Source #

Warehouse.

Spacing

spacing_bottom :: Lens' Spacing (Maybe Text) Source #

Define the bottom spacing.

spacing_left :: Lens' Spacing (Maybe Text) Source #

Define the left spacing.

spacing_right :: Lens' Spacing (Maybe Text) Source #

Define the right spacing.

spacing_top :: Lens' Spacing (Maybe Text) Source #

Define the top spacing.

SparkParameters

sparkParameters_host :: Lens' SparkParameters Text Source #

Host.

sparkParameters_port :: Lens' SparkParameters Natural Source #

Port.

SqlServerParameters

sqlServerParameters_host :: Lens' SqlServerParameters Text Source #

Host.

sqlServerParameters_port :: Lens' SqlServerParameters Natural Source #

Port.

sqlServerParameters_database :: Lens' SqlServerParameters Text Source #

Database.

SslProperties

sslProperties_disableSsl :: Lens' SslProperties (Maybe Bool) Source #

A Boolean option to control whether SSL should be disabled.

StringDefaultValues

stringDefaultValues_dynamicValue :: Lens' StringDefaultValues (Maybe DynamicDefaultValue) Source #

The dynamic value of the StringDefaultValues. Different defaults displayed according to users, groups, and values mapping.

stringDefaultValues_staticValues :: Lens' StringDefaultValues (Maybe [Text]) Source #

The static values of the DecimalDefaultValues.

StringFormatConfiguration

stringFormatConfiguration_nullValueFormatConfiguration :: Lens' StringFormatConfiguration (Maybe NullValueFormatConfiguration) Source #

The options that determine the null value format configuration.

stringFormatConfiguration_numericFormatConfiguration :: Lens' StringFormatConfiguration (Maybe NumericFormatConfiguration) Source #

The formatting configuration for numeric strings.

StringParameter

stringParameter_name :: Lens' StringParameter Text Source #

A display name for a string parameter.

stringParameter_values :: Lens' StringParameter [Text] Source #

The values of a string parameter.

StringParameterDeclaration

stringParameterDeclaration_defaultValues :: Lens' StringParameterDeclaration (Maybe StringDefaultValues) Source #

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

stringParameterDeclaration_valueWhenUnset :: Lens' StringParameterDeclaration (Maybe StringValueWhenUnsetConfiguration) Source #

The configuration that defines the default value of a String parameter when a value has not been set.

stringParameterDeclaration_parameterValueType :: Lens' StringParameterDeclaration ParameterValueType Source #

The value type determines whether the parameter is a single-value or multi-value parameter.

stringParameterDeclaration_name :: Lens' StringParameterDeclaration Text Source #

The name of the parameter that is being declared.

StringValueWhenUnsetConfiguration

stringValueWhenUnsetConfiguration_customValue :: Lens' StringValueWhenUnsetConfiguration (Maybe Text) Source #

A custom value that's used when the value of a parameter isn't set.

stringValueWhenUnsetConfiguration_valueWhenUnsetOption :: Lens' StringValueWhenUnsetConfiguration (Maybe ValueWhenUnsetOption) Source #

The built-in options for default values. The value can be one of the following:

RECOMMENDED: The recommended value.
NULL: The NULL value.

SubtotalOptions

subtotalOptions_customLabel :: Lens' SubtotalOptions (Maybe Text) Source #

The custom label string for the subtotal cells.

subtotalOptions_fieldLevel :: Lens' SubtotalOptions (Maybe PivotTableSubtotalLevel) Source #

The field level (all, custom, last) for the subtotal cells.

subtotalOptions_fieldLevelOptions :: Lens' SubtotalOptions (Maybe [PivotTableFieldSubtotalOptions]) Source #

The optional configuration of subtotal cells.

subtotalOptions_metricHeaderCellStyle :: Lens' SubtotalOptions (Maybe TableCellStyle) Source #

The cell styling options for the subtotals of header cells.

subtotalOptions_totalCellStyle :: Lens' SubtotalOptions (Maybe TableCellStyle) Source #

The cell styling options for the subtotal cells.

subtotalOptions_totalsVisibility :: Lens' SubtotalOptions (Maybe Visibility) Source #

The visibility configuration for the subtotal cells.

subtotalOptions_valueCellStyle :: Lens' SubtotalOptions (Maybe TableCellStyle) Source #

The cell styling options for the subtotals of value cells.

TableAggregatedFieldWells

tableAggregatedFieldWells_groupBy :: Lens' TableAggregatedFieldWells (Maybe [DimensionField]) Source #

The group by field well for a pivot table. Values are grouped by group by fields.

tableAggregatedFieldWells_values :: Lens' TableAggregatedFieldWells (Maybe [MeasureField]) Source #

The values field well for a pivot table. Values are aggregated based on group by fields.

TableBorderOptions

tableBorderOptions_color :: Lens' TableBorderOptions (Maybe Text) Source #

The color of a table border.

tableBorderOptions_style :: Lens' TableBorderOptions (Maybe TableBorderStyle) Source #

The style (none, solid) of a table border.

tableBorderOptions_thickness :: Lens' TableBorderOptions (Maybe Natural) Source #

The thickness of a table border.

TableCellConditionalFormatting

tableCellConditionalFormatting_textFormat :: Lens' TableCellConditionalFormatting (Maybe TextConditionalFormat) Source #

The text format of the cell for conditional formatting.

tableCellConditionalFormatting_fieldId :: Lens' TableCellConditionalFormatting Text Source #

The field ID of the cell for conditional formatting.

TableCellImageSizingConfiguration

tableCellImageSizingConfiguration_tableCellImageScalingConfiguration :: Lens' TableCellImageSizingConfiguration (Maybe TableCellImageScalingConfiguration) Source #

The cell scaling configuration of the sizing options for the table image configuration.

TableCellStyle

tableCellStyle_backgroundColor :: Lens' TableCellStyle (Maybe Text) Source #

The background color for the table cells.

tableCellStyle_border :: Lens' TableCellStyle (Maybe GlobalTableBorderOptions) Source #

The borders for the table cells.

tableCellStyle_fontConfiguration :: Lens' TableCellStyle (Maybe FontConfiguration) Source #

The font configuration of the table cells.

tableCellStyle_height :: Lens' TableCellStyle (Maybe Natural) Source #

The height color for the table cells.

tableCellStyle_horizontalTextAlignment :: Lens' TableCellStyle (Maybe HorizontalTextAlignment) Source #

The horizontal text alignment (left, center, right, auto) for the table cells.

tableCellStyle_textWrap :: Lens' TableCellStyle (Maybe TextWrap) Source #

The text wrap (none, wrap) for the table cells.

tableCellStyle_verticalTextAlignment :: Lens' TableCellStyle (Maybe VerticalTextAlignment) Source #

The vertical text alignment (top, middle, bottom) for the table cells.

tableCellStyle_visibility :: Lens' TableCellStyle (Maybe Visibility) Source #

The visibility of the table cells.

TableConditionalFormatting

tableConditionalFormatting_conditionalFormattingOptions :: Lens' TableConditionalFormatting (Maybe [TableConditionalFormattingOption]) Source #

Conditional formatting options for a PivotTableVisual.

TableConditionalFormattingOption

tableConditionalFormattingOption_cell :: Lens' TableConditionalFormattingOption (Maybe TableCellConditionalFormatting) Source #

The cell conditional formatting option for a table.

tableConditionalFormattingOption_row :: Lens' TableConditionalFormattingOption (Maybe TableRowConditionalFormatting) Source #

The row conditional formatting option for a table.

TableConfiguration

tableConfiguration_fieldOptions :: Lens' TableConfiguration (Maybe TableFieldOptions) Source #

The field options for a table visual.

tableConfiguration_fieldWells :: Lens' TableConfiguration (Maybe TableFieldWells) Source #

The field wells of the visual.

tableConfiguration_paginatedReportOptions :: Lens' TableConfiguration (Maybe TablePaginatedReportOptions) Source #

The paginated report options for a table visual.

tableConfiguration_sortConfiguration :: Lens' TableConfiguration (Maybe TableSortConfiguration) Source #

The sort configuration for a TableVisual.

tableConfiguration_tableOptions :: Lens' TableConfiguration (Maybe TableOptions) Source #

The table options for a table visual.

tableConfiguration_totalOptions :: Lens' TableConfiguration (Maybe TotalOptions) Source #

The total options for a table visual.

TableFieldCustomIconContent

tableFieldCustomIconContent_icon :: Lens' TableFieldCustomIconContent (Maybe TableFieldIconSetType) Source #

The icon set type (link) of the custom icon content for table URL link content.

TableFieldCustomTextContent

tableFieldCustomTextContent_value :: Lens' TableFieldCustomTextContent (Maybe Text) Source #

The string value of the custom text content for the table URL link content.

tableFieldCustomTextContent_fontConfiguration :: Lens' TableFieldCustomTextContent FontConfiguration Source #

The font configuration of the custom text content for the table URL link content.

TableFieldImageConfiguration

tableFieldImageConfiguration_sizingOptions :: Lens' TableFieldImageConfiguration (Maybe TableCellImageSizingConfiguration) Source #

The sizing options for the table image configuration.

TableFieldLinkConfiguration

tableFieldLinkConfiguration_target :: Lens' TableFieldLinkConfiguration URLTargetConfiguration Source #

The URL target (new tab, new window, same tab) for the table link configuration.

tableFieldLinkConfiguration_content :: Lens' TableFieldLinkConfiguration TableFieldLinkContentConfiguration Source #

The URL content (text, icon) for the table link configuration.

TableFieldLinkContentConfiguration

tableFieldLinkContentConfiguration_customIconContent :: Lens' TableFieldLinkContentConfiguration (Maybe TableFieldCustomIconContent) Source #

The custom icon content for the table link content configuration.

tableFieldLinkContentConfiguration_customTextContent :: Lens' TableFieldLinkContentConfiguration (Maybe TableFieldCustomTextContent) Source #

The custom text content (value, font configuration) for the table link content configuration.

TableFieldOption

tableFieldOption_customLabel :: Lens' TableFieldOption (Maybe Text) Source #

The custom label for a table field.

tableFieldOption_uRLStyling :: Lens' TableFieldOption (Maybe TableFieldURLConfiguration) Source #

The URL configuration for a table field.

tableFieldOption_visibility :: Lens' TableFieldOption (Maybe Visibility) Source #

The visibility of a table field.

tableFieldOption_width :: Lens' TableFieldOption (Maybe Text) Source #

The width for a table field.

tableFieldOption_fieldId :: Lens' TableFieldOption Text Source #

The field ID for a table field.

TableFieldOptions

tableFieldOptions_order :: Lens' TableFieldOptions (Maybe [Text]) Source #

The order of field IDs of the field options for a table visual.

tableFieldOptions_selectedFieldOptions :: Lens' TableFieldOptions (Maybe [TableFieldOption]) Source #

The selected field options for the table field options.

TableFieldURLConfiguration

tableFieldURLConfiguration_imageConfiguration :: Lens' TableFieldURLConfiguration (Maybe TableFieldImageConfiguration) Source #

The image configuration of a table field URL.

tableFieldURLConfiguration_linkConfiguration :: Lens' TableFieldURLConfiguration (Maybe TableFieldLinkConfiguration) Source #

The link configuration of a table field URL.

TableFieldWells

tableFieldWells_tableAggregatedFieldWells :: Lens' TableFieldWells (Maybe TableAggregatedFieldWells) Source #

The aggregated field well for the table.

tableFieldWells_tableUnaggregatedFieldWells :: Lens' TableFieldWells (Maybe TableUnaggregatedFieldWells) Source #

The unaggregated field well for the table.

TableOptions

tableOptions_cellStyle :: Lens' TableOptions (Maybe TableCellStyle) Source #

The table cell style of table cells.

tableOptions_headerStyle :: Lens' TableOptions (Maybe TableCellStyle) Source #

The table cell style of a table header.

tableOptions_orientation :: Lens' TableOptions (Maybe TableOrientation) Source #

The orientation (vertical, horizontal) for a table.

tableOptions_rowAlternateColorOptions :: Lens' TableOptions (Maybe RowAlternateColorOptions) Source #

The row alternate color options (widget status, row alternate colors) for a table.

TablePaginatedReportOptions

tablePaginatedReportOptions_overflowColumnHeaderVisibility :: Lens' TablePaginatedReportOptions (Maybe Visibility) Source #

The visibility of repeating header rows on each page.

tablePaginatedReportOptions_verticalOverflowVisibility :: Lens' TablePaginatedReportOptions (Maybe Visibility) Source #

The visibility of printing table overflow across pages.

TableRowConditionalFormatting

tableRowConditionalFormatting_backgroundColor :: Lens' TableRowConditionalFormatting (Maybe ConditionalFormattingColor) Source #

The conditional formatting color (solid, gradient) of the background for a table row.

tableRowConditionalFormatting_textColor :: Lens' TableRowConditionalFormatting (Maybe ConditionalFormattingColor) Source #

The conditional formatting color (solid, gradient) of the text for a table row.

TableSideBorderOptions

tableSideBorderOptions_bottom :: Lens' TableSideBorderOptions (Maybe TableBorderOptions) Source #

The table border options of the bottom border.

tableSideBorderOptions_innerHorizontal :: Lens' TableSideBorderOptions (Maybe TableBorderOptions) Source #

The table border options of the inner horizontal border.

tableSideBorderOptions_innerVertical :: Lens' TableSideBorderOptions (Maybe TableBorderOptions) Source #

The table border options of the inner vertical border.

tableSideBorderOptions_left :: Lens' TableSideBorderOptions (Maybe TableBorderOptions) Source #

The table border options of the left border.

tableSideBorderOptions_right :: Lens' TableSideBorderOptions (Maybe TableBorderOptions) Source #

The table border options of the right border.

tableSideBorderOptions_top :: Lens' TableSideBorderOptions (Maybe TableBorderOptions) Source #

The table border options of the top border.

TableSortConfiguration

tableSortConfiguration_paginationConfiguration :: Lens' TableSortConfiguration (Maybe PaginationConfiguration) Source #

The pagination configuration (page size, page number) for the table.

tableSortConfiguration_rowSort :: Lens' TableSortConfiguration (Maybe [FieldSortOptions]) Source #

The field sort options for rows in the table.

TableUnaggregatedFieldWells

tableUnaggregatedFieldWells_values :: Lens' TableUnaggregatedFieldWells (Maybe [UnaggregatedField]) Source #

The values field well for a pivot table. Values are unaggregated for an unaggregated table.

TableVisual

tableVisual_actions :: Lens' TableVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

tableVisual_chartConfiguration :: Lens' TableVisual (Maybe TableConfiguration) Source #

The configuration settings of the visual.

tableVisual_conditionalFormatting :: Lens' TableVisual (Maybe TableConditionalFormatting) Source #

The conditional formatting for a PivotTableVisual.

tableVisual_subtitle :: Lens' TableVisual (Maybe VisualSubtitleLabelOptions) Source #

The subtitle that is displayed on the visual.

tableVisual_title :: Lens' TableVisual (Maybe VisualTitleLabelOptions) Source #

The title that is displayed on the visual.

tableVisual_visualId :: Lens' TableVisual Text Source #

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..

Tag

tag_key :: Lens' Tag Text Source #

Tag key.

tag_value :: Lens' Tag Text Source #

Tag value.

TagColumnOperation

tagColumnOperation_columnName :: Lens' TagColumnOperation Text Source #

The column that this operation acts on.

tagColumnOperation_tags :: Lens' TagColumnOperation (NonEmpty ColumnTag) Source #

The dataset column tag, currently only used for geospatial type tagging.

This is not tags for the Amazon Web Services tagging feature.

Template

template_arn :: Lens' Template (Maybe Text) Source #

The Amazon Resource Name (ARN) of the template.

template_createdTime :: Lens' Template (Maybe UTCTime) Source #

Time when this was created.

template_lastUpdatedTime :: Lens' Template (Maybe UTCTime) Source #

Time when this was last updated.

template_name :: Lens' Template (Maybe Text) Source #

The display name of the template.

template_templateId :: Lens' Template (Maybe Text) Source #

The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.

template_version :: Lens' Template (Maybe TemplateVersion) Source #

A structure describing the versions of the template.

TemplateAlias

templateAlias_aliasName :: Lens' TemplateAlias (Maybe Text) Source #

The display name of the template alias.

templateAlias_arn :: Lens' TemplateAlias (Maybe Text) Source #

The Amazon Resource Name (ARN) of the template alias.

templateAlias_templateVersionNumber :: Lens' TemplateAlias (Maybe Natural) Source #

The version number of the template alias.

TemplateError

templateError_message :: Lens' TemplateError (Maybe Text) Source #

Description of the error type.

templateError_type :: Lens' TemplateError (Maybe TemplateErrorType) Source #

Type of error.

templateError_violatedEntities :: Lens' TemplateError (Maybe [Entity]) Source #

TemplateSourceAnalysis

templateSourceAnalysis_arn :: Lens' TemplateSourceAnalysis Text Source #

The Amazon Resource Name (ARN) of the resource.

templateSourceAnalysis_dataSetReferences :: Lens' TemplateSourceAnalysis (NonEmpty DataSetReference) Source #

A structure containing information about the dataset references used as placeholders in the template.

TemplateSourceEntity

templateSourceEntity_sourceAnalysis :: Lens' TemplateSourceEntity (Maybe TemplateSourceAnalysis) Source #

The source analysis, if it is based on an analysis.

templateSourceEntity_sourceTemplate :: Lens' TemplateSourceEntity (Maybe TemplateSourceTemplate) Source #

The source template, if it is based on an template.

TemplateSourceTemplate

templateSourceTemplate_arn :: Lens' TemplateSourceTemplate Text Source #

The Amazon Resource Name (ARN) of the resource.

TemplateSummary

templateSummary_arn :: Lens' TemplateSummary (Maybe Text) Source #

A summary of a template.

templateSummary_createdTime :: Lens' TemplateSummary (Maybe UTCTime) Source #

The last time that this template was created.

templateSummary_lastUpdatedTime :: Lens' TemplateSummary (Maybe UTCTime) Source #

The last time that this template was updated.

templateSummary_latestVersionNumber :: Lens' TemplateSummary (Maybe Natural) Source #

A structure containing a list of version numbers for the template summary.

templateSummary_name :: Lens' TemplateSummary (Maybe Text) Source #

A display name for the template.

templateSummary_templateId :: Lens' TemplateSummary (Maybe Text) Source #

The ID of the template. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

TemplateVersion

templateVersion_createdTime :: Lens' TemplateVersion (Maybe UTCTime) Source #

The time that this template version was created.

templateVersion_dataSetConfigurations :: Lens' TemplateVersion (Maybe [DataSetConfiguration]) Source #

Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.

templateVersion_description :: Lens' TemplateVersion (Maybe Text) Source #

The description of the template.

templateVersion_errors :: Lens' TemplateVersion (Maybe (NonEmpty TemplateError)) Source #

Errors associated with this template version.

templateVersion_sheets :: Lens' TemplateVersion (Maybe [Sheet]) Source #

A list of the associated sheets with the unique identifier and name of each sheet.

templateVersion_sourceEntityArn :: Lens' TemplateVersion (Maybe Text) Source #

The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.

templateVersion_status :: Lens' TemplateVersion (Maybe ResourceStatus) Source #

The HTTP status of the request.

templateVersion_themeArn :: Lens' TemplateVersion (Maybe Text) Source #

The ARN of the theme associated with this version of the template.

templateVersion_versionNumber :: Lens' TemplateVersion (Maybe Natural) Source #

The version number of the template version.

TemplateVersionDefinition

templateVersionDefinition_analysisDefaults :: Lens' TemplateVersionDefinition (Maybe AnalysisDefaults) Source #

Undocumented member.

templateVersionDefinition_calculatedFields :: Lens' TemplateVersionDefinition (Maybe [CalculatedField]) Source #

An array of calculated field definitions for the template.

templateVersionDefinition_columnConfigurations :: Lens' TemplateVersionDefinition (Maybe [ColumnConfiguration]) Source #

An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.

templateVersionDefinition_filterGroups :: Lens' TemplateVersionDefinition (Maybe [FilterGroup]) Source #

Filter definitions for a template.

For more information, see Filtering Data in the Amazon QuickSight User Guide.

templateVersionDefinition_parameterDeclarations :: Lens' TemplateVersionDefinition (Maybe [ParameterDeclaration]) Source #

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 QuickSight in the Amazon QuickSight User Guide.

templateVersionDefinition_sheets :: Lens' TemplateVersionDefinition (Maybe [SheetDefinition]) Source #

An array of sheet definitions for a template.

templateVersionDefinition_dataSetConfigurations :: Lens' TemplateVersionDefinition [DataSetConfiguration] Source #

An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

TemplateVersionSummary

templateVersionSummary_arn :: Lens' TemplateVersionSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the template version.

templateVersionSummary_createdTime :: Lens' TemplateVersionSummary (Maybe UTCTime) Source #

The time that this template version was created.

templateVersionSummary_description :: Lens' TemplateVersionSummary (Maybe Text) Source #

The description of the template version.

templateVersionSummary_status :: Lens' TemplateVersionSummary (Maybe ResourceStatus) Source #

The status of the template version.

templateVersionSummary_versionNumber :: Lens' TemplateVersionSummary (Maybe Natural) Source #

The version number of the template version.

TeradataParameters

teradataParameters_host :: Lens' TeradataParameters Text Source #

Host.

teradataParameters_port :: Lens' TeradataParameters Natural Source #

Port.

teradataParameters_database :: Lens' TeradataParameters Text Source #

Database.

TextAreaControlDisplayOptions

textAreaControlDisplayOptions_placeholderOptions :: Lens' TextAreaControlDisplayOptions (Maybe TextControlPlaceholderOptions) Source #

The configuration of the placeholder options in a text area control.

textAreaControlDisplayOptions_titleOptions :: Lens' TextAreaControlDisplayOptions (Maybe LabelOptions) Source #

The options to configure the title visibility, name, and font size.

TextConditionalFormat

textConditionalFormat_backgroundColor :: Lens' TextConditionalFormat (Maybe ConditionalFormattingColor) Source #

The conditional formatting for the text background color.

textConditionalFormat_icon :: Lens' TextConditionalFormat (Maybe ConditionalFormattingIcon) Source #

The conditional formatting for the icon.

textConditionalFormat_textColor :: Lens' TextConditionalFormat (Maybe ConditionalFormattingColor) Source #

The conditional formatting for the text color.

TextControlPlaceholderOptions

textControlPlaceholderOptions_visibility :: Lens' TextControlPlaceholderOptions (Maybe Visibility) Source #

The visibility configuration of the placeholder options in a text control.

TextFieldControlDisplayOptions

textFieldControlDisplayOptions_placeholderOptions :: Lens' TextFieldControlDisplayOptions (Maybe TextControlPlaceholderOptions) Source #

The configuration of the placeholder options in a text field control.

textFieldControlDisplayOptions_titleOptions :: Lens' TextFieldControlDisplayOptions (Maybe LabelOptions) Source #

The options to configure the title visibility, name, and font size.

Theme

theme_arn :: Lens' Theme (Maybe Text) Source #

The Amazon Resource Name (ARN) of the theme.

theme_createdTime :: Lens' Theme (Maybe UTCTime) Source #

The date and time that the theme was created.

theme_lastUpdatedTime :: Lens' Theme (Maybe UTCTime) Source #

The date and time that the theme was last updated.

theme_name :: Lens' Theme (Maybe Text) Source #

The name that the user gives to the theme.

theme_themeId :: Lens' Theme (Maybe Text) Source #

The identifier that the user gives to the theme.

theme_type :: Lens' Theme (Maybe ThemeType) Source #

The type of theme, based on how it was created. Valid values include: QUICKSIGHT and CUSTOM.

theme_version :: Lens' Theme (Maybe ThemeVersion) Source #

Undocumented member.

ThemeAlias

themeAlias_aliasName :: Lens' ThemeAlias (Maybe Text) Source #

The display name of the theme alias.

themeAlias_arn :: Lens' ThemeAlias (Maybe Text) Source #

The Amazon Resource Name (ARN) of the theme alias.

themeAlias_themeVersionNumber :: Lens' ThemeAlias (Maybe Natural) Source #

The version number of the theme alias.

ThemeConfiguration

themeConfiguration_dataColorPalette :: Lens' ThemeConfiguration (Maybe DataColorPalette) Source #

Color properties that apply to chart data colors.

themeConfiguration_sheet :: Lens' ThemeConfiguration (Maybe SheetStyle) Source #

Display options related to sheets.

themeConfiguration_typography :: Lens' ThemeConfiguration (Maybe Typography) Source #

Undocumented member.

themeConfiguration_uIColorPalette :: Lens' ThemeConfiguration (Maybe UIColorPalette) Source #

Color properties that apply to the UI and to charts, excluding the colors that apply to data.

ThemeError

themeError_message :: Lens' ThemeError (Maybe Text) Source #

The error message.

themeError_type :: Lens' ThemeError (Maybe ThemeErrorType) Source #

The type of error.

ThemeSummary

themeSummary_arn :: Lens' ThemeSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource.

themeSummary_createdTime :: Lens' ThemeSummary (Maybe UTCTime) Source #

The date and time that this theme was created.

themeSummary_lastUpdatedTime :: Lens' ThemeSummary (Maybe UTCTime) Source #

The last date and time that this theme was updated.

themeSummary_latestVersionNumber :: Lens' ThemeSummary (Maybe Natural) Source #

The latest version number for the theme.

themeSummary_name :: Lens' ThemeSummary (Maybe Text) Source #

the display name for the theme.

themeSummary_themeId :: Lens' ThemeSummary (Maybe Text) Source #

The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

ThemeVersion

themeVersion_arn :: Lens' ThemeVersion (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource.

themeVersion_baseThemeId :: Lens' ThemeVersion (Maybe Text) Source #

The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.

themeVersion_configuration :: Lens' ThemeVersion (Maybe ThemeConfiguration) Source #

The theme configuration, which contains all the theme display properties.

themeVersion_createdTime :: Lens' ThemeVersion (Maybe UTCTime) Source #

The date and time that this theme version was created.

themeVersion_description :: Lens' ThemeVersion (Maybe Text) Source #

The description of the theme.

themeVersion_errors :: Lens' ThemeVersion (Maybe (NonEmpty ThemeError)) Source #

Errors associated with the theme.

themeVersion_status :: Lens' ThemeVersion (Maybe ResourceStatus) Source #

The status of the theme version.

themeVersion_versionNumber :: Lens' ThemeVersion (Maybe Natural) Source #

The version number of the theme.

ThemeVersionSummary

themeVersionSummary_arn :: Lens' ThemeVersionSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the theme version.

themeVersionSummary_createdTime :: Lens' ThemeVersionSummary (Maybe UTCTime) Source #

The date and time that this theme version was created.

themeVersionSummary_description :: Lens' ThemeVersionSummary (Maybe Text) Source #

The description of the theme version.

themeVersionSummary_status :: Lens' ThemeVersionSummary (Maybe ResourceStatus) Source #

The status of the theme version.

themeVersionSummary_versionNumber :: Lens' ThemeVersionSummary (Maybe Natural) Source #

The version number of the theme version.

ThousandSeparatorOptions

thousandSeparatorOptions_symbol :: Lens' ThousandSeparatorOptions (Maybe NumericSeparatorSymbol) Source #

Determines the thousands separator symbol.

thousandSeparatorOptions_visibility :: Lens' ThousandSeparatorOptions (Maybe Visibility) Source #

Determines the visibility of the thousands separator.

TileLayoutStyle

tileLayoutStyle_gutter :: Lens' TileLayoutStyle (Maybe GutterStyle) Source #

The gutter settings that apply between tiles.

tileLayoutStyle_margin :: Lens' TileLayoutStyle (Maybe MarginStyle) Source #

The margin settings that apply around the outside edge of sheets.

TileStyle

tileStyle_border :: Lens' TileStyle (Maybe BorderStyle) Source #

The border around a tile.

TimeBasedForecastProperties

timeBasedForecastProperties_lowerBoundary :: Lens' TimeBasedForecastProperties (Maybe Double) Source #

The lower boundary setup of a forecast computation.

timeBasedForecastProperties_periodsBackward :: Lens' TimeBasedForecastProperties (Maybe Natural) Source #

The periods backward setup of a forecast computation.

timeBasedForecastProperties_periodsForward :: Lens' TimeBasedForecastProperties (Maybe Natural) Source #

The periods forward setup of a forecast computation.

timeBasedForecastProperties_predictionInterval :: Lens' TimeBasedForecastProperties (Maybe Natural) Source #

The prediction interval setup of a forecast computation.

timeBasedForecastProperties_seasonality :: Lens' TimeBasedForecastProperties (Maybe Natural) Source #

The seasonality setup of a forecast computation. Choose one of the following options:

NULL: The input is set to NULL.
NON_NULL: The input is set to a custom value.

timeBasedForecastProperties_upperBoundary :: Lens' TimeBasedForecastProperties (Maybe Double) Source #

The upper boundary setup of a forecast computation.

TimeEqualityFilter

timeEqualityFilter_parameterName :: Lens' TimeEqualityFilter (Maybe Text) Source #

The parameter whose value should be used for the filter value.

This field is mutually exclusive to Value.

timeEqualityFilter_timeGranularity :: Lens' TimeEqualityFilter (Maybe TimeGranularity) Source #

The level of time precision that is used to aggregate DateTime values.

timeEqualityFilter_value :: Lens' TimeEqualityFilter (Maybe UTCTime) Source #

The value of a TimeEquality filter.

This field is mutually exclusive to ParameterName.

timeEqualityFilter_filterId :: Lens' TimeEqualityFilter Text Source #

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

timeEqualityFilter_column :: Lens' TimeEqualityFilter ColumnIdentifier Source #

The column that the filter is applied to.

TimeRangeDrillDownFilter

timeRangeDrillDownFilter_column :: Lens' TimeRangeDrillDownFilter ColumnIdentifier Source #

The column that the filter is applied to.

timeRangeDrillDownFilter_rangeMinimum :: Lens' TimeRangeDrillDownFilter UTCTime Source #

The minimum value for the filter value range.

timeRangeDrillDownFilter_rangeMaximum :: Lens' TimeRangeDrillDownFilter UTCTime Source #

The maximum value for the filter value range.

timeRangeDrillDownFilter_timeGranularity :: Lens' TimeRangeDrillDownFilter TimeGranularity Source #

The level of time precision that is used to aggregate DateTime values.

TimeRangeFilter

timeRangeFilter_excludePeriodConfiguration :: Lens' TimeRangeFilter (Maybe ExcludePeriodConfiguration) Source #

The exclude period of the time range filter.

timeRangeFilter_includeMaximum :: Lens' TimeRangeFilter (Maybe Bool) Source #

Determines whether the maximum value in the filter value range should be included in the filtered results.

timeRangeFilter_includeMinimum :: Lens' TimeRangeFilter (Maybe Bool) Source #

Determines whether the minimum value in the filter value range should be included in the filtered results.

timeRangeFilter_rangeMaximumValue :: Lens' TimeRangeFilter (Maybe TimeRangeFilterValue) Source #

The maximum value for the filter value range.

timeRangeFilter_rangeMinimumValue :: Lens' TimeRangeFilter (Maybe TimeRangeFilterValue) Source #

The minimum value for the filter value range.

timeRangeFilter_timeGranularity :: Lens' TimeRangeFilter (Maybe TimeGranularity) Source #

The level of time precision that is used to aggregate DateTime values.

timeRangeFilter_filterId :: Lens' TimeRangeFilter Text Source #

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

timeRangeFilter_column :: Lens' TimeRangeFilter ColumnIdentifier Source #

The column that the filter is applied to.

timeRangeFilter_nullOption :: Lens' TimeRangeFilter FilterNullOption Source #

This option determines how null values should be treated when filtering data.

ALL_VALUES: Include null values in filtered results.
NULLS_ONLY: Only include null values in filtered results.
NON_NULLS_ONLY: Exclude null values from filtered results.

TimeRangeFilterValue

timeRangeFilterValue_parameter :: Lens' TimeRangeFilterValue (Maybe Text) Source #

The parameter type input value.

timeRangeFilterValue_rollingDate :: Lens' TimeRangeFilterValue (Maybe RollingDateConfiguration) Source #

The rolling date input value.

timeRangeFilterValue_staticValue :: Lens' TimeRangeFilterValue (Maybe UTCTime) Source #

The static input value.

TooltipItem

tooltipItem_columnTooltipItem :: Lens' TooltipItem (Maybe ColumnTooltipItem) Source #

The tooltip item for the columns that are not part of a field well.

tooltipItem_fieldTooltipItem :: Lens' TooltipItem (Maybe FieldTooltipItem) Source #

The tooltip item for the fields.

TooltipOptions

tooltipOptions_fieldBasedTooltip :: Lens' TooltipOptions (Maybe FieldBasedTooltip) Source #

The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

tooltipOptions_selectedTooltipType :: Lens' TooltipOptions (Maybe SelectedTooltipType) Source #

The selected type for the tooltip. Choose one of the following options:

BASIC: A basic tooltip.
DETAILED: A detailed tooltip.

tooltipOptions_tooltipVisibility :: Lens' TooltipOptions (Maybe Visibility) Source #

Determines whether or not the tooltip is visible.

TopBottomFilter

topBottomFilter_limit :: Lens' TopBottomFilter (Maybe Int) Source #

The number of items to include in the top bottom filter results.

topBottomFilter_parameterName :: Lens' TopBottomFilter (Maybe Text) Source #

The parameter whose value should be used for the filter value.

topBottomFilter_timeGranularity :: Lens' TopBottomFilter (Maybe TimeGranularity) Source #

The level of time precision that is used to aggregate DateTime values.

topBottomFilter_filterId :: Lens' TopBottomFilter Text Source #

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

topBottomFilter_column :: Lens' TopBottomFilter ColumnIdentifier Source #

The column that the filter is applied to.

topBottomFilter_aggregationSortConfigurations :: Lens' TopBottomFilter [AggregationSortConfiguration] Source #

The aggregation and sort configuration of the top bottom filter.

TopBottomMoversComputation

topBottomMoversComputation_moverSize :: Lens' TopBottomMoversComputation (Maybe Natural) Source #

The mover size setup of the top and bottom movers computation.

topBottomMoversComputation_name :: Lens' TopBottomMoversComputation (Maybe Text) Source #

The name of a computation.

topBottomMoversComputation_sortOrder :: Lens' TopBottomMoversComputation (Maybe TopBottomSortOrder) Source #

The sort order setup of the top and bottom movers computation.

topBottomMoversComputation_value :: Lens' TopBottomMoversComputation (Maybe MeasureField) Source #

The value field that is used in a computation.

topBottomMoversComputation_computationId :: Lens' TopBottomMoversComputation Text Source #

The ID for a computation.

topBottomMoversComputation_time :: Lens' TopBottomMoversComputation DimensionField Source #

The time field that is used in a computation.

topBottomMoversComputation_category :: Lens' TopBottomMoversComputation DimensionField Source #

The category field that is used in a computation.

topBottomMoversComputation_type :: Lens' TopBottomMoversComputation TopBottomComputationType Source #

The computation type. Choose from the following options:

TOP: Top movers computation.
BOTTOM: Bottom movers computation.

TopBottomRankedComputation

topBottomRankedComputation_name :: Lens' TopBottomRankedComputation (Maybe Text) Source #

The name of a computation.

topBottomRankedComputation_resultSize :: Lens' TopBottomRankedComputation (Maybe Natural) Source #

The result size of a top and bottom ranked computation.

topBottomRankedComputation_value :: Lens' TopBottomRankedComputation (Maybe MeasureField) Source #

The value field that is used in a computation.

topBottomRankedComputation_computationId :: Lens' TopBottomRankedComputation Text Source #

The ID for a computation.

topBottomRankedComputation_category :: Lens' TopBottomRankedComputation DimensionField Source #

The category field that is used in a computation.

topBottomRankedComputation_type :: Lens' TopBottomRankedComputation TopBottomComputationType Source #

The computation type. Choose one of the following options:

TOP: A top ranked computation.
BOTTOM: A bottom ranked computation.

TotalAggregationComputation

totalAggregationComputation_name :: Lens' TotalAggregationComputation (Maybe Text) Source #

The name of a computation.

totalAggregationComputation_computationId :: Lens' TotalAggregationComputation Text Source #

The ID for a computation.

totalAggregationComputation_value :: Lens' TotalAggregationComputation MeasureField Source #

The value field that is used in a computation.

TotalOptions

totalOptions_customLabel :: Lens' TotalOptions (Maybe Text) Source #

The custom label string for the total cells.

totalOptions_placement :: Lens' TotalOptions (Maybe TableTotalsPlacement) Source #

The placement (start, end) for the total cells.

totalOptions_scrollStatus :: Lens' TotalOptions (Maybe TableTotalsScrollStatus) Source #

The scroll status (pinned, scrolled) for the total cells.

totalOptions_totalCellStyle :: Lens' TotalOptions (Maybe TableCellStyle) Source #

Cell styling options for the total cells.

totalOptions_totalsVisibility :: Lens' TotalOptions (Maybe Visibility) Source #

The visibility configuration for the total cells.

TransformOperation

transformOperation_castColumnTypeOperation :: Lens' TransformOperation (Maybe CastColumnTypeOperation) Source #

A transform operation that casts a column to a different type.

transformOperation_createColumnsOperation :: Lens' TransformOperation (Maybe CreateColumnsOperation) Source #

An operation that creates calculated columns. Columns created in one such operation form a lexical closure.

transformOperation_filterOperation :: Lens' TransformOperation (Maybe FilterOperation) Source #

An operation that filters rows based on some condition.

transformOperation_projectOperation :: Lens' TransformOperation (Maybe ProjectOperation) Source #

An operation that projects columns. Operations that come after a projection can only refer to projected columns.

transformOperation_renameColumnOperation :: Lens' TransformOperation (Maybe RenameColumnOperation) Source #

An operation that renames a column.

transformOperation_tagColumnOperation :: Lens' TransformOperation (Maybe TagColumnOperation) Source #

An operation that tags a column with additional information.

transformOperation_untagColumnOperation :: Lens' TransformOperation (Maybe UntagColumnOperation) Source #

Undocumented member.

TreeMapAggregatedFieldWells

treeMapAggregatedFieldWells_colors :: Lens' TreeMapAggregatedFieldWells (Maybe [MeasureField]) Source #

The color field well of a tree map. Values are grouped by aggregations based on group by fields.

treeMapAggregatedFieldWells_groups :: Lens' TreeMapAggregatedFieldWells (Maybe [DimensionField]) Source #

The group by field well of a tree map. Values are grouped based on group by fields.

treeMapAggregatedFieldWells_sizes :: Lens' TreeMapAggregatedFieldWells (Maybe [MeasureField]) Source #

The size field well of a tree map. Values are aggregated based on group by fields.

TreeMapConfiguration

treeMapConfiguration_colorLabelOptions :: Lens' TreeMapConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options (label text, label visibility) for the colors displayed in a tree map.

treeMapConfiguration_colorScale :: Lens' TreeMapConfiguration (Maybe ColorScale) Source #

The color options (gradient color, point of divergence) of a tree map.

treeMapConfiguration_dataLabels :: Lens' TreeMapConfiguration (Maybe DataLabelOptions) Source #

The options that determine if visual data labels are displayed.

treeMapConfiguration_fieldWells :: Lens' TreeMapConfiguration (Maybe TreeMapFieldWells) Source #

The field wells of the visual.

treeMapConfiguration_groupLabelOptions :: Lens' TreeMapConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options (label text, label visibility) of the groups that are displayed in a tree map.

treeMapConfiguration_legend :: Lens' TreeMapConfiguration (Maybe LegendOptions) Source #

The legend display setup of the visual.

treeMapConfiguration_sizeLabelOptions :: Lens' TreeMapConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options (label text, label visibility) of the sizes that are displayed in a tree map.

treeMapConfiguration_sortConfiguration :: Lens' TreeMapConfiguration (Maybe TreeMapSortConfiguration) Source #

The sort configuration of a tree map.

treeMapConfiguration_tooltip :: Lens' TreeMapConfiguration (Maybe TooltipOptions) Source #

The tooltip display setup of the visual.

TreeMapFieldWells

treeMapFieldWells_treeMapAggregatedFieldWells :: Lens' TreeMapFieldWells (Maybe TreeMapAggregatedFieldWells) Source #

The aggregated field wells of a tree map.

TreeMapSortConfiguration

treeMapSortConfiguration_treeMapGroupItemsLimitConfiguration :: Lens' TreeMapSortConfiguration (Maybe ItemsLimitConfiguration) Source #

The limit on the number of groups that are displayed.

treeMapSortConfiguration_treeMapSort :: Lens' TreeMapSortConfiguration (Maybe [FieldSortOptions]) Source #

The sort configuration of group by fields.

TreeMapVisual

treeMapVisual_actions :: Lens' TreeMapVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

treeMapVisual_chartConfiguration :: Lens' TreeMapVisual (Maybe TreeMapConfiguration) Source #

The configuration settings of the visual.

treeMapVisual_columnHierarchies :: Lens' TreeMapVisual (Maybe [ColumnHierarchy]) Source #

The column hierarchy that is used during drill-downs and drill-ups.

treeMapVisual_subtitle :: Lens' TreeMapVisual (Maybe VisualSubtitleLabelOptions) Source #

The subtitle that is displayed on the visual.

treeMapVisual_title :: Lens' TreeMapVisual (Maybe VisualTitleLabelOptions) Source #

The title that is displayed on the visual.

treeMapVisual_visualId :: Lens' TreeMapVisual Text Source #

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..

TrendArrowOptions

trendArrowOptions_visibility :: Lens' TrendArrowOptions (Maybe Visibility) Source #

The visibility of the trend arrows.

TwitterParameters

twitterParameters_query :: Lens' TwitterParameters Text Source #

Twitter query string.

twitterParameters_maxRows :: Lens' TwitterParameters Natural Source #

Maximum number of rows to query Twitter.

Typography

typography_fontFamilies :: Lens' Typography (Maybe [Font]) Source #

Determines the list of font families.

UIColorPalette

uIColorPalette_accent :: Lens' UIColorPalette (Maybe Text) Source #

This color is that applies to selected states and buttons.

uIColorPalette_accentForeground :: Lens' UIColorPalette (Maybe Text) Source #

The foreground color that applies to any text or other elements that appear over the accent color.

uIColorPalette_danger :: Lens' UIColorPalette (Maybe Text) Source #

The color that applies to error messages.

uIColorPalette_dangerForeground :: Lens' UIColorPalette (Maybe Text) Source #

The foreground color that applies to any text or other elements that appear over the error color.

uIColorPalette_dimension :: Lens' UIColorPalette (Maybe Text) Source #

The color that applies to the names of fields that are identified as dimensions.

uIColorPalette_dimensionForeground :: Lens' UIColorPalette (Maybe Text) Source #

The foreground color that applies to any text or other elements that appear over the dimension color.

uIColorPalette_measure :: Lens' UIColorPalette (Maybe Text) Source #

The color that applies to the names of fields that are identified as measures.

uIColorPalette_measureForeground :: Lens' UIColorPalette (Maybe Text) Source #

The foreground color that applies to any text or other elements that appear over the measure color.

uIColorPalette_primaryBackground :: Lens' UIColorPalette (Maybe Text) Source #

The background color that applies to visuals and other high emphasis UI.

uIColorPalette_primaryForeground :: Lens' UIColorPalette (Maybe Text) Source #

The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.

uIColorPalette_secondaryBackground :: Lens' UIColorPalette (Maybe Text) Source #

The background color that applies to the sheet background and sheet controls.

uIColorPalette_secondaryForeground :: Lens' UIColorPalette (Maybe Text) Source #

The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.

uIColorPalette_success :: Lens' UIColorPalette (Maybe Text) Source #

The color that applies to success messages, for example the check mark for a successful download.

uIColorPalette_successForeground :: Lens' UIColorPalette (Maybe Text) Source #

The foreground color that applies to any text or other elements that appear over the success color.

uIColorPalette_warning :: Lens' UIColorPalette (Maybe Text) Source #

This color that applies to warning and informational messages.

uIColorPalette_warningForeground :: Lens' UIColorPalette (Maybe Text) Source #

The foreground color that applies to any text or other elements that appear over the warning color.

UnaggregatedField

unaggregatedField_formatConfiguration :: Lens' UnaggregatedField (Maybe FormatConfiguration) Source #

The format configuration of the field.

unaggregatedField_fieldId :: Lens' UnaggregatedField Text Source #

The custom field ID.

unaggregatedField_column :: Lens' UnaggregatedField ColumnIdentifier Source #

The column that is used in the UnaggregatedField.

UniqueValuesComputation

uniqueValuesComputation_name :: Lens' UniqueValuesComputation (Maybe Text) Source #

The name of a computation.

uniqueValuesComputation_computationId :: Lens' UniqueValuesComputation Text Source #

The ID for a computation.

uniqueValuesComputation_category :: Lens' UniqueValuesComputation DimensionField Source #

The category field that is used in a computation.

UntagColumnOperation

untagColumnOperation_columnName :: Lens' UntagColumnOperation Text Source #

The column that this operation acts on.

untagColumnOperation_tagNames :: Lens' UntagColumnOperation [ColumnTagName] Source #

The column tags to remove from this column.

UploadSettings

uploadSettings_containsHeader :: Lens' UploadSettings (Maybe Bool) Source #

Whether the file has a header row, or the files each have a header row.

uploadSettings_delimiter :: Lens' UploadSettings (Maybe Text) Source #

The delimiter between values in the file.

uploadSettings_format :: Lens' UploadSettings (Maybe FileFormat) Source #

File format.

uploadSettings_startFromRow :: Lens' UploadSettings (Maybe Natural) Source #

A row number to start reading data from.

uploadSettings_textQualifier :: Lens' UploadSettings (Maybe TextQualifier) Source #

Text qualifier.

User

user_active :: Lens' User (Maybe Bool) Source #

The active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.

user_arn :: Lens' User (Maybe Text) Source #

The Amazon Resource Name (ARN) for the user.

user_customPermissionsName :: Lens' User (Maybe Text) Source #

The custom permissions profile associated with this user.

user_email :: Lens' User (Maybe Text) Source #

The user's email address.

user_externalLoginFederationProviderType :: Lens' User (Maybe Text) Source #

The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.

COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.

user_externalLoginFederationProviderUrl :: Lens' User (Maybe Text) Source #

The URL of the external login provider.

user_externalLoginId :: Lens' User (Maybe Text) Source #

The identity ID for the user in the external login provider.

user_identityType :: Lens' User (Maybe IdentityType) Source #

The type of identity authentication used by the user.

user_principalId :: Lens' User (Maybe Text) Source #

The principal ID of the user.

user_role :: Lens' User (Maybe UserRole) Source #

The Amazon QuickSight role for the user. The user role can be one of the following:.

READER: A user who has read-only access to dashboards.
AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.
ADMIN: A user who is an author, who can also manage Amazon Amazon QuickSight settings.
RESTRICTED_READER: This role isn't currently available for use.
RESTRICTED_AUTHOR: This role isn't currently available for use.

user_userName :: Lens' User (Maybe Text) Source #

The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.

VisibleRangeOptions

visibleRangeOptions_percentRange :: Lens' VisibleRangeOptions (Maybe PercentVisibleRange) Source #

The percent range in the visible range.

Visual

visual_barChartVisual :: Lens' Visual (Maybe BarChartVisual) Source #

A bar chart.

For more information, see Using bar charts in the Amazon QuickSight User Guide.

visual_boxPlotVisual :: Lens' Visual (Maybe BoxPlotVisual) Source #

A box plot.

For more information, see Using box plots in the Amazon QuickSight User Guide.

visual_comboChartVisual :: Lens' Visual (Maybe ComboChartVisual) Source #

A combo chart.

For more information, see Using combo charts in the Amazon QuickSight User Guide.

visual_customContentVisual :: Lens' Visual (Maybe CustomContentVisual) Source #

A visual that contains custom content.

For more information, see Using custom visual content in the Amazon QuickSight User Guide.

visual_emptyVisual :: Lens' Visual (Maybe EmptyVisual) Source #

An empty visual.

visual_filledMapVisual :: Lens' Visual (Maybe FilledMapVisual) Source #

A filled map.

For more information, see Creating filled maps in the Amazon QuickSight User Guide.

visual_funnelChartVisual :: Lens' Visual (Maybe FunnelChartVisual) Source #

A funnel chart.

For more information, see Using funnel charts in the Amazon QuickSight User Guide.

visual_gaugeChartVisual :: Lens' Visual (Maybe GaugeChartVisual) Source #

A gauge chart.

For more information, see Using gauge charts in the Amazon QuickSight User Guide.

visual_geospatialMapVisual :: Lens' Visual (Maybe GeospatialMapVisual) Source #

A geospatial map or a points on map visual.

For more information, see Creating point maps in the Amazon QuickSight User Guide.

visual_heatMapVisual :: Lens' Visual (Maybe HeatMapVisual) Source #

A heat map.

For more information, see Using heat maps in the Amazon QuickSight User Guide.

visual_histogramVisual :: Lens' Visual (Maybe HistogramVisual) Source #

A histogram.

For more information, see Using histograms in the Amazon QuickSight User Guide.

visual_insightVisual :: Lens' Visual (Maybe InsightVisual) Source #

An insight visual.

For more information, see Working with insights in the Amazon QuickSight User Guide.

visual_kPIVisual :: Lens' Visual (Maybe KPIVisual) Source #

A key performance indicator (KPI).

For more information, see Using KPIs in the Amazon QuickSight User Guide.

visual_lineChartVisual :: Lens' Visual (Maybe LineChartVisual) Source #

A line chart.

For more information, see Using line charts in the Amazon QuickSight User Guide.

visual_pieChartVisual :: Lens' Visual (Maybe PieChartVisual) Source #

A pie or donut chart.

For more information, see Using pie charts in the Amazon QuickSight User Guide.

visual_pivotTableVisual :: Lens' Visual (Maybe PivotTableVisual) Source #

A pivot table.

For more information, see Using pivot tables in the Amazon QuickSight User Guide.

visual_sankeyDiagramVisual :: Lens' Visual (Maybe SankeyDiagramVisual) Source #

A sankey diagram.

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.

visual_scatterPlotVisual :: Lens' Visual (Maybe ScatterPlotVisual) Source #

A scatter plot.

For more information, see Using scatter plots in the Amazon QuickSight User Guide.

visual_tableVisual :: Lens' Visual (Maybe TableVisual) Source #

A table visual.

For more information, see Using tables as visuals in the Amazon QuickSight User Guide.

visual_treeMapVisual :: Lens' Visual (Maybe TreeMapVisual) Source #

A tree map.

For more information, see Using tree maps in the Amazon QuickSight User Guide.

visual_waterfallVisual :: Lens' Visual (Maybe WaterfallVisual) Source #

A waterfall chart.

For more information, see Using waterfall charts in the Amazon QuickSight User Guide.

visual_wordCloudVisual :: Lens' Visual (Maybe WordCloudVisual) Source #

A word cloud.

For more information, see Using word clouds in the Amazon QuickSight User Guide.

VisualCustomAction

visualCustomAction_status :: Lens' VisualCustomAction (Maybe WidgetStatus) Source #

The status of the VisualCustomAction.

visualCustomAction_customActionId :: Lens' VisualCustomAction Text Source #

The ID of the VisualCustomAction.

visualCustomAction_name :: Lens' VisualCustomAction Text Source #

The name of the VisualCustomAction.

visualCustomAction_trigger :: Lens' VisualCustomAction VisualCustomActionTrigger Source #

The trigger of the VisualCustomAction.

Valid values are defined as follows:

DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.
DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.

visualCustomAction_actionOperations :: Lens' VisualCustomAction (NonEmpty VisualCustomActionOperation) Source #

A list of VisualCustomActionOperations.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

VisualCustomActionOperation

visualCustomActionOperation_filterOperation :: Lens' VisualCustomActionOperation (Maybe CustomActionFilterOperation) Source #

The filter operation that filters data included in a visual or in an entire sheet.

visualCustomActionOperation_navigationOperation :: Lens' VisualCustomActionOperation (Maybe CustomActionNavigationOperation) Source #

The navigation operation that navigates between different sheets in the same analysis.

visualCustomActionOperation_setParametersOperation :: Lens' VisualCustomActionOperation (Maybe CustomActionSetParametersOperation) Source #

The set parameter operation that sets parameters in custom action.

visualCustomActionOperation_uRLOperation :: Lens' VisualCustomActionOperation (Maybe CustomActionURLOperation) Source #

The URL operation that opens a link to another webpage.

VisualPalette

visualPalette_chartColor :: Lens' VisualPalette (Maybe Text) Source #

The chart color options for the visual palette.

visualPalette_colorMap :: Lens' VisualPalette (Maybe [DataPathColor]) Source #

The color map options for the visual palette.

VisualSubtitleLabelOptions

visualSubtitleLabelOptions_formatText :: Lens' VisualSubtitleLabelOptions (Maybe LongFormatText) Source #

The long text format of the subtitle label, such as plain text or rich text.

visualSubtitleLabelOptions_visibility :: Lens' VisualSubtitleLabelOptions (Maybe Visibility) Source #

The visibility of the subtitle label.

VisualTitleLabelOptions

visualTitleLabelOptions_formatText :: Lens' VisualTitleLabelOptions (Maybe ShortFormatText) Source #

The short text format of the title label, such as plain text or rich text.

visualTitleLabelOptions_visibility :: Lens' VisualTitleLabelOptions (Maybe Visibility) Source #

The visibility of the title label.

VpcConnectionProperties

vpcConnectionProperties_vpcConnectionArn :: Lens' VpcConnectionProperties Text Source #

The Amazon Resource Name (ARN) for the VPC connection.

WaterfallChartAggregatedFieldWells

waterfallChartAggregatedFieldWells_breakdowns :: Lens' WaterfallChartAggregatedFieldWells (Maybe [DimensionField]) Source #

The breakdown field wells of a waterfall visual.

waterfallChartAggregatedFieldWells_categories :: Lens' WaterfallChartAggregatedFieldWells (Maybe [DimensionField]) Source #

The category field wells of a waterfall visual.

waterfallChartAggregatedFieldWells_values :: Lens' WaterfallChartAggregatedFieldWells (Maybe [MeasureField]) Source #

The value field wells of a waterfall visual.

WaterfallChartConfiguration

waterfallChartConfiguration_categoryAxisDisplayOptions :: Lens' WaterfallChartConfiguration (Maybe AxisDisplayOptions) Source #

The options that determine the presentation of the category axis.

waterfallChartConfiguration_categoryAxisLabelOptions :: Lens' WaterfallChartConfiguration (Maybe ChartAxisLabelOptions) Source #

The options that determine the presentation of the category axis label.

waterfallChartConfiguration_dataLabels :: Lens' WaterfallChartConfiguration (Maybe DataLabelOptions) Source #

The data label configuration of a waterfall visual.

waterfallChartConfiguration_fieldWells :: Lens' WaterfallChartConfiguration (Maybe WaterfallChartFieldWells) Source #

The field well configuration of a waterfall visual.

waterfallChartConfiguration_legend :: Lens' WaterfallChartConfiguration (Maybe LegendOptions) Source #

The legend configuration of a waterfall visual.

waterfallChartConfiguration_primaryYAxisDisplayOptions :: Lens' WaterfallChartConfiguration (Maybe AxisDisplayOptions) Source #

The options that determine the presentation of the y-axis.

waterfallChartConfiguration_primaryYAxisLabelOptions :: Lens' WaterfallChartConfiguration (Maybe ChartAxisLabelOptions) Source #

The options that determine the presentation of the y-axis label.

waterfallChartConfiguration_sortConfiguration :: Lens' WaterfallChartConfiguration (Maybe WaterfallChartSortConfiguration) Source #

The sort configuration of a waterfall visual.

waterfallChartConfiguration_visualPalette :: Lens' WaterfallChartConfiguration (Maybe VisualPalette) Source #

The visual palette configuration of a waterfall visual.

waterfallChartConfiguration_waterfallChartOptions :: Lens' WaterfallChartConfiguration (Maybe WaterfallChartOptions) Source #

The options that determine the presentation of a waterfall visual.

WaterfallChartFieldWells

waterfallChartFieldWells_waterfallChartAggregatedFieldWells :: Lens' WaterfallChartFieldWells (Maybe WaterfallChartAggregatedFieldWells) Source #

The field well configuration of a waterfall visual.

WaterfallChartOptions

waterfallChartOptions_totalBarLabel :: Lens' WaterfallChartOptions (Maybe Text) Source #

This option determines the total bar label of a waterfall visual.

WaterfallChartSortConfiguration

waterfallChartSortConfiguration_breakdownItemsLimit :: Lens' WaterfallChartSortConfiguration (Maybe ItemsLimitConfiguration) Source #

The limit on the number of bar groups that are displayed.

waterfallChartSortConfiguration_categorySort :: Lens' WaterfallChartSortConfiguration (Maybe [FieldSortOptions]) Source #

The sort configuration of the category fields.

WaterfallVisual

waterfallVisual_actions :: Lens' WaterfallVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

waterfallVisual_chartConfiguration :: Lens' WaterfallVisual (Maybe WaterfallChartConfiguration) Source #

The configuration for a waterfall visual.

waterfallVisual_columnHierarchies :: Lens' WaterfallVisual (Maybe [ColumnHierarchy]) Source #

The column hierarchy that is used during drill-downs and drill-ups.

waterfallVisual_subtitle :: Lens' WaterfallVisual (Maybe VisualSubtitleLabelOptions) Source #

The subtitle that is displayed on the visual.

waterfallVisual_title :: Lens' WaterfallVisual (Maybe VisualTitleLabelOptions) Source #

The title that is displayed on the visual.

waterfallVisual_visualId :: Lens' WaterfallVisual Text Source #

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.

WhatIfPointScenario

whatIfPointScenario_date :: Lens' WhatIfPointScenario UTCTime Source #

The date that you need the forecast results for.

whatIfPointScenario_value :: Lens' WhatIfPointScenario Double Source #

The target value that you want to meet for the provided date.

WhatIfRangeScenario

whatIfRangeScenario_startDate :: Lens' WhatIfRangeScenario UTCTime Source #

The start date in the date range that you need the forecast results for.

whatIfRangeScenario_endDate :: Lens' WhatIfRangeScenario UTCTime Source #

The end date in the date range that you need the forecast results for.

whatIfRangeScenario_value :: Lens' WhatIfRangeScenario Double Source #

The target value that you want to meet for the provided date range.

WordCloudAggregatedFieldWells

wordCloudAggregatedFieldWells_groupBy :: Lens' WordCloudAggregatedFieldWells (Maybe [DimensionField]) Source #

The group by field well of a word cloud. Values are grouped by group by fields.

wordCloudAggregatedFieldWells_size :: Lens' WordCloudAggregatedFieldWells (Maybe [MeasureField]) Source #

The size field well of a word cloud. Values are aggregated based on group by fields.

WordCloudChartConfiguration

wordCloudChartConfiguration_categoryLabelOptions :: Lens' WordCloudChartConfiguration (Maybe ChartAxisLabelOptions) Source #

The label options (label text, label visibility, and sort icon visibility) for the word cloud category.

wordCloudChartConfiguration_fieldWells :: Lens' WordCloudChartConfiguration (Maybe WordCloudFieldWells) Source #

The field wells of the visual.

wordCloudChartConfiguration_sortConfiguration :: Lens' WordCloudChartConfiguration (Maybe WordCloudSortConfiguration) Source #

The sort configuration of a word cloud visual.

wordCloudChartConfiguration_wordCloudOptions :: Lens' WordCloudChartConfiguration (Maybe WordCloudOptions) Source #

The options for a word cloud visual.

WordCloudFieldWells

wordCloudFieldWells_wordCloudAggregatedFieldWells :: Lens' WordCloudFieldWells (Maybe WordCloudAggregatedFieldWells) Source #

The aggregated field wells of a word cloud.

WordCloudOptions

wordCloudOptions_cloudLayout :: Lens' WordCloudOptions (Maybe WordCloudCloudLayout) Source #

The cloud layout options (fluid, normal) of a word cloud.

wordCloudOptions_maximumStringLength :: Lens' WordCloudOptions (Maybe Natural) Source #

The length limit of each word from 1-100.

wordCloudOptions_wordCasing :: Lens' WordCloudOptions (Maybe WordCloudWordCasing) Source #

The word casing options (lower_case, existing_case) for the words in a word cloud.

wordCloudOptions_wordOrientation :: Lens' WordCloudOptions (Maybe WordCloudWordOrientation) Source #

The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.

wordCloudOptions_wordPadding :: Lens' WordCloudOptions (Maybe WordCloudWordPadding) Source #

The word padding options (none, small, medium, large) for the words in a word cloud.

wordCloudOptions_wordScaling :: Lens' WordCloudOptions (Maybe WordCloudWordScaling) Source #

The word scaling options (emphasize, normal) for the words in a word cloud.

WordCloudSortConfiguration

wordCloudSortConfiguration_categoryItemsLimit :: Lens' WordCloudSortConfiguration (Maybe ItemsLimitConfiguration) Source #

The limit on the number of groups that are displayed in a word cloud.

wordCloudSortConfiguration_categorySort :: Lens' WordCloudSortConfiguration (Maybe [FieldSortOptions]) Source #

The sort configuration of group by fields.

WordCloudVisual

wordCloudVisual_actions :: Lens' WordCloudVisual (Maybe [VisualCustomAction]) Source #

The list of custom actions that are configured for a visual.

wordCloudVisual_chartConfiguration :: Lens' WordCloudVisual (Maybe WordCloudChartConfiguration) Source #

The configuration settings of the visual.

wordCloudVisual_columnHierarchies :: Lens' WordCloudVisual (Maybe [ColumnHierarchy]) Source #

The column hierarchy that is used during drill-downs and drill-ups.

wordCloudVisual_subtitle :: Lens' WordCloudVisual (Maybe VisualSubtitleLabelOptions) Source #

The subtitle that is displayed on the visual.

wordCloudVisual_title :: Lens' WordCloudVisual (Maybe VisualTitleLabelOptions) Source #

The title that is displayed on the visual.

wordCloudVisual_visualId :: Lens' WordCloudVisual Text Source #

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..