libZSservicesZSamazonka-quicksightZSamazonka-quicksight
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.QuickSight.Lens

Contents

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_requestId :: Lens' CancelIngestionResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_status :: Lens' CancelIngestionResponse Int Source #

The HTTP status of the request.

UpdateDataSource

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_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_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_requestId :: Lens' UpdateDataSourceResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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

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.

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_requestId :: Lens' DeleteDataSourceResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_status :: Lens' DeleteDataSourceResponse Int Source #

The HTTP status of the request.

CreateTemplate

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

createTemplate_sourceEntity :: Lens' CreateTemplate 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.

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

The Amazon Web Services request ID for this operation.

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

The ARN for the template.

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

The template creation status.

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.

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. Currently, you should set this to default.

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.

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_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_permissions :: Lens' DescribeThemePermissionsResponse (Maybe (NonEmpty ResourcePermission)) Source #

A list of resource permissions set on the theme.

describeThemePermissionsResponse_status :: Lens' DescribeThemePermissionsResponse Int Source #

The HTTP status of the request.

ListGroupMemberships

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

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

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

The maximum number of results to return from this 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. Currently, you should set this to default.

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

The Amazon Web Services request ID for this operation.

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

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

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

The list of the members of the group.

listGroupMembershipsResponse_status :: Lens' ListGroupMembershipsResponse Int Source #

The HTTP status of the request.

ListFolders

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

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

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

The maximum number of results to be returned per request.

listFolders_awsAccountId :: Lens' ListFolders Text Source #

The AWS account ID.

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

The request ID.

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

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

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

A structure that contains all of the folders in your AWS account. This structure provides basic information about the folders.

listFoldersResponse_status :: Lens' ListFoldersResponse Int Source #

The status. If succeeded, the status is SC_OK

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_requestId :: Lens' DescribeDataSetPermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_status :: Lens' DescribeDataSetPermissionsResponse 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 IAMpolicy 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_requestId :: Lens' DeleteIAMPolicyAssignmentResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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

The name of the assignment.

deleteIAMPolicyAssignmentResponse_status :: Lens' DeleteIAMPolicyAssignmentResponse 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_policyArn :: Lens' UpdateIAMPolicyAssignment (Maybe Text) Source #

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

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_awsAccountId :: Lens' UpdateIAMPolicyAssignment Text Source #

The ID of the Amazon Web Services account that contains the IAMpolicy 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_requestId :: Lens' UpdateIAMPolicyAssignmentResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_policyArn :: Lens' UpdateIAMPolicyAssignmentResponse (Maybe Text) Source #

The ARN for the IAMpolicy applied to the Amazon QuickSight users and groups specified in this assignment.

updateIAMPolicyAssignmentResponse_identities :: Lens' UpdateIAMPolicyAssignmentResponse (Maybe (HashMap Text [Text])) Source #

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

updateIAMPolicyAssignmentResponse_assignmentId :: Lens' UpdateIAMPolicyAssignmentResponse (Maybe Text) Source #

The ID of the assignment.

updateIAMPolicyAssignmentResponse_status :: Lens' UpdateIAMPolicyAssignmentResponse 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_requestId :: Lens' DescribeIngestionResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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

Information about the ingestion.

describeIngestionResponse_status :: Lens' DescribeIngestionResponse Int Source #

The HTTP status of the request.

DeleteFolder

deleteFolder_awsAccountId :: Lens' DeleteFolder Text Source #

The AWS Account ID for the folder.

deleteFolder_folderId :: Lens' DeleteFolder Text Source #

The folder ID.

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

The request ID.

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

The Amazon Resource Name of the deleted folder.

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

The folder ID.

deleteFolderResponse_status :: Lens' DeleteFolderResponse Int Source #

The status of deleting the folder. If succeeded, the status is SC_OK (200).

UpdateFolder

updateFolder_awsAccountId :: Lens' UpdateFolder Text Source #

The AWS account ID.

updateFolder_folderId :: Lens' UpdateFolder Text Source #

The folder ID.

updateFolder_name :: Lens' UpdateFolder Text Source #

The name of the folder.

updateFolderResponse_requestId :: Lens' UpdateFolderResponse (Maybe Text) Source #

The request ID.

updateFolderResponse_arn :: Lens' UpdateFolderResponse (Maybe Text) Source #

The Amazon Resource Name (ARN).

updateFolderResponse_folderId :: Lens' UpdateFolderResponse (Maybe Text) Source #

The folder ID.

updateFolderResponse_status :: Lens' UpdateFolderResponse Int Source #

The status. If succeeded, the status is SC_OK.

ListUserGroups

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

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

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

The maximum number of results to return from this 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_requestId :: Lens' ListUserGroupsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_status :: Lens' ListUserGroupsResponse 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_requestId :: Lens' UpdateDashboardPublishedVersionResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateDashboardPublishedVersionResponse_dashboardId :: Lens' UpdateDashboardPublishedVersionResponse (Maybe Text) Source #

The ID for the dashboard.

updateDashboardPublishedVersionResponse_dashboardArn :: Lens' UpdateDashboardPublishedVersionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dashboard.

updateDashboardPublishedVersionResponse_status :: Lens' UpdateDashboardPublishedVersionResponse 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_requestId :: Lens' DescribeAnalysisPermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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

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

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

The Amazon Resource Name (ARN) 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_status :: Lens' DescribeAnalysisPermissionsResponse 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_requestId :: Lens' DeleteTemplateAliasResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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

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

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

An ID for the template associated with the deletion.

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

The name for the template alias.

deleteTemplateAliasResponse_status :: Lens' DeleteTemplateAliasResponse 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.

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_requestId :: Lens' DescribeAnalysisResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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

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

describeAnalysisResponse_status :: Lens' DescribeAnalysisResponse Int Source #

The HTTP status of the request.

UpdateFolderPermissions

updateFolderPermissions_revokePermissions :: Lens' UpdateFolderPermissions (Maybe (NonEmpty ResourcePermission)) Source #

The permissions that you want to revoke from a resource.

updateFolderPermissions_grantPermissions :: Lens' UpdateFolderPermissions (Maybe (NonEmpty ResourcePermission)) Source #

The permissions that you want to grant on a resource.

updateFolderPermissions_awsAccountId :: Lens' UpdateFolderPermissions Text Source #

The AWS account ID.

updateFolderPermissions_folderId :: Lens' UpdateFolderPermissions Text Source #

The folder ID.

updateFolderPermissionsResponse_requestId :: Lens' UpdateFolderPermissionsResponse (Maybe Text) Source #

The request ID.

updateFolderPermissionsResponse_status :: Lens' UpdateFolderPermissionsResponse (Maybe Int) Source #

The status. If succeeded, the status is SC_OK.

updateFolderPermissionsResponse_arn :: Lens' UpdateFolderPermissionsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN).

updateFolderPermissionsResponse_folderId :: Lens' UpdateFolderPermissionsResponse (Maybe Text) Source #

The folder ID.

updateFolderPermissionsResponse_permissions :: Lens' UpdateFolderPermissionsResponse (Maybe (NonEmpty ResourcePermission)) Source #

Information about the permissions on the dashboard.

updateFolderPermissionsResponse_httpStatus :: Lens' UpdateFolderPermissionsResponse Int Source #

The response's http status code.

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_requestId :: Lens' DescribeDataSetResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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

Information on the dataset.

describeDataSetResponse_status :: Lens' DescribeDataSetResponse Int Source #

The HTTP status of the request.

ListNamespaces

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

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

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

The maximum number of results to return.

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_requestId :: Lens' ListNamespacesResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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 pagination token that can be used in a subsequent request.

listNamespacesResponse_status :: Lens' ListNamespacesResponse 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.

CreateFolder

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_name :: Lens' CreateFolder (Maybe Text) Source #

The name of the 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_folderType :: Lens' CreateFolder (Maybe FolderType) Source #

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

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

Tags for the folder.

createFolder_awsAccountId :: Lens' CreateFolder Text Source #

The AWS Account ID.

createFolder_folderId :: Lens' CreateFolder Text Source #

The folder ID.

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

The request ID for the newly created 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_status :: Lens' CreateFolderResponse Int Source #

The status of the newly created folder. If succeeded, the status is SC_OK (200).

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. Currently, you should set this to default.

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

The Amazon Web Services request ID for this operation.

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

The name of the group.

describeGroupResponse_status :: Lens' DescribeGroupResponse 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.

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.

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

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_requestId :: Lens' DescribeTemplatePermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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

The ID for the template.

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

The Amazon Resource Name (ARN) of the template.

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

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

describeTemplatePermissionsResponse_status :: Lens' DescribeTemplatePermissionsResponse Int Source #

The HTTP status of the request.

ListDashboards

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

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

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

The maximum number of results to be returned per request.

listDashboards_awsAccountId :: Lens' ListDashboards Text Source #

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

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

The Amazon Web Services request ID for this operation.

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

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

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_status :: Lens' ListDashboardsResponse 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.

DeleteFolderMembership

deleteFolderMembership_awsAccountId :: Lens' DeleteFolderMembership Text Source #

The AWS Account ID.

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 request ID.

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

The status of deleting the asset. If succeeded, the status is SC_OK (200).

deleteFolderMembershipResponse_httpStatus :: Lens' DeleteFolderMembershipResponse Int Source #

The response's http status code.

CreateTheme

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_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_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 a Amazon QuickSight analysis.

createTheme_configuration :: Lens' CreateTheme ThemeConfiguration Source #

The theme configuration, which contains the theme display properties.

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

ListUsers

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

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

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

The maximum number of results to return from this 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_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_nextToken :: Lens' ListUsersResponse (Maybe Text) Source #

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

listUsersResponse_status :: Lens' ListUsersResponse Int Source #

The HTTP status of the request.

CreateFolderMembership

createFolderMembership_awsAccountId :: Lens' CreateFolderMembership Text Source #

The AWS Account ID.

createFolderMembership_folderId :: Lens' CreateFolderMembership Text Source #

The folder ID.

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_requestId :: Lens' CreateFolderMembershipResponse (Maybe Text) Source #

The request ID.

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

The status of the folder membership. If succeeded, the status is SC_OK (200).

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

Information about the member in the folder.

createFolderMembershipResponse_httpStatus :: Lens' CreateFolderMembershipResponse Int Source #

The response's http status code.

UpdateThemePermissions

updateThemePermissions_revokePermissions :: Lens' UpdateThemePermissions (Maybe [ResourcePermission]) Source #

A list of resource permissions to be revoked from the theme.

updateThemePermissions_grantPermissions :: Lens' UpdateThemePermissions (Maybe [ResourcePermission]) Source #

A list of resource permissions to be granted for 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_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_permissions :: Lens' UpdateThemePermissionsResponse (Maybe (NonEmpty ResourcePermission)) Source #

The resulting list of resource permissions for the theme.

updateThemePermissionsResponse_status :: Lens' UpdateThemePermissionsResponse Int Source #

The HTTP status of the request.

GetSessionEmbedUrl

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

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

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_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:

  1. Active Directory (AD) users or group members
  2. Invited nonfederated users
  3. 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_requestId :: Lens' GetSessionEmbedUrlResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_status :: Lens' GetSessionEmbedUrlResponse Int Source #

The HTTP status of the request.

CreateDashboard

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_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_versionDescription :: Lens' CreateDashboard (Maybe Text) Source #

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

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 IAMaction information for each principal ARN.

To specify no permissions, omit the permissions list.

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_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 IAMpolicy.

createDashboard_name :: Lens' CreateDashboard Text Source #

The display name of the dashboard.

createDashboard_sourceEntity :: Lens' CreateDashboard 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.

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

The Amazon Web Services request ID for this operation.

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

RegisterUser

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

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

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 IAMpolicies. 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_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_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_iamArn :: Lens' RegisterUser (Maybe Text) Source #

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

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

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

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

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

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 IAMuser 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_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_user :: Lens' RegisterUserResponse (Maybe User) Source #

The user's user name.

registerUserResponse_status :: Lens' RegisterUserResponse 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_requestId :: Lens' DescribeDataSourceResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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

The information on the data source.

describeDataSourceResponse_status :: Lens' DescribeDataSourceResponse Int Source #

The HTTP status of the request.

DescribeFolderResolvedPermissions

describeFolderResolvedPermissions_awsAccountId :: Lens' DescribeFolderResolvedPermissions Text Source #

The AWS account ID.

describeFolderResolvedPermissions_folderId :: Lens' DescribeFolderResolvedPermissions Text Source #

The folder ID.

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

The request ID.

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

The Amazon Resource Name (ARN).

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

The folder ID.

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

Information about the permissions on the dashboard.

describeFolderResolvedPermissionsResponse_status :: Lens' DescribeFolderResolvedPermissionsResponse Int Source #

The status. If succeeded, the status is SC_OK

UpdateAnalysisPermissions

updateAnalysisPermissions_revokePermissions :: Lens' UpdateAnalysisPermissions (Maybe [ResourcePermission]) Source #

A structure that describes the permissions to remove and the principal to remove them from.

updateAnalysisPermissions_grantPermissions :: Lens' UpdateAnalysisPermissions (Maybe [ResourcePermission]) Source #

A structure that describes the permissions to add and the principal to add them to.

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_requestId :: Lens' UpdateAnalysisPermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateAnalysisPermissionsResponse_analysisId :: Lens' UpdateAnalysisPermissionsResponse (Maybe Text) Source #

The ID of the analysis that you updated permissions for.

updateAnalysisPermissionsResponse_analysisArn :: Lens' UpdateAnalysisPermissionsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the analysis that you updated.

updateAnalysisPermissionsResponse_permissions :: Lens' UpdateAnalysisPermissionsResponse (Maybe (NonEmpty ResourcePermission)) Source #

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

updateAnalysisPermissionsResponse_status :: Lens' UpdateAnalysisPermissionsResponse 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_requestId :: Lens' DeleteDataSetResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_status :: Lens' DeleteDataSetResponse Int Source #

The HTTP status of the request.

UpdateDataSet

updateDataSet_fieldFolders :: Lens' UpdateDataSet (Maybe (HashMap Text FieldFolder)) Source #

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

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_dataSetUsageConfiguration :: Lens' UpdateDataSet (Maybe DataSetUsageConfiguration) Source #

Undocumented member.

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_rowLevelPermissionDataSet :: Lens' UpdateDataSet (Maybe RowLevelPermissionDataSet) Source #

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

updateDataSet_columnLevelPermissionRules :: Lens' UpdateDataSet (Maybe (NonEmpty ColumnLevelPermissionRule)) Source #

A set of one or more definitions of a ColumnLevelPermissionRule .

updateDataSet_logicalTableMap :: Lens' UpdateDataSet (Maybe (HashMap Text LogicalTable)) Source #

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

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_requestId :: Lens' UpdateDataSetResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_arn :: Lens' UpdateDataSetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset.

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_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_status :: Lens' UpdateDataSetResponse Int Source #

The HTTP status of the request.

ListThemeAliases

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

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

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

The maximum number of results to be returned per request.

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_requestId :: Lens' ListThemeAliasesResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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

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

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.

UpdateAnalysis

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

updateAnalysis_sourceEntity :: Lens' UpdateAnalysis 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.

updateAnalysisResponse_requestId :: Lens' UpdateAnalysisResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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

DeleteAnalysis

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_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_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_requestId :: Lens' DeleteAnalysisResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_status :: Lens' DeleteAnalysisResponse Int Source #

The HTTP status of the request.

SearchFolders

searchFolders_nextToken :: Lens' SearchFolders (Maybe Text) Source #

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

searchFolders_maxResults :: Lens' SearchFolders (Maybe Natural) Source #

The maximum number of results to be returned per request.

searchFolders_awsAccountId :: Lens' SearchFolders Text Source #

The AWS account ID.

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_requestId :: Lens' SearchFoldersResponse (Maybe Text) Source #

The request ID.

searchFoldersResponse_nextToken :: Lens' SearchFoldersResponse (Maybe Text) Source #

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

searchFoldersResponse_folderSummaryList :: Lens' SearchFoldersResponse (Maybe [FolderSummary]) Source #

A structure that contains all of the folders in your AWS account. This structure provides basic information about the folders.

searchFoldersResponse_status :: Lens' SearchFoldersResponse Int Source #

The status. If succeeded, the status is SC_OK.

DescribeFolderPermissions

describeFolderPermissions_awsAccountId :: Lens' DescribeFolderPermissions Text Source #

The AWS Account ID.

describeFolderPermissions_folderId :: Lens' DescribeFolderPermissions Text Source #

The folder ID.

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

The request ID.

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

The Amazon Resource Name (ARN) for the folder.

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

The folder ID.

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

Information about the permissions on the folder.

describeFolderPermissionsResponse_status :: Lens' DescribeFolderPermissionsResponse Int Source #

The status. If succeeded, the status is SC_OK.

UpdateDataSetPermissions

updateDataSetPermissions_revokePermissions :: Lens' UpdateDataSetPermissions (Maybe (NonEmpty ResourcePermission)) Source #

The resource permissions that you want to revoke from the dataset.

updateDataSetPermissions_grantPermissions :: Lens' UpdateDataSetPermissions (Maybe (NonEmpty ResourcePermission)) Source #

The resource permissions that you want to grant to 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_requestId :: Lens' UpdateDataSetPermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_status :: Lens' UpdateDataSetPermissionsResponse 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.

DescribeFolder

describeFolder_awsAccountId :: Lens' DescribeFolder Text Source #

The AWS account ID.

describeFolder_folderId :: Lens' DescribeFolder Text Source #

The folder ID.

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

The request ID.

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

Information about the folder.

describeFolderResponse_status :: Lens' DescribeFolderResponse Int Source #

The status. If succeeded, the status is SC_OK (200).

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.

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_requestId :: Lens' DescribeIAMPolicyAssignmentResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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

Information describing the IAMpolicy assignment.

describeIAMPolicyAssignmentResponse_status :: Lens' DescribeIAMPolicyAssignmentResponse 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_requestId :: Lens' CreateIngestionResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_status :: Lens' CreateIngestionResponse Int Source #

The HTTP status of the request.

CreateDataSet

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

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

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_dataSetUsageConfiguration :: Lens' CreateDataSet (Maybe DataSetUsageConfiguration) Source #

Undocumented member.

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_rowLevelPermissionDataSet :: Lens' CreateDataSet (Maybe RowLevelPermissionDataSet) Source #

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

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

A list of resource permissions on the dataset.

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

A set of one or more definitions of a ColumnLevelPermissionRule .

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_logicalTableMap :: Lens' CreateDataSet (Maybe (HashMap Text LogicalTable)) Source #

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

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_requestId :: Lens' CreateDataSetResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_arn :: Lens' CreateDataSetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset.

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_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_status :: Lens' CreateDataSetResponse Int Source #

The HTTP status of the request.

CreateDataSource

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

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

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

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

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_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_permissions :: Lens' CreateDataSource (Maybe (NonEmpty ResourcePermission)) Source #

A list of resource permissions on the data 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_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_requestId :: Lens' CreateDataSourceResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_status :: Lens' CreateDataSourceResponse Int Source #

The HTTP status of the request.

ListTemplates

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

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

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

The maximum number of results to be returned per request.

listTemplates_awsAccountId :: Lens' ListTemplates Text Source #

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

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_nextToken :: Lens' ListTemplatesResponse (Maybe Text) Source #

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

listTemplatesResponse_status :: Lens' ListTemplatesResponse 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_requestId :: Lens' DescribeAccountSettingsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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 Amazon QuickSight console, the Amazon QuickSight subscription is sometimes referred to as a Amazon 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_status :: Lens' DescribeAccountSettingsResponse Int Source #

The HTTP status of the request.

UpdateTemplate

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_name :: Lens' UpdateTemplate (Maybe Text) Source #

The name for the template.

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.

updateTemplate_sourceEntity :: Lens' UpdateTemplate 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.

updateTemplateResponse_requestId :: Lens' UpdateTemplateResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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

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_requestId :: Lens' DeleteTemplateResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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

The Amazon Resource Name (ARN) of the resource.

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

An ID for the template.

deleteTemplateResponse_status :: Lens' DeleteTemplateResponse Int Source #

The HTTP status of the request.

UpdateTemplatePermissions

updateTemplatePermissions_revokePermissions :: Lens' UpdateTemplatePermissions (Maybe [ResourcePermission]) Source #

A list of resource permissions to be revoked from the template.

updateTemplatePermissions_grantPermissions :: Lens' UpdateTemplatePermissions (Maybe [ResourcePermission]) Source #

A list of resource permissions to be granted on 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_requestId :: Lens' UpdateTemplatePermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateTemplatePermissionsResponse_templateId :: Lens' UpdateTemplatePermissionsResponse (Maybe Text) Source #

The ID for the template.

updateTemplatePermissionsResponse_templateArn :: Lens' UpdateTemplatePermissionsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the template.

updateTemplatePermissionsResponse_permissions :: Lens' UpdateTemplatePermissionsResponse (Maybe (NonEmpty ResourcePermission)) Source #

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

updateTemplatePermissionsResponse_status :: Lens' UpdateTemplatePermissionsResponse Int Source #

The HTTP status of the request.

SearchDashboards

searchDashboards_nextToken :: Lens' SearchDashboards (Maybe Text) Source #

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

searchDashboards_maxResults :: Lens' SearchDashboards (Maybe Natural) Source #

The maximum number of results to be returned per request.

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_requestId :: Lens' SearchDashboardsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

searchDashboardsResponse_nextToken :: Lens' SearchDashboardsResponse (Maybe Text) Source #

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

searchDashboardsResponse_dashboardSummaryList :: Lens' SearchDashboardsResponse (Maybe [DashboardSummary]) Source #

The list of dashboards owned by the user specified in Filters in your request.

searchDashboardsResponse_status :: Lens' SearchDashboardsResponse Int Source #

The HTTP status of the request.

UpdateDataSourcePermissions

updateDataSourcePermissions_revokePermissions :: Lens' UpdateDataSourcePermissions (Maybe (NonEmpty ResourcePermission)) Source #

A list of resource permissions that you want to revoke on the data source.

updateDataSourcePermissions_grantPermissions :: Lens' UpdateDataSourcePermissions (Maybe (NonEmpty ResourcePermission)) Source #

A list of resource permissions that you want to grant 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_requestId :: Lens' UpdateDataSourcePermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_dataSourceArn :: Lens' UpdateDataSourcePermissionsResponse (Maybe Text) Source #

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

updateDataSourcePermissionsResponse_status :: Lens' UpdateDataSourcePermissionsResponse Int Source #

The HTTP status of the request.

UpdateIpRestriction

updateIpRestriction_ipRestrictionRuleMap :: Lens' UpdateIpRestriction (Maybe (HashMap Text Text)) Source #

Describes updated IP rules.

updateIpRestriction_enabled :: Lens' UpdateIpRestriction (Maybe Bool) Source #

Whether or not IP rules are enabled.

updateIpRestriction_awsAccountId :: Lens' UpdateIpRestriction Text Source #

Your AWS account ID.

updateIpRestrictionResponse_requestId :: Lens' UpdateIpRestrictionResponse (Maybe Text) Source #

The ID of the update request.

updateIpRestrictionResponse_awsAccountId :: Lens' UpdateIpRestrictionResponse (Maybe Text) Source #

Your AWS account ID.

updateIpRestrictionResponse_status :: Lens' UpdateIpRestrictionResponse Int Source #

The status of the updated IP rules. A successful request returns a 200 code.

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.

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.

ListAnalyses

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

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

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

The maximum number of results to return.

listAnalyses_awsAccountId :: Lens' ListAnalyses Text Source #

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

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

The Amazon Web Services request ID for this operation.

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

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

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

Metadata describing each of the analyses that are listed.

listAnalysesResponse_status :: Lens' ListAnalysesResponse Int Source #

The HTTP status of the request.

ListDataSources

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

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

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

The maximum number of results to be returned per request.

listDataSources_awsAccountId :: Lens' ListDataSources Text Source #

The Amazon Web Services account ID.

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

The Amazon Web Services request ID for this operation.

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_status :: Lens' ListDataSourcesResponse Int Source #

The HTTP status of the request.

ListFolderMembers

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

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

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

The maximum number of results to be returned per request.

listFolderMembers_awsAccountId :: Lens' ListFolderMembers Text Source #

The AWS account ID.

listFolderMembers_folderId :: Lens' ListFolderMembers Text Source #

The folder ID.

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

The request ID.

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_status :: Lens' ListFolderMembersResponse Int Source #

The status. If succeeded, the status is SC_OK

ListIAMPolicyAssignments

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

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

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_awsAccountId :: Lens' ListIAMPolicyAssignments Text Source #

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

listIAMPolicyAssignments_namespace :: Lens' ListIAMPolicyAssignments Text Source #

The namespace for the assignments.

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

The Amazon Web Services request ID for this operation.

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

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

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

Information describing the IAMpolicy assignments.

listIAMPolicyAssignmentsResponse_status :: Lens' ListIAMPolicyAssignmentsResponse Int Source #

The HTTP status of the request.

ListDashboardVersions

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

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

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

The maximum number of results to be returned per request.

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_requestId :: Lens' ListDashboardVersionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_status :: Lens' ListDashboardVersionsResponse 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_requestId :: Lens' CreateNamespaceResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_arn :: Lens' CreateNamespaceResponse (Maybe Text) Source #

The ARN of the Amazon QuickSight namespace you created.

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_name :: Lens' CreateNamespaceResponse (Maybe Text) Source #

The name of the new namespace that you created.

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_status :: Lens' CreateNamespaceResponse Int Source #

The HTTP status of the request.

CreateIAMPolicyAssignment

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

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

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_awsAccountId :: Lens' CreateIAMPolicyAssignment Text Source #

The ID of the Amazon Web Services account where you want to assign an IAMpolicy 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_requestId :: Lens' CreateIAMPolicyAssignmentResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_policyArn :: Lens' CreateIAMPolicyAssignmentResponse (Maybe Text) Source #

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

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

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

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

The ID for the assignment.

createIAMPolicyAssignmentResponse_status :: Lens' CreateIAMPolicyAssignmentResponse 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_requestId :: Lens' RestoreAnalysisResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_status :: Lens' RestoreAnalysisResponse 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.

ListTemplateAliases

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

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

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

The maximum number of results to be returned per request.

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_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_nextToken :: Lens' ListTemplateAliasesResponse (Maybe Text) Source #

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

listTemplateAliasesResponse_status :: Lens' ListTemplateAliasesResponse Int Source #

The HTTP status of the request.

GetDashboardEmbedUrl

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_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_additionalDashboardIds :: Lens' GetDashboardEmbedUrl (Maybe (NonEmpty Text)) Source #

A list of one or more dashboard IDs that you want to add to a session that includes anonymous users. The IdentityType parameter must be set to ANONYMOUS for this to work, because other identity types authenticate as Amazon QuickSight or IAMusers. 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_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
  • IAMusers and IAMrole-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAMfederation.

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

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_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_requestId :: Lens' GetDashboardEmbedUrlResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_status :: Lens' GetDashboardEmbedUrlResponse Int Source #

The HTTP status of the request.

GenerateEmbedUrlForAnonymousUser

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

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

generateEmbedUrlForAnonymousUser_experienceConfiguration :: Lens' GenerateEmbedUrlForAnonymousUser AnonymousUserEmbeddingExperienceConfiguration Source #

The configuration of the experience 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.

ListThemeVersions

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

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

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

The maximum number of results to be returned per request.

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_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_nextToken :: Lens' ListThemeVersionsResponse (Maybe Text) Source #

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

listThemeVersionsResponse_status :: Lens' ListThemeVersionsResponse Int Source #

The HTTP status of the request.

UpdateDashboardPermissions

updateDashboardPermissions_revokePermissions :: Lens' UpdateDashboardPermissions (Maybe [ResourcePermission]) Source #

The permissions that you want to revoke from this resource.

updateDashboardPermissions_grantPermissions :: Lens' UpdateDashboardPermissions (Maybe [ResourcePermission]) Source #

The permissions that you want to grant on 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_requestId :: Lens' UpdateDashboardPermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateDashboardPermissionsResponse_dashboardId :: Lens' UpdateDashboardPermissionsResponse (Maybe Text) Source #

The ID for the dashboard.

updateDashboardPermissionsResponse_permissions :: Lens' UpdateDashboardPermissionsResponse (Maybe (NonEmpty ResourcePermission)) Source #

Information about the permissions on the dashboard.

updateDashboardPermissionsResponse_dashboardArn :: Lens' UpdateDashboardPermissionsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dashboard.

updateDashboardPermissionsResponse_status :: Lens' UpdateDashboardPermissionsResponse Int Source #

The HTTP status of the request.

ListIAMPolicyAssignmentsForUser

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

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

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

The maximum number of results to be returned per request.

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_requestId :: Lens' ListIAMPolicyAssignmentsForUserResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_status :: Lens' ListIAMPolicyAssignmentsForUserResponse 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.

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_requestId :: Lens' UpdateAccountCustomizationResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_namespace :: Lens' UpdateAccountCustomizationResponse (Maybe Text) Source #

The namespace associated with the customization that you're updating.

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_status :: Lens' UpdateAccountCustomizationResponse 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_requestId :: Lens' DeleteDashboardResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_status :: Lens' DeleteDashboardResponse Int Source #

The HTTP status of the request.

UpdateDashboard

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_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_versionDescription :: Lens' UpdateDashboard (Maybe Text) Source #

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

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

updateDashboard_sourceEntity :: Lens' UpdateDashboard 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.

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

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_requestId :: Lens' DescribeDataSourcePermissionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_dataSourceArn :: Lens' DescribeDataSourcePermissionsResponse (Maybe Text) Source #

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

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

A list of resource permissions on the data source.

describeDataSourcePermissionsResponse_status :: Lens' DescribeDataSourcePermissionsResponse Int Source #

The HTTP status of the request.

UpdateUser

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_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 IAMpolicies. 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_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_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 DescribeUser API 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_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.

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.

SearchAnalyses

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

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

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

The maximum number of results to return.

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_requestId :: Lens' SearchAnalysesResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

searchAnalysesResponse_nextToken :: Lens' SearchAnalysesResponse (Maybe Text) Source #

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

searchAnalysesResponse_analysisSummaryList :: Lens' SearchAnalysesResponse (Maybe [AnalysisSummary]) Source #

Metadata describing the analyses that you searched for.

searchAnalysesResponse_status :: Lens' SearchAnalysesResponse 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 Amazon 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_requestId :: Lens' CreateAccountCustomizationResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_namespace :: Lens' CreateAccountCustomizationResponse (Maybe Text) Source #

The namespace associated with the customization you're creating.

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

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

createAccountCustomizationResponse_status :: Lens' CreateAccountCustomizationResponse Int Source #

The HTTP status of the request.

DescribeIpRestriction

describeIpRestriction_awsAccountId :: Lens' DescribeIpRestriction Text Source #

Your AWS account ID.

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

The ID of the describe request.

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

Describes the IP rules with CIDR range and description.

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

Whether or not IP rules are enabled.

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

Your AWS account ID.

describeIpRestrictionResponse_status :: Lens' DescribeIpRestrictionResponse Int Source #

The status of a set of IP restrictions. A successful request returns a 200 status code.

ListThemes

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_maxResults :: Lens' ListThemes (Maybe Natural) Source #

The maximum number of results to be returned per request.

listThemes_awsAccountId :: Lens' ListThemes Text Source #

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

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_nextToken :: Lens' ListThemesResponse (Maybe Text) Source #

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

listThemesResponse_status :: Lens' ListThemesResponse 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.

UpdateTheme

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_name :: Lens' UpdateTheme (Maybe Text) Source #

The name for the theme.

updateTheme_configuration :: Lens' UpdateTheme (Maybe ThemeConfiguration) Source #

The theme configuration, which contains the theme display properties.

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

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_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_arn :: Lens' DeleteThemeResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource.

deleteThemeResponse_status :: Lens' DeleteThemeResponse Int Source #

The HTTP status of the request.

ListIngestions

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

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

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

The maximum number of results to be returned per request.

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_requestId :: Lens' ListIngestionsResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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

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

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

A list of the ingestions.

listIngestionsResponse_status :: Lens' ListIngestionsResponse Int Source #

The HTTP status of the request.

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. Currently, you should set this to default.

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

The Amazon Web Services request ID for this operation.

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

The name of the group.

createGroupResponse_status :: Lens' CreateGroupResponse 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.

ListTemplateVersions

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

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

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

The maximum number of results to be returned per request.

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_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_nextToken :: Lens' ListTemplateVersionsResponse (Maybe Text) Source #

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

listTemplateVersionsResponse_status :: Lens' ListTemplateVersionsResponse Int Source #

The HTTP status of the request.

ListDataSets

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

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

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

The maximum number of results to be returned per request.

listDataSets_awsAccountId :: Lens' ListDataSets Text Source #

The Amazon Web Services account ID.

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

The Amazon Web Services request ID for this operation.

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

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

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

The list of dataset summaries.

listDataSetsResponse_status :: Lens' ListDataSetsResponse 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_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_arn :: Lens' DeleteThemeAliasResponse (Maybe Text) Source #

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

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

The name for the theme alias.

deleteThemeAliasResponse_status :: Lens' DeleteThemeAliasResponse 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.

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. Currently, you should set this to default.

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.

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. Currently, you should set this to default.

updateGroupResponse_requestId :: Lens' UpdateGroupResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

updateGroupResponse_group :: Lens' UpdateGroupResponse (Maybe Group) Source #

The name of the group.

updateGroupResponse_status :: Lens' UpdateGroupResponse 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_requestId :: Lens' DescribeNamespaceResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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_status :: Lens' DescribeNamespaceResponse Int Source #

The HTTP status of the request.

ListGroups

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

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

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

The maximum number of results to return.

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. Currently, you should set this to default.

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

The Amazon Web Services request ID for this operation.

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_status :: Lens' ListGroupsResponse Int Source #

The HTTP status of the request.

CreateAnalysis

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

createAnalysis_sourceEntity :: Lens' CreateAnalysis 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.

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

The Amazon Web Services request ID for this operation.

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_status :: Lens' CreateAnalysisResponse Int Source #

The HTTP status of the request.

DescribeAccountCustomization

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_namespace :: Lens' DescribeAccountCustomization (Maybe Text) Source #

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

describeAccountCustomization_awsAccountId :: Lens' DescribeAccountCustomization Text Source #

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

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

The Amazon Web Services request ID for this operation.

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_namespace :: Lens' DescribeAccountCustomizationResponse (Maybe Text) Source #

The Amazon QuickSight namespace that you're describing.

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

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

describeAccountCustomizationResponse_status :: Lens' DescribeAccountCustomizationResponse Int Source #

The HTTP status of the request.

GenerateEmbedUrlForRegisteredUser

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, the entire Amazon QuickSight console, or the Amazon QuickSight Q search bar.

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, console, or Q search bar.

generateEmbedUrlForRegisteredUserResponse_requestId :: Lens' GenerateEmbedUrlForRegisteredUserResponse Text Source #

The Amazon Web Services request ID for this operation.

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_requestId :: Lens' DescribeDashboardResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

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

Information about the dashboard.

describeDashboardResponse_status :: Lens' DescribeDashboardResponse Int Source #

The HTTP status of this 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. Currently, you should set this to default.

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

The Amazon Web Services request ID for this operation.

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

The group member.

createGroupMembershipResponse_status :: Lens' CreateGroupMembershipResponse 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 IAMpolicy.

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

The Amazon Web Services request ID for this operation.

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

The ID for the dashboard.

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

A structure that contains the permissions for the dashboard.

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

The Amazon Resource Name (ARN) of the dashboard.

describeDashboardPermissionsResponse_status :: Lens' DescribeDashboardPermissionsResponse Int Source #

The HTTP status of the request.

Types

AccountCustomization

accountCustomization_defaultTheme :: Lens' AccountCustomization (Maybe Text) Source #

The default theme for this Amazon QuickSight subscription.

AccountSettings

accountSettings_edition :: Lens' AccountSettings (Maybe Edition) Source #

The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.

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_notificationEmail :: Lens' AccountSettings (Maybe Text) Source #

The main notification email for your Amazon QuickSight subscription.

ActiveIAMPolicyAssignment

activeIAMPolicyAssignment_assignmentName :: Lens' ActiveIAMPolicyAssignment (Maybe Text) Source #

A name for the IAMpolicy 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.

AmazonElasticsearchParameters

amazonElasticsearchParameters_domain :: Lens' AmazonElasticsearchParameters Text Source #

The OpenSearch domain.

AmazonOpenSearchParameters

amazonOpenSearchParameters_domain :: Lens' AmazonOpenSearchParameters Text Source #

Undocumented member.

Analysis

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.

analysis_dataSetArns :: Lens' Analysis (Maybe [Text]) Source #

The ARNs of the datasets 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_analysisId :: Lens' Analysis (Maybe Text) Source #

The ID of the analysis.

analysis_lastUpdatedTime :: Lens' Analysis (Maybe UTCTime) Source #

The time that the analysis was last updated.

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_name :: Lens' Analysis (Maybe Text) Source #

The descriptive name of the analysis.

analysis_errors :: Lens' Analysis (Maybe (NonEmpty AnalysisError)) Source #

Errors associated with the analysis.

AnalysisError

analysisError_type :: Lens' AnalysisError (Maybe AnalysisErrorType) Source #

The type of the analysis error.

analysisError_message :: Lens' AnalysisError (Maybe Text) Source #

The message associated with the analysis error.

AnalysisSearchFilter

analysisSearchFilter_operator :: Lens' AnalysisSearchFilter (Maybe FilterOperator) Source #

The comparison operator that you want to use as a filter, for example "Operator": "StringEquals".

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

analysisSearchFilter_name :: Lens' AnalysisSearchFilter (Maybe AnalysisFilterAttribute) Source #

The name of the value that you want to use as a filter, for example "Name": "QUICKSIGHT_USER".

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_status :: Lens' AnalysisSummary (Maybe ResourceStatus) Source #

The last known status for the analysis.

analysisSummary_analysisId :: Lens' AnalysisSummary (Maybe Text) Source #

The ID of the analysis. This ID displays in the URL.

analysisSummary_lastUpdatedTime :: Lens' AnalysisSummary (Maybe UTCTime) Source #

The time that the analysis was last updated.

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_name :: Lens' AnalysisSummary (Maybe Text) Source #

The name of the analysis. This name is displayed in the Amazon QuickSight console.

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.

AnonymousUserEmbeddingExperienceConfiguration

anonymousUserEmbeddingExperienceConfiguration_dashboard :: Lens' AnonymousUserEmbeddingExperienceConfiguration (Maybe AnonymousUserDashboardEmbeddingConfiguration) Source #

The type of embedding experience. In this case, an Amazon QuickSight dashboard.

AthenaParameters

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.

BorderStyle

borderStyle_show :: Lens' BorderStyle (Maybe Bool) Source #

The option to enable display of borders for visuals.

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.

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.

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.

ColumnLevelPermissionRule

columnLevelPermissionRule_principals :: Lens' ColumnLevelPermissionRule (Maybe (NonEmpty Text)) Source #

An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.

columnLevelPermissionRule_columnNames :: Lens' ColumnLevelPermissionRule (Maybe (NonEmpty Text)) Source #

An array of column names.

ColumnSchema

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.

columnSchema_dataType :: Lens' ColumnSchema (Maybe Text) Source #

The data type of the column schema.

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.

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.

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.

Dashboard

dashboard_lastUpdatedTime :: Lens' Dashboard (Maybe UTCTime) Source #

The last time that this dataset was updated.

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 dataset was created.

dashboard_dashboardId :: Lens' Dashboard (Maybe Text) Source #

Dashboard ID.

dashboard_lastPublishedTime :: Lens' Dashboard (Maybe UTCTime) Source #

The last time that this dataset was published.

dashboard_name :: Lens' Dashboard (Maybe Text) Source #

A display name for the dashboard.

dashboard_version :: Lens' Dashboard (Maybe DashboardVersion) Source #

Version.

DashboardError

dashboardError_type :: Lens' DashboardError (Maybe DashboardErrorType) Source #

Type.

dashboardError_message :: Lens' DashboardError (Maybe Text) Source #

Message.

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.

DashboardSearchFilter

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_name :: Lens' DashboardSearchFilter (Maybe DashboardFilterAttribute) Source #

The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_USER".

dashboardSearchFilter_operator :: Lens' DashboardSearchFilter FilterOperator Source #

The comparison operator that you want to use as a filter, for example, "Operator": "StringEquals".

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_lastUpdatedTime :: Lens' DashboardSummary (Maybe UTCTime) Source #

The last time that this dashboard was updated.

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_publishedVersionNumber :: Lens' DashboardSummary (Maybe Natural) Source #

Published version number.

dashboardSummary_lastPublishedTime :: Lens' DashboardSummary (Maybe UTCTime) Source #

The last time that this dashboard was published.

dashboardSummary_name :: Lens' DashboardSummary (Maybe Text) Source #

A display name for the dashboard.

DashboardVersion

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_dataSetArns :: Lens' DashboardVersion (Maybe [Text]) Source #

The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard.

dashboardVersion_sheets :: Lens' DashboardVersion (Maybe [Sheet]) Source #

A list of the associated sheets with the unique identifier and name of each sheet.

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_sourceEntityArn :: Lens' DashboardVersion (Maybe Text) Source #

Source entity ARN.

dashboardVersion_versionNumber :: Lens' DashboardVersion (Maybe Natural) Source #

Version number for this version of the dashboard.

dashboardVersion_errors :: Lens' DashboardVersion (Maybe (NonEmpty DashboardError)) Source #

Errors associated with this dashboard version.

dashboardVersion_description :: Lens' DashboardVersion (Maybe Text) Source #

Description.

DashboardVersionSummary

dashboardVersionSummary_status :: Lens' DashboardVersionSummary (Maybe ResourceStatus) Source #

The HTTP status of the request.

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_sourceEntityArn :: Lens' DashboardVersionSummary (Maybe Text) Source #

Source entity ARN.

dashboardVersionSummary_versionNumber :: Lens' DashboardVersionSummary (Maybe Natural) Source #

Version number.

dashboardVersionSummary_description :: Lens' DashboardVersionSummary (Maybe Text) Source #

Description.

DataColorPalette

dataColorPalette_minMaxGradient :: Lens' DataColorPalette (Maybe [Text]) Source #

The minimum and maximum hexadecimal codes that describe a color gradient.

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_colors :: Lens' DataColorPalette (Maybe [Text]) Source #

The hexadecimal codes for the colors.

DataSet

dataSet_fieldFolders :: Lens' DataSet (Maybe (HashMap Text FieldFolder)) Source #

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

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_lastUpdatedTime :: Lens' DataSet (Maybe UTCTime) Source #

The last time that this dataset was updated.

dataSet_arn :: Lens' DataSet (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource.

dataSet_createdTime :: Lens' DataSet (Maybe UTCTime) Source #

The time that this dataset was created.

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_importMode :: Lens' DataSet (Maybe DataSetImportMode) Source #

A value that indicates whether you want to import the data into SPICE.

dataSet_physicalTableMap :: Lens' DataSet (Maybe (HashMap Text PhysicalTable)) Source #

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

dataSet_dataSetId :: Lens' DataSet (Maybe Text) Source #

The ID of the dataset.

dataSet_name :: Lens' DataSet (Maybe Text) Source #

A display name for 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_outputColumns :: Lens' DataSet (Maybe [OutputColumn]) Source #

The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.

dataSet_rowLevelPermissionTagConfiguration :: Lens' DataSet (Maybe RowLevelPermissionTagConfiguration) Source #

The element you can use to define tags for row-level security.

dataSet_rowLevelPermissionDataSet :: Lens' DataSet (Maybe RowLevelPermissionDataSet) Source #

The row-level security configuration for the dataset.

dataSet_columnLevelPermissionRules :: Lens' DataSet (Maybe (NonEmpty ColumnLevelPermissionRule)) Source #

A set of one or more definitions of a ColumnLevelPermissionRule .

dataSet_logicalTableMap :: Lens' DataSet (Maybe (HashMap Text LogicalTable)) Source #

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

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.

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.

DataSetSummary

dataSetSummary_lastUpdatedTime :: Lens' DataSetSummary (Maybe UTCTime) Source #

The last time that this dataset was updated.

dataSetSummary_arn :: Lens' DataSetSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the dataset.

dataSetSummary_createdTime :: Lens' DataSetSummary (Maybe UTCTime) Source #

The time that this dataset was created.

dataSetSummary_rowLevelPermissionTagConfigurationApplied :: Lens' DataSetSummary (Maybe Bool) Source #

Whether or not the row level permission tags are applied.

dataSetSummary_columnLevelPermissionRulesApplied :: Lens' DataSetSummary (Maybe Bool) Source #

A value that indicates if the dataset has column level permission configured.

dataSetSummary_importMode :: Lens' DataSetSummary (Maybe DataSetImportMode) Source #

A value that indicates whether you want to import the data into SPICE.

dataSetSummary_dataSetId :: Lens' DataSetSummary (Maybe Text) Source #

The ID of the dataset.

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.

DataSetUsageConfiguration

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.

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.

DataSource

dataSource_status :: Lens' DataSource (Maybe ResourceStatus) Source #

The HTTP status of the request.

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_lastUpdatedTime :: Lens' DataSource (Maybe UTCTime) Source #

The last time that this data source was updated.

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_sslProperties :: Lens' DataSource (Maybe SslProperties) Source #

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

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_name :: Lens' DataSource (Maybe Text) Source #

A display name for the data source.

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

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_errorInfo :: Lens' DataSource (Maybe DataSourceErrorInfo) Source #

Error information from the last update or the creation of the data 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.

DataSourceErrorInfo

dataSourceErrorInfo_type :: Lens' DataSourceErrorInfo (Maybe DataSourceErrorInfoType) Source #

Error type.

dataSourceErrorInfo_message :: Lens' DataSourceErrorInfo (Maybe Text) Source #

Error message.

DataSourceParameters

dataSourceParameters_rdsParameters :: Lens' DataSourceParameters (Maybe RdsParameters) Source #

The parameters for Amazon RDS.

dataSourceParameters_s3Parameters :: Lens' DataSourceParameters (Maybe S3Parameters) Source #

The parameters for S3.

dataSourceParameters_athenaParameters :: Lens' DataSourceParameters (Maybe AthenaParameters) Source #

The parameters for Amazon Athena.

dataSourceParameters_teradataParameters :: Lens' DataSourceParameters (Maybe TeradataParameters) Source #

The parameters for Teradata.

dataSourceParameters_auroraParameters :: Lens' DataSourceParameters (Maybe AuroraParameters) Source #

The parameters for Amazon Aurora MySQL.

dataSourceParameters_awsIotAnalyticsParameters :: Lens' DataSourceParameters (Maybe AwsIotAnalyticsParameters) Source #

The parameters for IoT Analytics.

dataSourceParameters_amazonOpenSearchParameters :: Lens' DataSourceParameters (Maybe AmazonOpenSearchParameters) Source #

Undocumented member.

dataSourceParameters_sqlServerParameters :: Lens' DataSourceParameters (Maybe SqlServerParameters) Source #

The parameters for SQL Server.

dataSourceParameters_redshiftParameters :: Lens' DataSourceParameters (Maybe RedshiftParameters) Source #

The parameters for Amazon Redshift.

dataSourceParameters_postgreSqlParameters :: Lens' DataSourceParameters (Maybe PostgreSqlParameters) Source #

The parameters for PostgreSQL.

dataSourceParameters_oracleParameters :: Lens' DataSourceParameters (Maybe OracleParameters) Source #

The parameters for Oracle.

dataSourceParameters_amazonElasticsearchParameters :: Lens' DataSourceParameters (Maybe AmazonElasticsearchParameters) Source #

The parameters for OpenSearch.

dataSourceParameters_twitterParameters :: Lens' DataSourceParameters (Maybe TwitterParameters) Source #

The parameters for Twitter.

dataSourceParameters_mariaDbParameters :: Lens' DataSourceParameters (Maybe MariaDbParameters) Source #

The parameters for MariaDB.

dataSourceParameters_jiraParameters :: Lens' DataSourceParameters (Maybe JiraParameters) Source #

The parameters for Jira.

dataSourceParameters_snowflakeParameters :: Lens' DataSourceParameters (Maybe SnowflakeParameters) Source #

The parameters for Snowflake.

dataSourceParameters_prestoParameters :: Lens' DataSourceParameters (Maybe PrestoParameters) Source #

The parameters for Presto.

dataSourceParameters_mySqlParameters :: Lens' DataSourceParameters (Maybe MySqlParameters) Source #

The parameters for MySQL.

dataSourceParameters_auroraPostgreSqlParameters :: Lens' DataSourceParameters (Maybe AuroraPostgreSqlParameters) Source #

The parameters for Amazon Aurora.

dataSourceParameters_sparkParameters :: Lens' DataSourceParameters (Maybe SparkParameters) Source #

The parameters for Spark.

dataSourceParameters_serviceNowParameters :: Lens' DataSourceParameters (Maybe ServiceNowParameters) Source #

The parameters for ServiceNow.

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.

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.

ErrorInfo

errorInfo_type :: Lens' ErrorInfo (Maybe IngestionErrorType) Source #

Error type.

errorInfo_message :: Lens' ErrorInfo (Maybe Text) Source #

Error message.

ExportToCSVOption

exportToCSVOption_availabilityStatus :: Lens' ExportToCSVOption (Maybe DashboardBehavior) Source #

Availability status.

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.

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.

Folder

folder_lastUpdatedTime :: Lens' Folder (Maybe UTCTime) Source #

The time that the folder was last updated.

folder_arn :: Lens' Folder (Maybe Text) Source #

The folder Amazon Resource Name (ARN).

folder_createdTime :: Lens' Folder (Maybe UTCTime) Source #

The time that the folder was created.

folder_folderId :: Lens' Folder (Maybe Text) Source #

The folder ID.

folder_name :: Lens' Folder (Maybe Text) Source #

A display name for the folder.

folder_folderPath :: Lens' Folder (Maybe (NonEmpty Text)) Source #

An array of ancestor folder ARN strings.

folder_folderType :: Lens' Folder (Maybe FolderType) Source #

The type of the folder.

FolderMember

folderMember_memberId :: Lens' FolderMember (Maybe Text) Source #

The ID of the asset.

folderMember_memberType :: Lens' FolderMember (Maybe MemberType) Source #

The type of the asset.

FolderSearchFilter

folderSearchFilter_operator :: Lens' FolderSearchFilter (Maybe FilterOperator) Source #

The comparison operator that you want to use as a filter. For example, "Operator": "StringEquals".

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

folderSearchFilter_name :: Lens' FolderSearchFilter (Maybe FolderFilterAttribute) Source #

The name of the value that you want to use as a filter. For example, "Name": "PARENT_FOLDER_ARN".

FolderSummary

folderSummary_lastUpdatedTime :: Lens' FolderSummary (Maybe UTCTime) Source #

The time that the folder was last updated.

folderSummary_arn :: Lens' FolderSummary (Maybe Text) Source #

The Amazon Resource Name (ARN).

folderSummary_createdTime :: Lens' FolderSummary (Maybe UTCTime) Source #

The time that the folder was created.

folderSummary_folderId :: Lens' FolderSummary (Maybe Text) Source #

The folder ID.

folderSummary_name :: Lens' FolderSummary (Maybe Text) Source #

The display name of the folder.

folderSummary_folderType :: Lens' FolderSummary (Maybe FolderType) Source #

The type of folder.

GeoSpatialColumnGroup

geoSpatialColumnGroup_name :: Lens' GeoSpatialColumnGroup Text Source #

A display name for the hierarchy.

geoSpatialColumnGroup_countryCode :: Lens' GeoSpatialColumnGroup GeoSpatialCountryCode Source #

Country code.

geoSpatialColumnGroup_columns :: Lens' GeoSpatialColumnGroup (NonEmpty Text) Source #

Columns in this hierarchy.

Group

group_principalId :: Lens' Group (Maybe Text) Source #

The principal ID of the group.

group_arn :: Lens' Group (Maybe Text) Source #

The Amazon Resource Name (ARN) for the group.

group_groupName :: Lens' Group (Maybe Text) Source #

The name of the group.

group_description :: Lens' Group (Maybe Text) Source #

The group description.

GroupMember

groupMember_memberName :: Lens' GroupMember (Maybe Text) Source #

The name of the group member (user).

groupMember_arn :: Lens' GroupMember (Maybe Text) Source #

The Amazon Resource Name (ARN) for the group member (user).

GutterStyle

gutterStyle_show :: Lens' GutterStyle (Maybe Bool) Source #

This Boolean value controls whether to display a gutter space between sheet tiles.

IAMPolicyAssignment

iAMPolicyAssignment_assignmentName :: Lens' IAMPolicyAssignment (Maybe Text) Source #

Assignment name.

iAMPolicyAssignment_awsAccountId :: Lens' IAMPolicyAssignment (Maybe Text) Source #

The Amazon Web Services account ID.

iAMPolicyAssignment_assignmentStatus :: Lens' IAMPolicyAssignment (Maybe AssignmentStatus) Source #

Assignment status.

iAMPolicyAssignment_policyArn :: Lens' IAMPolicyAssignment (Maybe Text) Source #

The Amazon Resource Name (ARN) for the IAMpolicy.

iAMPolicyAssignment_identities :: Lens' IAMPolicyAssignment (Maybe (HashMap Text [Text])) Source #

Identities.

iAMPolicyAssignment_assignmentId :: Lens' IAMPolicyAssignment (Maybe Text) Source #

Assignment ID.

IAMPolicyAssignmentSummary

iAMPolicyAssignmentSummary_assignmentName :: Lens' IAMPolicyAssignmentSummary (Maybe Text) Source #

Assignment name.

iAMPolicyAssignmentSummary_assignmentStatus :: Lens' IAMPolicyAssignmentSummary (Maybe AssignmentStatus) Source #

Assignment status.

Ingestion

ingestion_requestSource :: Lens' Ingestion (Maybe IngestionRequestSource) Source #

Event source for this ingestion.

ingestion_queueInfo :: Lens' Ingestion (Maybe QueueInfo) Source #

Undocumented member.

ingestion_ingestionTimeInSeconds :: Lens' Ingestion (Maybe Integer) Source #

The time that this ingestion took, measured in seconds.

ingestion_requestType :: Lens' Ingestion (Maybe IngestionRequestType) Source #

Type of this ingestion.

ingestion_ingestionSizeInBytes :: Lens' Ingestion (Maybe Integer) Source #

The size of the data ingested, in bytes.

ingestion_rowInfo :: Lens' Ingestion (Maybe RowInfo) Source #

Undocumented member.

ingestion_ingestionId :: Lens' Ingestion (Maybe Text) Source #

Ingestion ID.

ingestion_errorInfo :: Lens' Ingestion (Maybe ErrorInfo) Source #

Error information for this ingestion.

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.

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.

JiraParameters

jiraParameters_siteBaseUrl :: Lens' JiraParameters Text Source #

The base URL of the Jira site.

JoinInstruction

joinInstruction_rightJoinKeyProperties :: Lens' JoinInstruction (Maybe JoinKeyProperties) Source #

Join key properties of the right operand.

joinInstruction_leftJoinKeyProperties :: Lens' JoinInstruction (Maybe JoinKeyProperties) Source #

Join key properties of the left 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.

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.

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.

MemberIdArnPair

memberIdArnPair_memberId :: Lens' MemberIdArnPair (Maybe Text) Source #

The ID of the member.

memberIdArnPair_memberArn :: Lens' MemberIdArnPair (Maybe Text) Source #

The Amazon Resource Name (ARN) of the member.

MySqlParameters

mySqlParameters_host :: Lens' MySqlParameters Text Source #

Host.

mySqlParameters_port :: Lens' MySqlParameters Natural Source #

Port.

mySqlParameters_database :: Lens' MySqlParameters Text Source #

Database.

NamespaceError

namespaceError_type :: Lens' NamespaceError (Maybe NamespaceErrorType) Source #

The error type.

namespaceError_message :: Lens' NamespaceError (Maybe Text) Source #

The message for the error.

NamespaceInfoV2

namespaceInfoV2_capacityRegion :: Lens' NamespaceInfoV2 (Maybe Text) Source #

The namespace Amazon Web Services Region.

namespaceInfoV2_arn :: Lens' NamespaceInfoV2 (Maybe Text) Source #

The namespace ARN.

namespaceInfoV2_creationStatus :: Lens' NamespaceInfoV2 (Maybe NamespaceStatus) Source #

The creation status of a namespace that is not yet completely created.

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.

namespaceInfoV2_identityStore :: Lens' NamespaceInfoV2 (Maybe IdentityStore) Source #

The identity store used for the namespace.

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_name :: Lens' OutputColumn (Maybe Text) Source #

A display name for the dataset.

outputColumn_type :: Lens' OutputColumn (Maybe ColumnDataType) Source #

Type.

outputColumn_description :: Lens' OutputColumn (Maybe Text) Source #

A description for a column.

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.

PhysicalTable

physicalTable_s3Source :: Lens' PhysicalTable (Maybe S3Source) Source #

A physical table type for as S3 data source.

physicalTable_relationalTable :: Lens' PhysicalTable (Maybe RelationalTable) Source #

A physical table type for relational data sources.

physicalTable_customSql :: Lens' PhysicalTable (Maybe CustomSql) Source #

A physical table type built from the results of the custom SQL query.

PostgreSqlParameters

postgreSqlParameters_host :: Lens' PostgreSqlParameters Text Source #

Host.

postgreSqlParameters_port :: Lens' PostgreSqlParameters Natural Source #

Port.

postgreSqlParameters_database :: Lens' PostgreSqlParameters Text Source #

Database.

PrestoParameters

prestoParameters_host :: Lens' PrestoParameters Text Source #

Host.

prestoParameters_port :: Lens' PrestoParameters Natural Source #

Port.

prestoParameters_catalog :: Lens' PrestoParameters Text Source #

Catalog.

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.

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.

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.

RegisteredUserEmbeddingExperienceConfiguration

registeredUserEmbeddingExperienceConfiguration_dashboard :: Lens' RegisteredUserEmbeddingExperienceConfiguration (Maybe RegisteredUserDashboardEmbeddingConfiguration) Source #

The configuration details for providing a dashboard embedding experience.

registeredUserEmbeddingExperienceConfiguration_quickSightConsole :: Lens' RegisteredUserEmbeddingExperienceConfiguration (Maybe RegisteredUserQuickSightConsoleEmbeddingConfiguration) Source #

The configuration details for providing an 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 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.

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.

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.

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 IAMARN rather than a Amazon 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 IAMaction to grant or revoke permissions on.

RowInfo

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.

rowInfo_rowsDropped :: Lens' RowInfo (Maybe Integer) Source #

The number of rows that were not ingested.

RowLevelPermissionDataSet

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_namespace :: Lens' RowLevelPermissionDataSet (Maybe Text) Source #

The namespace associated with the dataset that contains permissions for RLS.

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

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.

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.

SheetControlsOption

sheetControlsOption_visibilityState :: Lens' SheetControlsOption (Maybe DashboardUIState) Source #

Visibility state.

SheetStyle

sheetStyle_tileLayout :: Lens' SheetStyle (Maybe TileLayoutStyle) Source #

The layout options for tiles.

sheetStyle_tile :: Lens' SheetStyle (Maybe TileStyle) Source #

The display options for tiles.

SnowflakeParameters

snowflakeParameters_host :: Lens' SnowflakeParameters Text Source #

Host.

snowflakeParameters_database :: Lens' SnowflakeParameters Text Source #

Database.

snowflakeParameters_warehouse :: Lens' SnowflakeParameters Text Source #

Warehouse.

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.

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.

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_lastUpdatedTime :: Lens' Template (Maybe UTCTime) Source #

Time when this was last updated.

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_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_name :: Lens' Template (Maybe Text) Source #

The display name of the template.

template_version :: Lens' Template (Maybe TemplateVersion) Source #

A structure describing the versions of the template.

TemplateAlias

templateAlias_arn :: Lens' TemplateAlias (Maybe Text) Source #

The Amazon Resource Name (ARN) of the template alias.

templateAlias_aliasName :: Lens' TemplateAlias (Maybe Text) Source #

The display name of the template alias.

templateAlias_templateVersionNumber :: Lens' TemplateAlias (Maybe Natural) Source #

The version number of the template alias.

TemplateError

templateError_type :: Lens' TemplateError (Maybe TemplateErrorType) Source #

Type of error.

templateError_message :: Lens' TemplateError (Maybe Text) Source #

Description of the error type.

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

templateSummary_name :: Lens' TemplateSummary (Maybe Text) Source #

A display name for the template.

TemplateVersion

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_sheets :: Lens' TemplateVersion (Maybe [Sheet]) Source #

A list of the associated sheets with the unique identifier and name of each sheet.

templateVersion_createdTime :: Lens' TemplateVersion (Maybe UTCTime) Source #

The time that this template version was created.

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_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_versionNumber :: Lens' TemplateVersion (Maybe Natural) Source #

The version number of the template version.

templateVersion_errors :: Lens' TemplateVersion (Maybe (NonEmpty TemplateError)) Source #

Errors associated with this template version.

templateVersion_description :: Lens' TemplateVersion (Maybe Text) Source #

The description of the template.

TemplateVersionSummary

templateVersionSummary_status :: Lens' TemplateVersionSummary (Maybe ResourceStatus) Source #

The status of the template version.

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_versionNumber :: Lens' TemplateVersionSummary (Maybe Natural) Source #

The version number of the template version.

templateVersionSummary_description :: Lens' TemplateVersionSummary (Maybe Text) Source #

The description 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.

Theme

theme_themeId :: Lens' Theme (Maybe Text) Source #

The identifier that the user gives to the theme.

theme_lastUpdatedTime :: Lens' Theme (Maybe UTCTime) Source #

The date and time that the theme was last updated.

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_name :: Lens' Theme (Maybe Text) Source #

The name that the user gives to the theme.

theme_version :: Lens' Theme (Maybe ThemeVersion) Source #

Undocumented member.

theme_type :: Lens' Theme (Maybe ThemeType) Source #

The type of theme, based on how it was created. Valid values include: QUICKSIGHT and CUSTOM.

ThemeAlias

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.

themeAlias_aliasName :: Lens' ThemeAlias (Maybe Text) Source #

The display name of the theme alias.

ThemeConfiguration

themeConfiguration_uIColorPalette :: Lens' ThemeConfiguration (Maybe UIColorPalette) Source #

Color properties that apply to the UI and to charts, excluding the colors that apply to data.

themeConfiguration_sheet :: Lens' ThemeConfiguration (Maybe SheetStyle) Source #

Display options related to sheets.

themeConfiguration_dataColorPalette :: Lens' ThemeConfiguration (Maybe DataColorPalette) Source #

Color properties that apply to chart data colors.

ThemeError

themeError_type :: Lens' ThemeError (Maybe ThemeErrorType) Source #

The type of error.

themeError_message :: Lens' ThemeError (Maybe Text) Source #

The error message.

ThemeSummary

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.

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_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_name :: Lens' ThemeSummary (Maybe Text) Source #

the display name for the theme.

ThemeVersion

themeVersion_status :: Lens' ThemeVersion (Maybe ResourceStatus) Source #

The status of the theme version.

themeVersion_arn :: Lens' ThemeVersion (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource.

themeVersion_createdTime :: Lens' ThemeVersion (Maybe UTCTime) Source #

The date and time that this theme version was created.

themeVersion_versionNumber :: Lens' ThemeVersion (Maybe Natural) Source #

The version number of the theme.

themeVersion_configuration :: Lens' ThemeVersion (Maybe ThemeConfiguration) Source #

The theme configuration, which contains all the theme display properties.

themeVersion_errors :: Lens' ThemeVersion (Maybe (NonEmpty ThemeError)) Source #

Errors associated with the theme.

themeVersion_description :: Lens' ThemeVersion (Maybe Text) Source #

The description of the theme.

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.

ThemeVersionSummary

themeVersionSummary_status :: Lens' ThemeVersionSummary (Maybe ResourceStatus) Source #

The status of the theme version.

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_versionNumber :: Lens' ThemeVersionSummary (Maybe Natural) Source #

The version number of the theme version.

themeVersionSummary_description :: Lens' ThemeVersionSummary (Maybe Text) Source #

The description of the theme version.

TileLayoutStyle

tileLayoutStyle_margin :: Lens' TileLayoutStyle (Maybe MarginStyle) Source #

The margin settings that apply around the outside edge of sheets.

tileLayoutStyle_gutter :: Lens' TileLayoutStyle (Maybe GutterStyle) Source #

The gutter settings that apply between tiles.

TileStyle

tileStyle_border :: Lens' TileStyle (Maybe BorderStyle) Source #

The border around a tile.

TransformOperation

transformOperation_castColumnTypeOperation :: Lens' TransformOperation (Maybe CastColumnTypeOperation) Source #

A transform operation that casts a column to a different type.

transformOperation_tagColumnOperation :: Lens' TransformOperation (Maybe TagColumnOperation) Source #

An operation that tags a column with additional information.

transformOperation_createColumnsOperation :: Lens' TransformOperation (Maybe CreateColumnsOperation) Source #

An operation that creates calculated columns. Columns created in one such operation form a lexical closure.

transformOperation_untagColumnOperation :: Lens' TransformOperation (Maybe UntagColumnOperation) Source #

Undocumented member.

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.

TwitterParameters

twitterParameters_query :: Lens' TwitterParameters Text Source #

Twitter query string.

twitterParameters_maxRows :: Lens' TwitterParameters Natural Source #

Maximum number of rows to query Twitter.

UIColorPalette

uIColorPalette_secondaryBackground :: Lens' UIColorPalette (Maybe Text) Source #

The background color that applies to the sheet background and sheet controls.

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_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_success :: Lens' UIColorPalette (Maybe Text) Source #

The color that applies to success messages, for example the check mark for a successful download.

uIColorPalette_accent :: Lens' UIColorPalette (Maybe Text) Source #

This color is that applies to selected states and buttons.

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_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_warning :: Lens' UIColorPalette (Maybe Text) Source #

This color that applies to warning and informational messages.

uIColorPalette_primaryBackground :: Lens' UIColorPalette (Maybe Text) Source #

The background color that applies to visuals and other high emphasis UI.

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_measure :: Lens' UIColorPalette (Maybe Text) Source #

The color that applies to the names of fields that are identified as measures.

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_measureForeground :: Lens' UIColorPalette (Maybe Text) Source #

The foreground color that applies to any text or other elements that appear over the measure color.

uIColorPalette_danger :: Lens' UIColorPalette (Maybe Text) Source #

The color that applies to error 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.

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_startFromRow :: Lens' UploadSettings (Maybe Natural) Source #

A row number to start reading data from.

uploadSettings_containsHeader :: Lens' UploadSettings (Maybe Bool) Source #

Whether the file has a header row, or the files each have a header row.

uploadSettings_textQualifier :: Lens' UploadSettings (Maybe TextQualifier) Source #

Text qualifier.

uploadSettings_format :: Lens' UploadSettings (Maybe FileFormat) Source #

File format.

uploadSettings_delimiter :: Lens' UploadSettings (Maybe Text) Source #

The delimiter between values in the file.

User

user_email :: Lens' User (Maybe Text) Source #

The user's email address.

user_principalId :: Lens' User (Maybe Text) Source #

The principal ID of the user.

user_arn :: Lens' User (Maybe Text) Source #

The Amazon Resource Name (ARN) for the user.

user_userName :: Lens' User (Maybe Text) Source #

The user's user name.

user_identityType :: Lens' User (Maybe IdentityType) Source #

The type of identity authentication used by the user.

user_externalLoginFederationProviderUrl :: Lens' User (Maybe Text) Source #

The URL of the external login provider.

user_customPermissionsName :: Lens' User (Maybe Text) Source #

The custom permissions profile associated with this 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_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_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 IAMrole. 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_externalLoginId :: Lens' User (Maybe Text) Source #

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

VpcConnectionProperties

vpcConnectionProperties_vpcConnectionArn :: Lens' VpcConnectionProperties Text Source #

The Amazon Resource Name (ARN) for the VPC connection.