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
Each argument is described in detail in: Paws::Quicksight::CancelIngestion
Returns: a Paws::Quicksight::CancelIngestionResponse instance
Cancels an ongoing ingestion of data into SPICE.
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]]
- [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. The CreateDashboard, DescribeDashboard, and ListDashboardsByUser API operations act on the dashboard entity. 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]]
- [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.
CreateGroup
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
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 will be assigned to specified groups or users of Amazon QuickSight. The users and groups need to be in the same namespace.
CreateIngestion
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? (https://aws.example.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.
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
Each argument is described in detail in: Paws::Quicksight::CreateTemplateAlias
Returns: a Paws::Quicksight::CreateTemplateAliasResponse instance
Creates a template alias for a template.
DeleteDashboard
Each argument is described in detail in: Paws::Quicksight::DeleteDashboard
Returns: a Paws::Quicksight::DeleteDashboardResponse instance
Deletes a dashboard.
DeleteDataSet
Each argument is described in detail in: Paws::Quicksight::DeleteDataSet
Returns: a Paws::Quicksight::DeleteDataSetResponse instance
Deletes a dataset.
DeleteDataSource
Each argument is described in detail in: Paws::Quicksight::DeleteDataSource
Returns: a Paws::Quicksight::DeleteDataSourceResponse instance
Deletes the data source permanently. This action breaks all the datasets that reference the deleted data source.
DeleteGroup
Each argument is described in detail in: Paws::Quicksight::DeleteGroup
Returns: a Paws::Quicksight::DeleteGroupResponse instance
Removes a user group from Amazon QuickSight.
DeleteGroupMembership
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
Each argument is described in detail in: Paws::Quicksight::DeleteIAMPolicyAssignment
Returns: a Paws::Quicksight::DeleteIAMPolicyAssignmentResponse instance
Deletes an existing IAM policy assignment.
DeleteTemplate
Each argument is described in detail in: Paws::Quicksight::DeleteTemplate
Returns: a Paws::Quicksight::DeleteTemplateResponse instance
Deletes a template.
DeleteTemplateAlias
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.
DeleteUser
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
Each argument is described in detail in: Paws::Quicksight::DeleteUserByPrincipalId
Returns: a Paws::Quicksight::DeleteUserByPrincipalIdResponse instance
Deletes a user identified by its principal ID.
DescribeDashboard
Each argument is described in detail in: Paws::Quicksight::DescribeDashboard
Returns: a Paws::Quicksight::DescribeDashboardResponse instance
Provides a summary for a dashboard.
DescribeDashboardPermissions
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
Each argument is described in detail in: Paws::Quicksight::DescribeDataSet
Returns: a Paws::Quicksight::DescribeDataSetResponse instance
Describes a dataset.
DescribeDataSetPermissions
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
Each argument is described in detail in: Paws::Quicksight::DescribeDataSource
Returns: a Paws::Quicksight::DescribeDataSourceResponse instance
Describes a data source.
DescribeDataSourcePermissions
Each argument is described in detail in: Paws::Quicksight::DescribeDataSourcePermissions
Returns: a Paws::Quicksight::DescribeDataSourcePermissionsResponse instance
Describes the resource permissions for a data source.
DescribeGroup
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
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
Each argument is described in detail in: Paws::Quicksight::DescribeIngestion
Returns: a Paws::Quicksight::DescribeIngestionResponse instance
Describes a SPICE ingestion.
DescribeTemplate
Each argument is described in detail in: Paws::Quicksight::DescribeTemplate
Returns: a Paws::Quicksight::DescribeTemplateResponse instance
Describes a template's metadata.
DescribeTemplateAlias
Each argument is described in detail in: Paws::Quicksight::DescribeTemplateAlias
Returns: a Paws::Quicksight::DescribeTemplateAliasResponse instance
Describes the template alias for a template.
DescribeTemplatePermissions
Each argument is described in detail in: Paws::Quicksight::DescribeTemplatePermissions
Returns: a Paws::Quicksight::DescribeTemplatePermissionsResponse instance
Describes read and write permissions on a template.
DescribeUser
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
- [ResetDisabled => Bool]
- [SessionLifetimeInMinutes => Int]
- [UndoRedoDisabled => Bool]
- [UserArn => Str]
Each argument is described in detail in: Paws::Quicksight::GetDashboardEmbedUrl
Returns: a Paws::Quicksight::GetDashboardEmbedUrlResponse instance
Generates a server-side embeddable URL and authorization code. For this process to work properly, first configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards (https://docs.aws.amazon.com/quicksight/latest/user/embedding-dashboards.html) in the Amazon QuickSight User Guide or Embedding Amazon QuickSight Dashboards (https://docs.aws.amazon.com/quicksight/latest/APIReference/qs-dev-embedded-dashboards.html) in the Amazon QuickSight API Reference.
Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser.
ListDashboards
Each argument is described in detail in: Paws::Quicksight::ListDashboards
Returns: a Paws::Quicksight::ListDashboardsResponse instance
Lists dashboards in an AWS account.
ListDashboardVersions
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
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
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.
ListGroupMemberships
Each argument is described in detail in: Paws::Quicksight::ListGroupMemberships
Returns: a Paws::Quicksight::ListGroupMembershipsResponse instance
Lists member users in a group.
ListGroups
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
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
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.
ListTagsForResource
Each argument is described in detail in: Paws::Quicksight::ListTagsForResource
Returns: a Paws::Quicksight::ListTagsForResourceResponse instance
Lists the tags assigned to a resource.
ListTemplateAliases
Each argument is described in detail in: Paws::Quicksight::ListTemplateAliases
Returns: a Paws::Quicksight::ListTemplateAliasesResponse instance
Lists all the aliases of a template.
ListTemplates
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
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.
ListUserGroups
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
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
- [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.
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
Each argument is described in detail in: Paws::Quicksight::UntagResource
Returns: a Paws::Quicksight::UntagResourceResponse instance
Removes a tag or tags from a resource.
UpdateDashboard
- AwsAccountId => Str
- DashboardId => Str
- Name => Str
- SourceEntity => Paws::Quicksight::DashboardSourceEntity
- [DashboardPublishOptions => Paws::Quicksight::DashboardPublishOptions]
- [Parameters => Paws::Quicksight::Parameters]
- [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
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]]
- [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.
UpdateGroup
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.
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
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.
UpdateUser
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
SEE ALSO
This service class forms part of Paws
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues