AWS API Changes

2018/11/20 - Amazon QuickSight - 15 new api methods

Changes Update quicksight client to latest version

DescribeUser (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.describe_user(
    UserName='string',
    AwsAccountId='string',
    Namespace='string'
)

type UserName:

string

param UserName:

[REQUIRED]

The name of the user that you want to describe.

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

type Namespace:

string

param Namespace:

[REQUIRED]

The namespace. Currently, you should set this to default.

rtype:

dict

returns:

Response Syntax

{
    'User': {
        'Arn': 'string',
        'UserName': 'string',
        'Email': 'string',
        'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
        'IdentityType': 'IAM'|'QUICKSIGHT',
        'Active': True|False
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- User (dict) --
  
  The user name.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) for the user.
  - UserName (string) --
    
    The user's user name.
  - Email (string) --
    
    The user's email address.
  - Role (string) --
    
    The Amazon QuickSight role for the user.
  - IdentityType (string) --
    
    The type of identity authentication used by the user.
  - Active (boolean) --
    
    Active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an AD user, that user is inactive until they sign in and provide a password
- RequestId (string) --
  
  The AWS request ID for this operation.
- Status (integer) --
  
  The http status of the request.

GetDashboardEmbedUrl (new)

Link ¶

Generates an embedded URL and authorization code. Before this can work properly, you need to configure the dashboards and user permissions first.

See also: AWS API Documentation

Request Syntax

client.get_dashboard_embed_url(
    AwsAccountId='string',
    DashboardId='string',
    IdentityType='IAM'|'QUICKSIGHT',
    SessionLifetimeInMinutes=123,
    UndoRedoDisabled=True|False,
    ResetDisabled=True|False
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

AWS account ID that contains the dashboard you are embedding.

type DashboardId:

string

param DashboardId:

[REQUIRED]

The ID for the dashboard, also added to IAM policy

type IdentityType:

string

param IdentityType:

[REQUIRED]

The authentication method the user uses to sign in (IAM or QUICKSIGHT).

type SessionLifetimeInMinutes:

integer

param SessionLifetimeInMinutes:

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

type UndoRedoDisabled:

boolean

param UndoRedoDisabled:

Remove the undo/redo button on embedded dashboard. The default is FALSE, which enables the undo/redo button.

type ResetDisabled:

boolean

param ResetDisabled:

Remove the reset button on embedded dashboard. The default is FALSE, which allows the reset button.

rtype:

dict

returns:

Response Syntax

{
    'EmbedUrl': 'string',
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

(dict) --
- EmbedUrl (string) --
  
  Call the GetDashboardEmbedUrl API to get the URL that you can embed in your dashboard. This URL is valid for 5 minutes, and the resulting session is valid for 10 hours. The API provides the URL with an auth_code that enables a single-signon session.
- Status (integer) --
  
  The http status of the request.
- RequestId (string) --
  
  The AWS request ID for this operation.

CreateGroup (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.create_group(
    GroupName='string',
    Description='string',
    AwsAccountId='string',
    Namespace='string'
)

type GroupName:

string

param GroupName:

[REQUIRED]

A name for the group that you want to create.

type Description:

string

param Description:

A description for the group that you want to create.

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

type Namespace:

string

param Namespace:

[REQUIRED]

The namespace. Currently, you should set this to default.

rtype:

dict

returns:

Response Syntax

{
    'Group': {
        'Arn': 'string',
        'GroupName': 'string',
        'Description': 'string'
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --

The response object for this operation.
- Group (dict) --
  
  The name of the group.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) for the group.
  - GroupName (string) --
    
    The name of the group.
  - Description (string) --
    
    The group description.
- RequestId (string) --
  
  The AWS request ID for this operation.
- Status (integer) --
  
  The http status of the request.

DescribeGroup (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.describe_group(
    GroupName='string',
    AwsAccountId='string',
    Namespace='string'
)

type GroupName:

string

param GroupName:

[REQUIRED]

The name of the group that you want to describe.

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

type Namespace:

string

param Namespace:

[REQUIRED]

The namespace. Currently, you should set this to default.

rtype:

dict

returns:

Response Syntax

{
    'Group': {
        'Arn': 'string',
        'GroupName': 'string',
        'Description': 'string'
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- Group (dict) --
  
  The name of the group.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) for the group.
  - GroupName (string) --
    
    The name of the group.
  - Description (string) --
    
    The group description.
- RequestId (string) --
  
  The AWS request ID for this operation.
- Status (integer) --
  
  The http status of the request.

ListGroups (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.list_groups(
    AwsAccountId='string',
    NextToken='string',
    MaxResults=123,
    Namespace='string'
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

type NextToken:

string

param NextToken:

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

type MaxResults:

integer

param MaxResults:

The maximum number of results to return.

type Namespace:

string

param Namespace:

[REQUIRED]

The namespace. Currently, you should set this to default.

rtype:

dict

returns:

Response Syntax

{
    'GroupList': [
        {
            'Arn': 'string',
            'GroupName': 'string',
            'Description': 'string'
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- GroupList (list) --
  
  The list of the groups.
  - (dict) --
    
    A group in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security. Currently, an Amazon QuickSight subscription can't contain more than 500 Amazon QuickSight groups.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) for the group.
    - GroupName (string) --
      
      The name of the group.
    - Description (string) --
      
      The group description.
- NextToken (string) --
  
  A pagination token that can be used in a subsequent request.
- RequestId (string) --
  
  The AWS request ID for this operation.
- Status (integer) --
  
  The http status of the request.

UpdateUser (new)

Link ¶

Updates an Amazon QuickSight user.

See also: AWS API Documentation

Request Syntax

client.update_user(
    UserName='string',
    AwsAccountId='string',
    Namespace='string',
    Email='string',
    Role='ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER'
)

type UserName:

string

param UserName:

[REQUIRED]

The Amazon QuickSight user name that you want to update.

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

type Namespace:

string

param Namespace:

[REQUIRED]

The namespace. Currently, you should set this to default.

type Email:

string

param Email:

[REQUIRED]

The email address of the user that you want to update.

type Role:

string

param Role:

[REQUIRED]

The Amazon QuickSight role of the user. The user role can be one of the following:

READER: A user who has read-only access to dashboards.
AUTHOR: A user who can create data sources, data sets, analyses, and dashboards.
ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.

rtype:

dict

returns:

Response Syntax

{
    'User': {
        'Arn': 'string',
        'UserName': 'string',
        'Email': 'string',
        'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
        'IdentityType': 'IAM'|'QUICKSIGHT',
        'Active': True|False
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- User (dict) --
  
  The Amazon QuickSight user.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) for the user.
  - UserName (string) --
    
    The user's user name.
  - Email (string) --
    
    The user's email address.
  - Role (string) --
    
    The Amazon QuickSight role for the user.
  - IdentityType (string) --
    
    The type of identity authentication used by the user.
  - Active (boolean) --
    
    Active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an AD user, that user is inactive until they sign in and provide a password
- RequestId (string) --
  
  The AWS request ID for this operation.
- Status (integer) --
  
  The http status of the request.

UpdateGroup (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.update_group(
    GroupName='string',
    Description='string',
    AwsAccountId='string',
    Namespace='string'
)

type GroupName:

string

param GroupName:

[REQUIRED]

The name of the group that you want to update.

type Description:

string

param Description:

The description for the group that you want to update.

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

type Namespace:

string

param Namespace:

[REQUIRED]

The namespace. Currently, you should set this to default.

rtype:

dict

returns:

Response Syntax

{
    'Group': {
        'Arn': 'string',
        'GroupName': 'string',
        'Description': 'string'
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- Group (dict) --
  
  The name of the group.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) for the group.
  - GroupName (string) --
    
    The name of the group.
  - Description (string) --
    
    The group description.
- RequestId (string) --
  
  The AWS request ID for this operation.
- Status (integer) --
  
  The http status of the request.

ListUserGroups (new)

Link ¶

Lists the Amazon QuickSight groups that a user is part of.

See also: AWS API Documentation

Request Syntax

client.list_user_groups(
    UserName='string',
    AwsAccountId='string',
    Namespace='string',
    NextToken='string',
    MaxResults=123
)

type UserName:

string

param UserName:

[REQUIRED]

The name of the user that you want to list groups for.

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The AWS Account ID that the user is in. Currently, use the AWS Account ID which contains your Amazon QuickSight account.

type Namespace:

string

param Namespace:

[REQUIRED]

The namespace. Currently, you should set this to default.

type NextToken:

string

param NextToken:

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

type MaxResults:

integer

param MaxResults:

The maximum number of results to return from this request.

rtype:

dict

returns:

Response Syntax

{
    'GroupList': [
        {
            'Arn': 'string',
            'GroupName': 'string',
            'Description': 'string'
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- GroupList (list) --
  
  The list of groups the user is a member of.
  - (dict) --
    
    A group in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security. Currently, an Amazon QuickSight subscription can't contain more than 500 Amazon QuickSight groups.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) for the group.
    - GroupName (string) --
      
      The name of the group.
    - Description (string) --
      
      The group description.
- NextToken (string) --
  
  A pagination token that can be used in a subsequent request.
- RequestId (string) --
  
  The AWS request ID for this operation.
- Status (integer) --
  
  The http status of the request.

DeleteUser (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.delete_user(
    UserName='string',
    AwsAccountId='string',
    Namespace='string'
)

type UserName:

string

param UserName:

[REQUIRED]

The name of the user that you want to delete.

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

type Namespace:

string

param Namespace:

[REQUIRED]

The namespace. Currently, you should set this to default.

rtype:

dict

returns:

Response Syntax

{
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- RequestId (string) --
  
  The AWS request ID for this operation.
- Status (integer) --
  
  The http status of the request.

ListGroupMemberships (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.list_group_memberships(
    GroupName='string',
    NextToken='string',
    MaxResults=123,
    AwsAccountId='string',
    Namespace='string'
)

type GroupName:

string

param GroupName:

[REQUIRED]

The name of the group that you want to see a membership list of.

type NextToken:

string

param NextToken:

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

type MaxResults:

integer

param MaxResults:

The maximum number of results to return from this request.

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

type Namespace:

string

param Namespace:

[REQUIRED]

The namespace. Currently, you should set this to default.

rtype:

dict

returns:

Response Syntax

{
    'GroupMemberList': [
        {
            'Arn': 'string',
            'MemberName': 'string'
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- GroupMemberList (list) --
  
  The list of the members of the group.
  - (dict) --
    
    A member of an Amazon QuickSight group. Currently, group members must be users. Groups can't be members of another group.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) for the group member (user).
    - MemberName (string) --
      
      The name of the group member (user).
- NextToken (string) --
  
  A pagination token that can be used in a subsequent request.
- RequestId (string) --
  
  The AWS request ID for this operation.
- Status (integer) --
  
  The http status of the request.

RegisterUser (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.register_user(
    IdentityType='IAM'|'QUICKSIGHT',
    Email='string',
    UserRole='ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
    IamArn='string',
    SessionName='string',
    AwsAccountId='string',
    Namespace='string',
    UserName='string'
)

type IdentityType:

string

param IdentityType:

[REQUIRED]

Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:

IAM: A user whose identity maps to an existing IAM user or role.
QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.

type Email:

string

param Email:

[REQUIRED]

The email address of the user that you want to register.

type UserRole:

string

param UserRole:

[REQUIRED]

The Amazon QuickSight role of the user. The user role can be one of the following:

READER: A user who has read-only access to dashboards.
AUTHOR: A user who can create data sources, data sets, analyses, and dashboards.
ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.

type IamArn:

string

param IamArn:

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

type SessionName:

string

param SessionName:

The name of the session with the assumed IAM role. By using this parameter, you can register multiple users with the same IAM role, provided that each has a different session name. For more information on assuming IAM roles, see assume-role in the AWS CLI Reference.

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

type Namespace:

string

param Namespace:

[REQUIRED]

The namespace. Currently, you should set this to default.

type UserName:

string

param UserName:

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

rtype:

dict

returns:

Response Syntax

{
    'User': {
        'Arn': 'string',
        'UserName': 'string',
        'Email': 'string',
        'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
        'IdentityType': 'IAM'|'QUICKSIGHT',
        'Active': True|False
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- User (dict) --
  
  The user name.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) for the user.
  - UserName (string) --
    
    The user's user name.
  - Email (string) --
    
    The user's email address.
  - Role (string) --
    
    The Amazon QuickSight role for the user.
  - IdentityType (string) --
    
    The type of identity authentication used by the user.
  - Active (boolean) --
    
    Active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an AD user, that user is inactive until they sign in and provide a password
- RequestId (string) --
  
  The AWS request ID for this operation.
- Status (integer) --
  
  The http status of the request.

CreateGroupMembership (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.create_group_membership(
    MemberName='string',
    GroupName='string',
    AwsAccountId='string',
    Namespace='string'
)

type MemberName:

string

param MemberName:

[REQUIRED]

The name of the user that you want to add to the group membership.

type GroupName:

string

param GroupName:

[REQUIRED]

The name of the group that you want to add the user to.

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

type Namespace:

string

param Namespace:

[REQUIRED]

The namespace. Currently, you should set this to default.

rtype:

dict

returns:

Response Syntax

{
    'GroupMember': {
        'Arn': 'string',
        'MemberName': 'string'
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- GroupMember (dict) --
  
  The group member.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) for the group member (user).
  - MemberName (string) --
    
    The name of the group member (user).
- RequestId (string) --
  
  The AWS request ID for this operation.
- Status (integer) --
  
  The http status of the request.

ListUsers (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.list_users(
    AwsAccountId='string',
    NextToken='string',
    MaxResults=123,
    Namespace='string'
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

type NextToken:

string

param NextToken:

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

type MaxResults:

integer

param MaxResults:

The maximum number of results to return from this request.

type Namespace:

string

param Namespace:

[REQUIRED]

The namespace. Currently, you should set this to default.

rtype:

dict

returns:

Response Syntax

{
    'UserList': [
        {
            'Arn': 'string',
            'UserName': 'string',
            'Email': 'string',
            'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
            'IdentityType': 'IAM'|'QUICKSIGHT',
            'Active': True|False
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- UserList (list) --
  
  The list of users.
  - (dict) --
    
    A registered user of Amazon QuickSight. Currently, an Amazon QuickSight subscription can't contain more than 20 million users.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) for the user.
    - UserName (string) --
      
      The user's user name.
    - Email (string) --
      
      The user's email address.
    - Role (string) --
      
      The Amazon QuickSight role for the user.
    - IdentityType (string) --
      
      The type of identity authentication used by the user.
    - Active (boolean) --
      
      Active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an AD user, that user is inactive until they sign in and provide a password
- NextToken (string) --
  
  A pagination token that can be used in a subsequent request.
- RequestId (string) --
  
  The AWS request ID for this operation.
- Status (integer) --
  
  The http status of the request.

DeleteGroupMembership (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.delete_group_membership(
    MemberName='string',
    GroupName='string',
    AwsAccountId='string',
    Namespace='string'
)

type MemberName:

string

param MemberName:

[REQUIRED]

The name of the user that you want to delete from the group membership.

type GroupName:

string

param GroupName:

[REQUIRED]

The name of the group that you want to delete the user from.

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

type Namespace:

string

param Namespace:

[REQUIRED]

The namespace. Currently, you should set this to default.

rtype:

dict

returns:

Response Syntax

{
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- RequestId (string) --
  
  The AWS request ID for this operation.
- Status (integer) --
  
  The http status of the request.

DeleteGroup (new)

Link ¶

Removes a user group from Amazon QuickSight.

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

See also: AWS API Documentation

Request Syntax

client.delete_group(
    GroupName='string',
    AwsAccountId='string',
    Namespace='string'
)

type GroupName:

string

param GroupName:

[REQUIRED]

The name of the group that you want to delete.

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

type Namespace:

string

param Namespace:

[REQUIRED]

The namespace. Currently, you should set this to default.

rtype:

dict

returns:

Response Syntax

{
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) --
- RequestId (string) --
  
  The AWS request ID for this operation.
- Status (integer) --
  
  The http status of the request.