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, cloud business intelligence service that makes it easy to extend data and insights to every user in your organization. This API interface 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

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.

CLI Sample:

aws quicksight create-group --aws-account-id=111122223333 --namespace=default --group-name="Sales-Management" --description="Sales Management - Forecasting"

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.

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

The condition resource is the user name.

The condition key is quicksight:UserName.

The response is the group member object.

CLI Sample:

aws quicksight create-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales --member-name=Pat

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.

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

CLI Sample:

aws quicksight delete-group -\-aws-account-id=111122223333 -\-namespace=default -\-group-name=Sales-Management

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.

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

The condition resource is the user name.

The condition key is quicksight:UserName.

CLI Sample:

aws quicksight delete-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales-Management --member-name=Charlie

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.

The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

CLI Sample:

aws quicksight delete-user --aws-account-id=111122223333 --namespace=default --user-name=Pat

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

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

The response is the group object.

CLI Sample:

aws quicksight describe-group -\-aws-account-id=11112222333 -\-namespace=default -\-group-name=Sales

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.

The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

The response is a user object that contains the user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.

CLI Sample:

aws quicksight describe-user --aws-account-id=111122223333 --namespace=default --user-name=Pat

GetDashboardEmbedUrl

AwsAccountId => Str
DashboardId => Str
IdentityType => Str
[ResetDisabled => Bool]
[SessionLifetimeInMinutes => Int]
[UndoRedoDisabled => Bool]

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. Before this can work properly, first you need to configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards (https://docs.aws.amazon.com/en_us/quicksight/latest/user/embedding.html).

Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser.

CLI Sample:

Assume the role with permissions enabled for actions: quickSight:RegisterUser and quicksight:GetDashboardEmbedURL. You can use assume-role, assume-role-with-web-identity, or assume-role-with-saml.

aws sts assume-role --role-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --role-session-name embeddingsession

If the user does not exist in QuickSight, register the user:

aws quicksight register-user --aws-account-id 111122223333 --namespace default --identity-type IAM --iam-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --user-role READER --session-name "embeddingsession" --email user123@example.com --region us-east-1

Get the URL for the embedded dashboard

aws quicksight get-dashboard-embed-url --aws-account-id 111122223333 --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type IAM

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.

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

The response is a list of group member objects.

CLI Sample:

aws quicksight list-group-memberships -\-aws-account-id=111122223333 -\-namespace=default

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.

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

The response is a list of group objects.

CLI Sample:

aws quicksight list-groups -\-aws-account-id=111122223333 -\-namespace=default

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.

The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

The response is a one or more group objects.

CLI Sample:

aws quicksight list-user-groups -\-user-name=Pat -\-aws-account-id=111122223333 -\-namespace=default -\-region=us-east-1

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.

The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/* .

The response is a list of user objects, containing each user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.

CLI Sample:

aws quicksight list-users --aws-account-id=111122223333 --namespace=default

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.

The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

The condition resource is the Amazon Resource Name (ARN) for the IAM user or role, and the session name.

The condition keys are quicksight:IamArn and quicksight:SessionName.

CLI Sample:

aws quicksight register-user -\-aws-account-id=111122223333 -\-namespace=default -\-email=pat@example.com -\-identity-type=IAM -\-user-role=AUTHOR -\-iam-arn=arn:aws:iam::111122223333:user/Pat

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.

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

The response is a group object.

CLI Sample:

aws quicksight update-group --aws-account-id=111122223333 --namespace=default --group-name=Sales --description="Sales BI Dashboards"

UpdateUser

AwsAccountId => Str
Email => Str
Namespace => Str
Role => Str
UserName => Str

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

Returns: a Paws::Quicksight::UpdateUserResponse instance

Updates an Amazon QuickSight user.

The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

The response is a user object that contains the user's Amazon QuickSight user name, email address, active or inactive status in Amazon QuickSight, Amazon QuickSight role, and Amazon Resource Name (ARN).

CLI Sample:

aws quicksight update-user --user-name=Pat --role=ADMIN --email=new_address@amazon.com --aws-account-id=111122223333 --namespace=default --region=us-east-1

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