AbstractAmazonQuickSight (AWS Java SDK for Amazon QuickSight 1.11.641 API)

java.lang.Object
- com.amazonaws.services.quicksight.AbstractAmazonQuickSight

All Implemented Interfaces:

AmazonQuickSight

Direct Known Subclasses:

AbstractAmazonQuickSightAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonQuickSight
extends Object
implements AmazonQuickSight
```
Abstract implementation of AmazonQuickSight. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.quicksight.AmazonQuickSight
  ENDPOINT_PREFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractAmazonQuickSight()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractAmazonQuickSight()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateGroupResult`	`createGroup(CreateGroupRequest request)` Creates an Amazon QuickSight group.
`CreateGroupMembershipResult`	`createGroupMembership(CreateGroupMembershipRequest request)` Adds an Amazon QuickSight user to an Amazon QuickSight group.
`DeleteGroupResult`	`deleteGroup(DeleteGroupRequest request)` Removes a user group from Amazon QuickSight.
`DeleteGroupMembershipResult`	`deleteGroupMembership(DeleteGroupMembershipRequest request)` Removes a user from a group so that the user is no longer a member of the group.
`DeleteUserResult`	`deleteUser(DeleteUserRequest request)` 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.
`DeleteUserByPrincipalIdResult`	`deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest request)` Deletes a user identified by its principal ID.
`DescribeGroupResult`	`describeGroup(DescribeGroupRequest request)` Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
`DescribeUserResult`	`describeUser(DescribeUserRequest request)` Returns information about a user, given the user name.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetDashboardEmbedUrlResult`	`getDashboardEmbedUrl(GetDashboardEmbedUrlRequest request)` Generates a server-side embeddable URL and authorization code.
`ListGroupMembershipsResult`	`listGroupMemberships(ListGroupMembershipsRequest request)` Lists member users in a group.
`ListGroupsResult`	`listGroups(ListGroupsRequest request)` Lists all user groups in Amazon QuickSight.
`ListUserGroupsResult`	`listUserGroups(ListUserGroupsRequest request)` Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
`ListUsersResult`	`listUsers(ListUsersRequest request)` Returns a list of all of the Amazon QuickSight users belonging to this account.
`RegisterUserResult`	`registerUser(RegisterUserRequest request)` Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`UpdateGroupResult`	`updateGroup(UpdateGroupRequest request)` Changes a group description.
`UpdateUserResult`	`updateUser(UpdateUserRequest request)` Updates an Amazon QuickSight user.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractAmazonQuickSight
```
protected AbstractAmazonQuickSight()
```
- Method Detail
  - createGroup
```
public CreateGroupResult createGroup(CreateGroupRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    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"
    
    Specified by:
    
    createGroup in interface AmazonQuickSight
    
    Parameters:
    
    request - The request object for this operation.
    
    Returns:
    
    Result of the CreateGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createGroupMembership
```
public CreateGroupMembershipResult createGroupMembership(CreateGroupMembershipRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    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
    
    Specified by:
    
    createGroupMembership in interface AmazonQuickSight
    
    Returns:
    
    Result of the CreateGroupMembership operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteGroup
```
public DeleteGroupResult deleteGroup(DeleteGroupRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    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
    
    Specified by:
    
    deleteGroup in interface AmazonQuickSight
    
    Returns:
    
    Result of the DeleteGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteGroupMembership
```
public DeleteGroupMembershipResult deleteGroupMembership(DeleteGroupMembershipRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    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
    
    Specified by:
    
    deleteGroupMembership in interface AmazonQuickSight
    
    Returns:
    
    Result of the DeleteGroupMembership operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
public DeleteUserResult deleteUser(DeleteUserRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    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
    
    Specified by:
    
    deleteUser in interface AmazonQuickSight
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteUserByPrincipalId
```
public DeleteUserByPrincipalIdResult deleteUserByPrincipalId(DeleteUserByPrincipalIdRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Deletes a user identified by its principal ID.
    
    The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .
    
    CLI Sample:
    
    aws quicksight delete-user-by-principal-id --aws-account-id=111122223333 --namespace=default --principal-id=ABCDEFJA26JLI7EUUOEHS
    
    Specified by:
    
    deleteUserByPrincipalId in interface AmazonQuickSight
    
    Returns:
    
    Result of the DeleteUserByPrincipalId operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeGroup
```
public DescribeGroupResult describeGroup(DescribeGroupRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    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
    
    Specified by:
    
    describeGroup in interface AmazonQuickSight
    
    Returns:
    
    Result of the DescribeGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeUser
```
public DescribeUserResult describeUser(DescribeUserRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    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
    
    Specified by:
    
    describeUser in interface AmazonQuickSight
    
    Returns:
    
    Result of the DescribeUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDashboardEmbedUrl
```
public GetDashboardEmbedUrlResult getDashboardEmbedUrl(GetDashboardEmbedUrlRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    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.
    
    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 [email protected] --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
    
    Specified by:
    
    getDashboardEmbedUrl in interface AmazonQuickSight
    
    Returns:
    
    Result of the GetDashboardEmbedUrl operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listGroupMemberships
```
public ListGroupMembershipsResult listGroupMemberships(ListGroupMembershipsRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    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
    
    Specified by:
    
    listGroupMemberships in interface AmazonQuickSight
    
    Returns:
    
    Result of the ListGroupMemberships operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listGroups
```
public ListGroupsResult listGroups(ListGroupsRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    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
    
    Specified by:
    
    listGroups in interface AmazonQuickSight
    
    Returns:
    
    Result of the ListGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUserGroups
```
public ListUserGroupsResult listUserGroups(ListUserGroupsRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    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
    
    Specified by:
    
    listUserGroups in interface AmazonQuickSight
    
    Returns:
    
    Result of the ListUserGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUsers
```
public ListUsersResult listUsers(ListUsersRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    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
    
    Specified by:
    
    listUsers in interface AmazonQuickSight
    
    Returns:
    
    Result of the ListUsers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - registerUser
```
public RegisterUserResult registerUser(RegisterUserRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    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 protected] -\-identity-type=IAM -\-user-role=AUTHOR -\-iam-arn=arn:aws:iam::111122223333:user/Pat
    
    Specified by:
    
    registerUser in interface AmazonQuickSight
    
    Returns:
    
    Result of the RegisterUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateGroup
```
public UpdateGroupResult updateGroup(UpdateGroupRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    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"
    
    Specified by:
    
    updateGroup in interface AmazonQuickSight
    
    Returns:
    
    Result of the UpdateGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateUser
```
public UpdateUserResult updateUser(UpdateUserRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    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 protected] --aws-account-id=111122223333 --namespace=default --region=us-east-1
    
    Specified by:
    
    updateUser in interface AmazonQuickSight
    
    Returns:
    
    Result of the UpdateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonQuickSight
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonQuickSight
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonQuickSight
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonQuickSight
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Class AbstractAmazonQuickSight

Field Summary

Fields inherited from interface com.amazonaws.services.quicksight.AmazonQuickSight

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractAmazonQuickSight

Method Detail

createGroup

createGroupMembership

deleteGroup

deleteGroupMembership

deleteUser

deleteUserByPrincipalId

describeGroup

describeUser

getDashboardEmbedUrl

listGroupMemberships

listGroups

listUserGroups

listUsers

registerUser

updateGroup

updateUser

shutdown

getCachedResponseMetadata