NAME

Paws::Quicksight - Perl Interface to AWS Amazon QuickSight

SYNOPSIS

use Paws;

my $obj = Paws->service('Quicksight');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

Amazon QuickSight API Reference

Amazon QuickSight is a fully managed, serverless business intelligence service for the AWS Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01

METHODS

CancelIngestion

AwsAccountId => Str
DataSetId => Str
IngestionId => Str

Each argument is described in detail in: Paws::Quicksight::CancelIngestion

Returns: a Paws::Quicksight::CancelIngestionResponse instance

Cancels an ongoing ingestion of data into SPICE.

CreateAccountCustomization

AccountCustomization => Paws::Quicksight::AccountCustomization
AwsAccountId => Str
[Namespace => Str]
[Tags => ArrayRef[Paws::Quicksight::Tag]]

Each argument is described in detail in: Paws::Quicksight::CreateAccountCustomization

Returns: a Paws::Quicksight::CreateAccountCustomizationResponse instance

Creates Amazon QuickSight customizations the current AWS Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html) in the Amazon QuickSight User Guide.

You can create customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an AWS account. To find out which customizations apply, use the DescribeAccountCustomization API operation.

Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.

CreateAnalysis

AnalysisId => Str
AwsAccountId => Str
Name => Str
SourceEntity => Paws::Quicksight::AnalysisSourceEntity
[Parameters => Paws::Quicksight::Parameters]
[Permissions => ArrayRef[Paws::Quicksight::ResourcePermission]]
[Tags => ArrayRef[Paws::Quicksight::Tag]]
[ThemeArn => Str]

Each argument is described in detail in: Paws::Quicksight::CreateAnalysis

Returns: a Paws::Quicksight::CreateAnalysisResponse instance

Creates an analysis in Amazon QuickSight.

CreateDashboard

AwsAccountId => Str
DashboardId => Str
Name => Str
SourceEntity => Paws::Quicksight::DashboardSourceEntity
[DashboardPublishOptions => Paws::Quicksight::DashboardPublishOptions]
[Parameters => Paws::Quicksight::Parameters]
[Permissions => ArrayRef[Paws::Quicksight::ResourcePermission]]
[Tags => ArrayRef[Paws::Quicksight::Tag]]
[ThemeArn => Str]
[VersionDescription => Str]

Each argument is described in detail in: Paws::Quicksight::CreateDashboard

Returns: a Paws::Quicksight::CreateDashboardResponse instance

Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation.

A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account.

CreateDataSet

AwsAccountId => Str
DataSetId => Str
ImportMode => Str
Name => Str
PhysicalTableMap => Paws::Quicksight::PhysicalTableMap
[ColumnGroups => ArrayRef[Paws::Quicksight::ColumnGroup]]
[ColumnLevelPermissionRules => ArrayRef[Paws::Quicksight::ColumnLevelPermissionRule]]
[FieldFolders => Paws::Quicksight::FieldFolderMap]
[LogicalTableMap => Paws::Quicksight::LogicalTableMap]
[Permissions => ArrayRef[Paws::Quicksight::ResourcePermission]]
[RowLevelPermissionDataSet => Paws::Quicksight::RowLevelPermissionDataSet]
[Tags => ArrayRef[Paws::Quicksight::Tag]]

Each argument is described in detail in: Paws::Quicksight::CreateDataSet

Returns: a Paws::Quicksight::CreateDataSetResponse instance

Creates a dataset.

CreateDataSource

AwsAccountId => Str
DataSourceId => Str
Name => Str
Type => Str
[Credentials => Paws::Quicksight::DataSourceCredentials]
[DataSourceParameters => Paws::Quicksight::DataSourceParameters]
[Permissions => ArrayRef[Paws::Quicksight::ResourcePermission]]
[SslProperties => Paws::Quicksight::SslProperties]
[Tags => ArrayRef[Paws::Quicksight::Tag]]
[VpcConnectionProperties => Paws::Quicksight::VpcConnectionProperties]

Each argument is described in detail in: Paws::Quicksight::CreateDataSource

Returns: a Paws::Quicksight::CreateDataSourceResponse instance

Creates a data source.

CreateFolder

AwsAccountId => Str
FolderId => Str
[FolderType => Str]
[Name => Str]
[ParentFolderArn => Str]
[Permissions => ArrayRef[Paws::Quicksight::ResourcePermission]]
[Tags => ArrayRef[Paws::Quicksight::Tag]]

Each argument is described in detail in: Paws::Quicksight::CreateFolder

Returns: a Paws::Quicksight::CreateFolderResponse instance

Creates an empty shared folder.

CreateFolderMembership

AwsAccountId => Str
FolderId => Str
MemberId => Str
MemberType => Str

Each argument is described in detail in: Paws::Quicksight::CreateFolderMembership

Returns: a Paws::Quicksight::CreateFolderMembershipResponse instance

Adds an asset, such as a dashboard, analysis, or dataset into a folder.

CreateGroup

AwsAccountId => Str
GroupName => Str
Namespace => Str
[Description => Str]

Each argument is described in detail in: Paws::Quicksight::CreateGroup

Returns: a Paws::Quicksight::CreateGroupResponse instance

Creates an Amazon QuickSight group.

The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> .

The response is a group object.

CreateGroupMembership

AwsAccountId => Str
GroupName => Str
MemberName => Str
Namespace => Str

Each argument is described in detail in: Paws::Quicksight::CreateGroupMembership

Returns: a Paws::Quicksight::CreateGroupMembershipResponse instance

Adds an Amazon QuickSight user to an Amazon QuickSight group.

CreateIAMPolicyAssignment

AssignmentName => Str
AssignmentStatus => Str
AwsAccountId => Str
Namespace => Str
[Identities => Paws::Quicksight::IdentityMap]
[PolicyArn => Str]

Each argument is described in detail in: Paws::Quicksight::CreateIAMPolicyAssignment

Returns: a Paws::Quicksight::CreateIAMPolicyAssignmentResponse instance

Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per AWS account. To avoid overwriting rules in other namespaces, use assignment names that are unique.

CreateIngestion

AwsAccountId => Str
DataSetId => Str
IngestionId => Str

Each argument is described in detail in: Paws::Quicksight::CreateIngestion

Returns: a Paws::Quicksight::CreateIngestionResponse instance

Creates and starts a new SPICE ingestion on a dataset

Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? (http://aws.amazon.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/) in the AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

CreateNamespace

AwsAccountId => Str
IdentityStore => Str
Namespace => Str
[Tags => ArrayRef[Paws::Quicksight::Tag]]

Each argument is described in detail in: Paws::Quicksight::CreateNamespace

Returns: a Paws::Quicksight::CreateNamespaceResponse instance

(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.

A namespace allows you to isolate the QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your AWS account is subscribed to QuickSight. The namespace must be unique within the AWS account. By default, there is a limit of 100 namespaces per AWS account. To increase your limit, create a ticket with AWS Support.

CreateTemplate

AwsAccountId => Str
SourceEntity => Paws::Quicksight::TemplateSourceEntity
TemplateId => Str
[Name => Str]
[Permissions => ArrayRef[Paws::Quicksight::ResourcePermission]]
[Tags => ArrayRef[Paws::Quicksight::Tag]]
[VersionDescription => Str]

Each argument is described in detail in: Paws::Quicksight::CreateTemplate

Returns: a Paws::Quicksight::CreateTemplateResponse instance

Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard.

A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.

CreateTemplateAlias

AliasName => Str
AwsAccountId => Str
TemplateId => Str
TemplateVersionNumber => Int

Each argument is described in detail in: Paws::Quicksight::CreateTemplateAlias

Returns: a Paws::Quicksight::CreateTemplateAliasResponse instance

Creates a template alias for a template.

CreateTheme

AwsAccountId => Str
BaseThemeId => Str
Configuration => Paws::Quicksight::ThemeConfiguration
Name => Str
ThemeId => Str
[Permissions => ArrayRef[Paws::Quicksight::ResourcePermission]]
[Tags => ArrayRef[Paws::Quicksight::Tag]]
[VersionDescription => Str]

Each argument is described in detail in: Paws::Quicksight::CreateTheme

Returns: a Paws::Quicksight::CreateThemeResponse instance

Creates a theme.

A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html) in the Amazon QuickSight User Guide.

CreateThemeAlias

AliasName => Str
AwsAccountId => Str
ThemeId => Str
ThemeVersionNumber => Int

Each argument is described in detail in: Paws::Quicksight::CreateThemeAlias

Returns: a Paws::Quicksight::CreateThemeAliasResponse instance

Creates a theme alias for a theme.

DeleteAccountCustomization

AwsAccountId => Str
[Namespace => Str]

Each argument is described in detail in: Paws::Quicksight::DeleteAccountCustomization

Returns: a Paws::Quicksight::DeleteAccountCustomizationResponse instance

Deletes all Amazon QuickSight customizations in this AWS Region for the specified AWS account and QuickSight namespace.

DeleteAnalysis

AnalysisId => Str
AwsAccountId => Str
[ForceDeleteWithoutRecovery => Bool]
[RecoveryWindowInDays => Int]

Each argument is described in detail in: Paws::Quicksight::DeleteAnalysis

Returns: a Paws::Quicksight::DeleteAnalysisResponse instance

Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, QuickSight deletes the analysis permanently.

At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it.

An analysis that's scheduled for deletion isn't accessible in the QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.

DeleteDashboard

AwsAccountId => Str
DashboardId => Str
[VersionNumber => Int]

Each argument is described in detail in: Paws::Quicksight::DeleteDashboard

Returns: a Paws::Quicksight::DeleteDashboardResponse instance

Deletes a dashboard.

DeleteDataSet

AwsAccountId => Str
DataSetId => Str

Each argument is described in detail in: Paws::Quicksight::DeleteDataSet

Returns: a Paws::Quicksight::DeleteDataSetResponse instance

Deletes a dataset.

DeleteDataSource

AwsAccountId => Str
DataSourceId => Str

Each argument is described in detail in: Paws::Quicksight::DeleteDataSource

Returns: a Paws::Quicksight::DeleteDataSourceResponse instance

Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.

DeleteFolder

AwsAccountId => Str
FolderId => Str

Each argument is described in detail in: Paws::Quicksight::DeleteFolder

Returns: a Paws::Quicksight::DeleteFolderResponse instance

Deletes an empty folder.

DeleteFolderMembership

AwsAccountId => Str
FolderId => Str
MemberId => Str
MemberType => Str

Each argument is described in detail in: Paws::Quicksight::DeleteFolderMembership

Returns: a Paws::Quicksight::DeleteFolderMembershipResponse instance

Removes an asset, such as a dashboard, analysis, or dataset, from a folder.

DeleteGroup

AwsAccountId => Str
GroupName => Str
Namespace => Str

Each argument is described in detail in: Paws::Quicksight::DeleteGroup

Returns: a Paws::Quicksight::DeleteGroupResponse instance

Removes a user group from Amazon QuickSight.

DeleteGroupMembership

AwsAccountId => Str
GroupName => Str
MemberName => Str
Namespace => Str

Each argument is described in detail in: Paws::Quicksight::DeleteGroupMembership

Returns: a Paws::Quicksight::DeleteGroupMembershipResponse instance

Removes a user from a group so that the user is no longer a member of the group.

DeleteIAMPolicyAssignment

AssignmentName => Str
AwsAccountId => Str
Namespace => Str

Each argument is described in detail in: Paws::Quicksight::DeleteIAMPolicyAssignment

Returns: a Paws::Quicksight::DeleteIAMPolicyAssignmentResponse instance

Deletes an existing IAM policy assignment.

DeleteNamespace

AwsAccountId => Str
Namespace => Str

Each argument is described in detail in: Paws::Quicksight::DeleteNamespace

Returns: a Paws::Quicksight::DeleteNamespaceResponse instance

Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.

DeleteTemplate

AwsAccountId => Str
TemplateId => Str
[VersionNumber => Int]

Each argument is described in detail in: Paws::Quicksight::DeleteTemplate

Returns: a Paws::Quicksight::DeleteTemplateResponse instance

Deletes a template.

DeleteTemplateAlias

AliasName => Str
AwsAccountId => Str
TemplateId => Str

Each argument is described in detail in: Paws::Quicksight::DeleteTemplateAlias

Returns: a Paws::Quicksight::DeleteTemplateAliasResponse instance

Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.

DeleteTheme

AwsAccountId => Str
ThemeId => Str
[VersionNumber => Int]

Each argument is described in detail in: Paws::Quicksight::DeleteTheme

Returns: a Paws::Quicksight::DeleteThemeResponse instance

Deletes a theme.

DeleteThemeAlias

AliasName => Str
AwsAccountId => Str
ThemeId => Str

Each argument is described in detail in: Paws::Quicksight::DeleteThemeAlias

Returns: a Paws::Quicksight::DeleteThemeAliasResponse instance

Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.

DeleteUser

AwsAccountId => Str
Namespace => Str
UserName => Str

Each argument is described in detail in: Paws::Quicksight::DeleteUser

Returns: a Paws::Quicksight::DeleteUserResponse instance

Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.

DeleteUserByPrincipalId

AwsAccountId => Str
Namespace => Str
PrincipalId => Str

Each argument is described in detail in: Paws::Quicksight::DeleteUserByPrincipalId

Returns: a Paws::Quicksight::DeleteUserByPrincipalIdResponse instance

Deletes a user identified by its principal ID.

DescribeAccountCustomization

AwsAccountId => Str
[Namespace => Str]
[Resolved => Bool]

Each argument is described in detail in: Paws::Quicksight::DescribeAccountCustomization

Returns: a Paws::Quicksight::DescribeAccountCustomizationResponse instance

Describes the customizations associated with the provided AWS account and Amazon QuickSight namespace in an AWS Region. The QuickSight console evaluates which customizations to apply by running this API operation with the Resolved flag included.

To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.

AWS Account - The AWS account exists at the top of the hierarchy. It has the potential to use all of the AWS Regions and AWS Services. When you subscribe to QuickSight, you choose one AWS Region to use as your home Region. That's where your free SPICE capacity is located. You can use QuickSight in any supported AWS Region.
AWS Region - In each AWS Region where you sign in to QuickSight at least once, QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to QuickSight in any AWS Region, unless they are constrained to a namespace.

To run the command in a different AWS Region, you change your Region settings. If you're using the AWS CLI, you can use one of the following options:
- Use command line options (https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html).
- Use named profiles (https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
- Run aws configure to change your default AWS Region. Use Enter to key the same settings for your keys. For more information, see Configuring the AWS CLI (https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html).
Namespace - A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same AWS account and AWS Region.
Applied customizations - Within an AWS Region, a set of QuickSight customizations can apply to an AWS account or to a namespace. Settings that you apply to a namespace override settings that you apply to an AWS account. All settings are isolated to a single AWS Region. To apply them in other AWS Regions, run the CreateAccountCustomization command in each AWS Region where you want to apply the same customizations.

DescribeAccountSettings

AwsAccountId => Str

Each argument is described in detail in: Paws::Quicksight::DescribeAccountSettings

Returns: a Paws::Quicksight::DescribeAccountSettingsResponse instance

Describes the settings that were used when your QuickSight subscription was first created in this AWS account.

DescribeAnalysis

AnalysisId => Str
AwsAccountId => Str

Each argument is described in detail in: Paws::Quicksight::DescribeAnalysis

Returns: a Paws::Quicksight::DescribeAnalysisResponse instance

Provides a summary of the metadata for an analysis.

DescribeAnalysisPermissions

AnalysisId => Str
AwsAccountId => Str

Each argument is described in detail in: Paws::Quicksight::DescribeAnalysisPermissions

Returns: a Paws::Quicksight::DescribeAnalysisPermissionsResponse instance

Provides the read and write permissions for an analysis.

DescribeDashboard

AwsAccountId => Str
DashboardId => Str
[AliasName => Str]
[VersionNumber => Int]

Each argument is described in detail in: Paws::Quicksight::DescribeDashboard

Returns: a Paws::Quicksight::DescribeDashboardResponse instance

Provides a summary for a dashboard.

DescribeDashboardPermissions

AwsAccountId => Str
DashboardId => Str

Each argument is described in detail in: Paws::Quicksight::DescribeDashboardPermissions

Returns: a Paws::Quicksight::DescribeDashboardPermissionsResponse instance

Describes read and write permissions for a dashboard.

DescribeDataSet

AwsAccountId => Str
DataSetId => Str

Each argument is described in detail in: Paws::Quicksight::DescribeDataSet

Returns: a Paws::Quicksight::DescribeDataSetResponse instance

Describes a dataset.

DescribeDataSetPermissions

AwsAccountId => Str
DataSetId => Str

Each argument is described in detail in: Paws::Quicksight::DescribeDataSetPermissions

Returns: a Paws::Quicksight::DescribeDataSetPermissionsResponse instance

Describes the permissions on a dataset.

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

DescribeDataSource

AwsAccountId => Str
DataSourceId => Str

Each argument is described in detail in: Paws::Quicksight::DescribeDataSource

Returns: a Paws::Quicksight::DescribeDataSourceResponse instance

Describes a data source.

DescribeDataSourcePermissions

AwsAccountId => Str
DataSourceId => Str

Each argument is described in detail in: Paws::Quicksight::DescribeDataSourcePermissions

Returns: a Paws::Quicksight::DescribeDataSourcePermissionsResponse instance

Describes the resource permissions for a data source.

DescribeFolder

AwsAccountId => Str
FolderId => Str

Each argument is described in detail in: Paws::Quicksight::DescribeFolder

Returns: a Paws::Quicksight::DescribeFolderResponse instance

Describes a folder.

DescribeFolderPermissions

AwsAccountId => Str
FolderId => Str

Each argument is described in detail in: Paws::Quicksight::DescribeFolderPermissions

Returns: a Paws::Quicksight::DescribeFolderPermissionsResponse instance

Describes permissions for a folder.

DescribeFolderResolvedPermissions

AwsAccountId => Str
FolderId => Str

Each argument is described in detail in: Paws::Quicksight::DescribeFolderResolvedPermissions

Returns: a Paws::Quicksight::DescribeFolderResolvedPermissionsResponse instance

Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.

DescribeGroup

AwsAccountId => Str
GroupName => Str
Namespace => Str

Each argument is described in detail in: Paws::Quicksight::DescribeGroup

Returns: a Paws::Quicksight::DescribeGroupResponse instance

Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).

DescribeIAMPolicyAssignment

AssignmentName => Str
AwsAccountId => Str
Namespace => Str

Each argument is described in detail in: Paws::Quicksight::DescribeIAMPolicyAssignment

Returns: a Paws::Quicksight::DescribeIAMPolicyAssignmentResponse instance

Describes an existing IAM policy assignment, as specified by the assignment name.

DescribeIngestion

AwsAccountId => Str
DataSetId => Str
IngestionId => Str

Each argument is described in detail in: Paws::Quicksight::DescribeIngestion

Returns: a Paws::Quicksight::DescribeIngestionResponse instance

Describes a SPICE ingestion.

DescribeNamespace

AwsAccountId => Str
Namespace => Str

Each argument is described in detail in: Paws::Quicksight::DescribeNamespace

Returns: a Paws::Quicksight::DescribeNamespaceResponse instance

Describes the current namespace.

DescribeTemplate

AwsAccountId => Str
TemplateId => Str
[AliasName => Str]
[VersionNumber => Int]

Each argument is described in detail in: Paws::Quicksight::DescribeTemplate

Returns: a Paws::Quicksight::DescribeTemplateResponse instance

Describes a template's metadata.

DescribeTemplateAlias

AliasName => Str
AwsAccountId => Str
TemplateId => Str

Each argument is described in detail in: Paws::Quicksight::DescribeTemplateAlias

Returns: a Paws::Quicksight::DescribeTemplateAliasResponse instance

Describes the template alias for a template.

DescribeTemplatePermissions

AwsAccountId => Str
TemplateId => Str

Each argument is described in detail in: Paws::Quicksight::DescribeTemplatePermissions

Returns: a Paws::Quicksight::DescribeTemplatePermissionsResponse instance

Describes read and write permissions on a template.

DescribeTheme

AwsAccountId => Str
ThemeId => Str
[AliasName => Str]
[VersionNumber => Int]

Each argument is described in detail in: Paws::Quicksight::DescribeTheme

Returns: a Paws::Quicksight::DescribeThemeResponse instance

Describes a theme.

DescribeThemeAlias

AliasName => Str
AwsAccountId => Str
ThemeId => Str

Each argument is described in detail in: Paws::Quicksight::DescribeThemeAlias

Returns: a Paws::Quicksight::DescribeThemeAliasResponse instance

Describes the alias for a theme.

DescribeThemePermissions

AwsAccountId => Str
ThemeId => Str

Each argument is described in detail in: Paws::Quicksight::DescribeThemePermissions

Returns: a Paws::Quicksight::DescribeThemePermissionsResponse instance

Describes the read and write permissions for a theme.

DescribeUser

AwsAccountId => Str
Namespace => Str
UserName => Str

Each argument is described in detail in: Paws::Quicksight::DescribeUser

Returns: a Paws::Quicksight::DescribeUserResponse instance

Returns information about a user, given the user name.

GetDashboardEmbedUrl

AwsAccountId => Str
DashboardId => Str
IdentityType => Str
[AdditionalDashboardIds => ArrayRef[Str|Undef]]
[Namespace => Str]
[ResetDisabled => Bool]
[SessionLifetimeInMinutes => Int]
[StatePersistenceEnabled => Bool]
[UndoRedoDisabled => Bool]
[UserArn => Str]

Each argument is described in detail in: Paws::Quicksight::GetDashboardEmbedUrl

Returns: a Paws::Quicksight::GetDashboardEmbedUrlResponse instance

Generates a session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions.

Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the combination of URL and authorization code:

They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
The resulting user session is valid for 10 hours.

For more information, see Embedded Analytics (https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html) in the Amazon QuickSight User Guide.

GetSessionEmbedUrl

AwsAccountId => Str
[EntryPoint => Str]
[SessionLifetimeInMinutes => Int]
[UserArn => Str]

Each argument is described in detail in: Paws::Quicksight::GetSessionEmbedUrl

Returns: a Paws::Quicksight::GetSessionEmbedUrlResponse instance

Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded QuickSight console need 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:

Embedding the Amazon QuickSight Console (https://docs.aws.amazon.com/quicksight/latest/user/embedding-the-quicksight-console.html)
Customizing Access to the Amazon QuickSight Console (https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html)

ListAnalyses

AwsAccountId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::ListAnalyses

Returns: a Paws::Quicksight::ListAnalysesResponse instance

Lists Amazon QuickSight analyses that exist in the specified AWS account.

ListDashboards

AwsAccountId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::ListDashboards

Returns: a Paws::Quicksight::ListDashboardsResponse instance

Lists dashboards in an AWS account.

ListDashboardVersions

AwsAccountId => Str
DashboardId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::ListDashboardVersions

Returns: a Paws::Quicksight::ListDashboardVersionsResponse instance

Lists all the versions of the dashboards in the QuickSight subscription.

ListDataSets

AwsAccountId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::ListDataSets

Returns: a Paws::Quicksight::ListDataSetsResponse instance

Lists all of the datasets belonging to the current AWS account in an AWS Region.

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.

ListDataSources

AwsAccountId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::ListDataSources

Returns: a Paws::Quicksight::ListDataSourcesResponse instance

Lists data sources in current AWS Region that belong to this AWS account.

ListFolderMembers

AwsAccountId => Str
FolderId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::ListFolderMembers

Returns: a Paws::Quicksight::ListFolderMembersResponse instance

List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.

ListFolders

AwsAccountId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::ListFolders

Returns: a Paws::Quicksight::ListFoldersResponse instance

Lists all folders in an account.

ListGroupMemberships

AwsAccountId => Str
GroupName => Str
Namespace => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::ListGroupMemberships

Returns: a Paws::Quicksight::ListGroupMembershipsResponse instance

Lists member users in a group.

ListGroups

AwsAccountId => Str
Namespace => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::ListGroups

Returns: a Paws::Quicksight::ListGroupsResponse instance

Lists all user groups in Amazon QuickSight.

ListIAMPolicyAssignments

AwsAccountId => Str
Namespace => Str
[AssignmentStatus => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::ListIAMPolicyAssignments

Returns: a Paws::Quicksight::ListIAMPolicyAssignmentsResponse instance

Lists IAM policy assignments in the current Amazon QuickSight account.

ListIAMPolicyAssignmentsForUser

AwsAccountId => Str
Namespace => Str
UserName => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::ListIAMPolicyAssignmentsForUser

Returns: a Paws::Quicksight::ListIAMPolicyAssignmentsForUserResponse instance

Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.

ListIngestions

AwsAccountId => Str
DataSetId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::ListIngestions

Returns: a Paws::Quicksight::ListIngestionsResponse instance

Lists the history of SPICE ingestions for a dataset.

ListNamespaces

AwsAccountId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::ListNamespaces

Returns: a Paws::Quicksight::ListNamespacesResponse instance

Lists the namespaces for the specified AWS account.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::Quicksight::ListTagsForResource

Returns: a Paws::Quicksight::ListTagsForResourceResponse instance

Lists the tags assigned to a resource.

ListTemplateAliases

AwsAccountId => Str
TemplateId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::ListTemplateAliases

Returns: a Paws::Quicksight::ListTemplateAliasesResponse instance

Lists all the aliases of a template.

ListTemplates

AwsAccountId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::ListTemplates

Returns: a Paws::Quicksight::ListTemplatesResponse instance

Lists all the templates in the current Amazon QuickSight account.

ListTemplateVersions

AwsAccountId => Str
TemplateId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::ListTemplateVersions

Returns: a Paws::Quicksight::ListTemplateVersionsResponse instance

Lists all the versions of the templates in the current Amazon QuickSight account.

ListThemeAliases

AwsAccountId => Str
ThemeId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::ListThemeAliases

Returns: a Paws::Quicksight::ListThemeAliasesResponse instance

Lists all the aliases of a theme.

ListThemes

AwsAccountId => Str
[MaxResults => Int]
[NextToken => Str]
[Type => Str]

Each argument is described in detail in: Paws::Quicksight::ListThemes

Returns: a Paws::Quicksight::ListThemesResponse instance

Lists all the themes in the current AWS account.

ListThemeVersions

AwsAccountId => Str
ThemeId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::ListThemeVersions

Returns: a Paws::Quicksight::ListThemeVersionsResponse instance

Lists all the versions of the themes in the current AWS account.

ListUserGroups

AwsAccountId => Str
Namespace => Str
UserName => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::ListUserGroups

Returns: a Paws::Quicksight::ListUserGroupsResponse instance

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

ListUsers

AwsAccountId => Str
Namespace => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::ListUsers

Returns: a Paws::Quicksight::ListUsersResponse instance

Returns a list of all of the Amazon QuickSight users belonging to this account.

RegisterUser

AwsAccountId => Str
Email => Str
IdentityType => Str
Namespace => Str
UserRole => Str
[CustomFederationProviderUrl => Str]
[CustomPermissionsName => Str]
[ExternalLoginFederationProviderType => Str]
[ExternalLoginId => Str]
[IamArn => Str]
[SessionName => Str]
[UserName => Str]

Each argument is described in detail in: Paws::Quicksight::RegisterUser

Returns: a Paws::Quicksight::RegisterUserResponse instance

Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.

RestoreAnalysis

AnalysisId => Str
AwsAccountId => Str

Each argument is described in detail in: Paws::Quicksight::RestoreAnalysis

Returns: a Paws::Quicksight::RestoreAnalysisResponse instance

Restores an analysis.

SearchAnalyses

AwsAccountId => Str
Filters => ArrayRef[Paws::Quicksight::AnalysisSearchFilter]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::SearchAnalyses

Returns: a Paws::Quicksight::SearchAnalysesResponse instance

Searches for analyses that belong to the user specified in the filter.

SearchDashboards

AwsAccountId => Str
Filters => ArrayRef[Paws::Quicksight::DashboardSearchFilter]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::SearchDashboards

Returns: a Paws::Quicksight::SearchDashboardsResponse instance

Searches for dashboards that belong to a user.

SearchFolders

AwsAccountId => Str
Filters => ArrayRef[Paws::Quicksight::FolderSearchFilter]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Quicksight::SearchFolders

Returns: a Paws::Quicksight::SearchFoldersResponse instance

Searches the subfolders in a folder.

TagResource

ResourceArn => Str
Tags => ArrayRef[Paws::Quicksight::Tag]

Each argument is described in detail in: Paws::Quicksight::TagResource

Returns: a Paws::Quicksight::TagResourceResponse instance

Assigns one or more tags (key-value pairs) to the specified QuickSight resource.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source, dashboard, and template.

Tagging for QuickSight works in a similar way to tagging for other AWS services, except for the following:

You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.
QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Quicksight::UntagResource

Returns: a Paws::Quicksight::UntagResourceResponse instance

Removes a tag or tags from a resource.

UpdateAccountCustomization

AccountCustomization => Paws::Quicksight::AccountCustomization
AwsAccountId => Str
[Namespace => Str]

Each argument is described in detail in: Paws::Quicksight::UpdateAccountCustomization

Returns: a Paws::Quicksight::UpdateAccountCustomizationResponse instance

Updates Amazon QuickSight customizations the current AWS Region. Currently, the only customization you can use is a theme.

You can use customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an AWS account. To find out which customizations apply, use the DescribeAccountCustomization API operation.

UpdateAccountSettings

AwsAccountId => Str
DefaultNamespace => Str
[NotificationEmail => Str]

Each argument is described in detail in: Paws::Quicksight::UpdateAccountSettings

Returns: a Paws::Quicksight::UpdateAccountSettingsResponse instance

Updates the Amazon QuickSight settings in your AWS account.

UpdateAnalysis

AnalysisId => Str
AwsAccountId => Str
Name => Str
SourceEntity => Paws::Quicksight::AnalysisSourceEntity
[Parameters => Paws::Quicksight::Parameters]
[ThemeArn => Str]

Each argument is described in detail in: Paws::Quicksight::UpdateAnalysis

Returns: a Paws::Quicksight::UpdateAnalysisResponse instance

Updates an analysis in Amazon QuickSight

UpdateAnalysisPermissions

AnalysisId => Str
AwsAccountId => Str
[GrantPermissions => ArrayRef[Paws::Quicksight::ResourcePermission]]
[RevokePermissions => ArrayRef[Paws::Quicksight::ResourcePermission]]

Each argument is described in detail in: Paws::Quicksight::UpdateAnalysisPermissions

Returns: a Paws::Quicksight::UpdateAnalysisPermissionsResponse instance

Updates the read and write permissions for an analysis.

UpdateDashboard

AwsAccountId => Str
DashboardId => Str
Name => Str
SourceEntity => Paws::Quicksight::DashboardSourceEntity
[DashboardPublishOptions => Paws::Quicksight::DashboardPublishOptions]
[Parameters => Paws::Quicksight::Parameters]
[ThemeArn => Str]
[VersionDescription => Str]

Each argument is described in detail in: Paws::Quicksight::UpdateDashboard

Returns: a Paws::Quicksight::UpdateDashboardResponse instance

Updates a dashboard in an AWS account.

UpdateDashboardPermissions

AwsAccountId => Str
DashboardId => Str
[GrantPermissions => ArrayRef[Paws::Quicksight::ResourcePermission]]
[RevokePermissions => ArrayRef[Paws::Quicksight::ResourcePermission]]

Each argument is described in detail in: Paws::Quicksight::UpdateDashboardPermissions

Returns: a Paws::Quicksight::UpdateDashboardPermissionsResponse instance

Updates read and write permissions on a dashboard.

UpdateDashboardPublishedVersion

AwsAccountId => Str
DashboardId => Str
VersionNumber => Int

Each argument is described in detail in: Paws::Quicksight::UpdateDashboardPublishedVersion

Returns: a Paws::Quicksight::UpdateDashboardPublishedVersionResponse instance

Updates the published version of a dashboard.

UpdateDataSet

AwsAccountId => Str
DataSetId => Str
ImportMode => Str
Name => Str
PhysicalTableMap => Paws::Quicksight::PhysicalTableMap
[ColumnGroups => ArrayRef[Paws::Quicksight::ColumnGroup]]
[ColumnLevelPermissionRules => ArrayRef[Paws::Quicksight::ColumnLevelPermissionRule]]
[FieldFolders => Paws::Quicksight::FieldFolderMap]
[LogicalTableMap => Paws::Quicksight::LogicalTableMap]
[RowLevelPermissionDataSet => Paws::Quicksight::RowLevelPermissionDataSet]

Each argument is described in detail in: Paws::Quicksight::UpdateDataSet

Returns: a Paws::Quicksight::UpdateDataSetResponse instance

Updates a dataset.

UpdateDataSetPermissions

AwsAccountId => Str
DataSetId => Str
[GrantPermissions => ArrayRef[Paws::Quicksight::ResourcePermission]]
[RevokePermissions => ArrayRef[Paws::Quicksight::ResourcePermission]]

Each argument is described in detail in: Paws::Quicksight::UpdateDataSetPermissions

Returns: a Paws::Quicksight::UpdateDataSetPermissionsResponse instance

Updates the permissions on a dataset.

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

UpdateDataSource

AwsAccountId => Str
DataSourceId => Str
Name => Str
[Credentials => Paws::Quicksight::DataSourceCredentials]
[DataSourceParameters => Paws::Quicksight::DataSourceParameters]
[SslProperties => Paws::Quicksight::SslProperties]
[VpcConnectionProperties => Paws::Quicksight::VpcConnectionProperties]

Each argument is described in detail in: Paws::Quicksight::UpdateDataSource

Returns: a Paws::Quicksight::UpdateDataSourceResponse instance

Updates a data source.

UpdateDataSourcePermissions

AwsAccountId => Str
DataSourceId => Str
[GrantPermissions => ArrayRef[Paws::Quicksight::ResourcePermission]]
[RevokePermissions => ArrayRef[Paws::Quicksight::ResourcePermission]]

Each argument is described in detail in: Paws::Quicksight::UpdateDataSourcePermissions

Returns: a Paws::Quicksight::UpdateDataSourcePermissionsResponse instance

Updates the permissions to a data source.

UpdateFolder

AwsAccountId => Str
FolderId => Str
Name => Str

Each argument is described in detail in: Paws::Quicksight::UpdateFolder

Returns: a Paws::Quicksight::UpdateFolderResponse instance

Updates the name of a folder.

UpdateFolderPermissions

AwsAccountId => Str
FolderId => Str
[GrantPermissions => ArrayRef[Paws::Quicksight::ResourcePermission]]
[RevokePermissions => ArrayRef[Paws::Quicksight::ResourcePermission]]

Each argument is described in detail in: Paws::Quicksight::UpdateFolderPermissions

Returns: a Paws::Quicksight::UpdateFolderPermissionsResponse instance

Updates permissions of a folder.

UpdateGroup

AwsAccountId => Str
GroupName => Str
Namespace => Str
[Description => Str]

Each argument is described in detail in: Paws::Quicksight::UpdateGroup

Returns: a Paws::Quicksight::UpdateGroupResponse instance

Changes a group description.

UpdateIAMPolicyAssignment

AssignmentName => Str
AwsAccountId => Str
Namespace => Str
[AssignmentStatus => Str]
[Identities => Paws::Quicksight::IdentityMap]
[PolicyArn => Str]

Each argument is described in detail in: Paws::Quicksight::UpdateIAMPolicyAssignment

Returns: a Paws::Quicksight::UpdateIAMPolicyAssignmentResponse instance

Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in Identities.

UpdateTemplate

AwsAccountId => Str
SourceEntity => Paws::Quicksight::TemplateSourceEntity
TemplateId => Str
[Name => Str]
[VersionDescription => Str]

Each argument is described in detail in: Paws::Quicksight::UpdateTemplate

Returns: a Paws::Quicksight::UpdateTemplateResponse instance

Updates a template from an existing Amazon QuickSight analysis or another template.

UpdateTemplateAlias

AliasName => Str
AwsAccountId => Str
TemplateId => Str
TemplateVersionNumber => Int

Each argument is described in detail in: Paws::Quicksight::UpdateTemplateAlias

Returns: a Paws::Quicksight::UpdateTemplateAliasResponse instance

Updates the template alias of a template.

UpdateTemplatePermissions

AwsAccountId => Str
TemplateId => Str
[GrantPermissions => ArrayRef[Paws::Quicksight::ResourcePermission]]
[RevokePermissions => ArrayRef[Paws::Quicksight::ResourcePermission]]

Each argument is described in detail in: Paws::Quicksight::UpdateTemplatePermissions

Returns: a Paws::Quicksight::UpdateTemplatePermissionsResponse instance

Updates the resource permissions for a template.

UpdateTheme

AwsAccountId => Str
BaseThemeId => Str
ThemeId => Str
[Configuration => Paws::Quicksight::ThemeConfiguration]
[Name => Str]
[VersionDescription => Str]

Each argument is described in detail in: Paws::Quicksight::UpdateTheme

Returns: a Paws::Quicksight::UpdateThemeResponse instance

Updates a theme.

UpdateThemeAlias

AliasName => Str
AwsAccountId => Str
ThemeId => Str
ThemeVersionNumber => Int

Each argument is described in detail in: Paws::Quicksight::UpdateThemeAlias

Returns: a Paws::Quicksight::UpdateThemeAliasResponse instance

Updates an alias of a theme.

UpdateThemePermissions

AwsAccountId => Str
ThemeId => Str
[GrantPermissions => ArrayRef[Paws::Quicksight::ResourcePermission]]
[RevokePermissions => ArrayRef[Paws::Quicksight::ResourcePermission]]

Each argument is described in detail in: Paws::Quicksight::UpdateThemePermissions

Returns: a Paws::Quicksight::UpdateThemePermissionsResponse instance

Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme".

Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:

User
- "quicksight:DescribeTheme"
- "quicksight:DescribeThemeAlias"
- "quicksight:ListThemeAliases"
- "quicksight:ListThemeVersions"
Owner
- "quicksight:DescribeTheme"
- "quicksight:DescribeThemeAlias"
- "quicksight:ListThemeAliases"
- "quicksight:ListThemeVersions"
- "quicksight:DeleteTheme"
- "quicksight:UpdateTheme"
- "quicksight:CreateThemeAlias"
- "quicksight:DeleteThemeAlias"
- "quicksight:UpdateThemeAlias"
- "quicksight:UpdateThemePermissions"
- "quicksight:DescribeThemePermissions"
To specify no permissions, omit the permissions list.

UpdateUser

AwsAccountId => Str
Email => Str
Namespace => Str
Role => Str
UserName => Str
[CustomFederationProviderUrl => Str]
[CustomPermissionsName => Str]
[ExternalLoginFederationProviderType => Str]
[ExternalLoginId => Str]
[UnapplyCustomPermissions => Bool]

Each argument is described in detail in: Paws::Quicksight::UpdateUser

Returns: a Paws::Quicksight::UpdateUserResponse instance

Updates an Amazon QuickSight user.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results