AWS API Changes

2021/06/23 - Amazon QuickSight - 12 new api methods

Changes Releasing new APIs for AWS QuickSight Folders

UpdateFolderPermissions (new)

Updates permissions of a folder.

Request Syntax

client.update_folder_permissions(
    AwsAccountId='string',
    FolderId='string',
    GrantPermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    RevokePermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ]
)

type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The AWS account ID.

type FolderId

string

param FolderId

[REQUIRED]

The folder ID.

type GrantPermissions

list

param GrantPermissions

The permissions that you want to grant on a resource.

(dict) --

Permission for the resource.
- Principal (string) -- [REQUIRED]
  
  The Amazon Resource Name (ARN) of the principal. This can be one of the following:
  - The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
  - The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
  - The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.)
- Actions (list) -- [REQUIRED]
  
  The IAM action to grant or revoke permissions on.
  - (string) --

type RevokePermissions

list

param RevokePermissions

The permissions that you want to revoke from a resource.

(dict) --

Permission for the resource.
- Principal (string) -- [REQUIRED]
  
  The Amazon Resource Name (ARN) of the principal. This can be one of the following:
  - The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
  - The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
  - The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.)
- Actions (list) -- [REQUIRED]
  
  The IAM action to grant or revoke permissions on.
  - (string) --

rtype

dict

returns

Response Syntax

{
    'Status': 123,
    'Arn': 'string',
    'FolderId': 'string',
    'Permissions': [
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    'RequestId': 'string'
}

Response Structure

(dict) --
- Status (integer) --
  
  The status. If succeeded, the status is SC_OK .
- Arn (string) --
  
  The Amazon Resource Name (ARN).
- FolderId (string) --
  
  The folder ID.
- Permissions (list) --
  
  Information about the permissions on the dashboard.
  - (dict) --
    
    Permission for the resource.
    - Principal (string) --
      
      The Amazon Resource Name (ARN) of the principal. This can be one of the following:
      - The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
      - The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
      - The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.)
    - Actions (list) --
      
      The IAM action to grant or revoke permissions on.
      - (string) --
- RequestId (string) --
  
  The request ID.

UpdateFolder (new)

Link ¶

Updates the name of a folder.

See also: AWS API Documentation

Request Syntax

client.update_folder(
    AwsAccountId='string',
    FolderId='string',
    Name='string'
)

type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The AWS account ID.

type FolderId

string

param FolderId

[REQUIRED]

The folder ID.

type Name

string

param Name

[REQUIRED]

The name of the folder.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- Status (integer) --
  
  The status. If succeeded, the status is SC_OK .
- Arn (string) --
  
  The Amazon Resource Name (ARN).
- FolderId (string) --
  
  The folder ID.
- RequestId (string) --
  
  The request ID.

DeleteFolder (new)

Link ¶

Deletes an empty folder.

See also: AWS API Documentation

Request Syntax

client.delete_folder(
    AwsAccountId='string',
    FolderId='string'
)

type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The AWS Account ID for the folder.

type FolderId

string

param FolderId

[REQUIRED]

The folder ID.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- Status (integer) --
  
  The status of deleting the folder. If succeeded, the status is SC_OK (200) .
- Arn (string) --
  
  The Amazon Resource Name of the deleted folder.
- FolderId (string) --
  
  The folder ID.
- RequestId (string) --
  
  The request ID.

ListFolderMembers (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.list_folder_members(
    AwsAccountId='string',
    FolderId='string',
    NextToken='string',
    MaxResults=123
)

type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The AWS account ID.

type FolderId

string

param FolderId

[REQUIRED]

The folder ID.

type NextToken

string

param NextToken

The token for the next set of results, or null if there are no more results.

type MaxResults

integer

param MaxResults

The maximum number of results to be returned per request.

rtype

dict

returns

Response Syntax

{
    'Status': 123,
    'FolderMemberList': [
        {
            'MemberId': 'string',
            'MemberArn': 'string'
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string'
}

Response Structure

(dict) --
- Status (integer) --
  
  The status. If succeeded, the status is SC_OK
- FolderMemberList (list) --
  
  A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.
  - (dict) --
    
    An object that consists of the member Amazon Resource Name (ARN) and member ID.
    - MemberId (string) --
      
      The ID of the member.
    - MemberArn (string) --
      
      The Amazon Resource Name (ARN) of the member.
- NextToken (string) --
  
  The token for the next set of results, or null if there are no more results.
- RequestId (string) --
  
  The request ID.

ListFolders (new)

Link ¶

Lists all folders in an account.

See also: AWS API Documentation

Request Syntax

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

type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The AWS account ID.

type NextToken

string

param NextToken

The token for the next set of results, or null if there are no more results.

type MaxResults

integer

param MaxResults

The maximum number of results to be returned per request.

rtype

dict

returns

Response Syntax

{
    'Status': 123,
    'FolderSummaryList': [
        {
            'Arn': 'string',
            'FolderId': 'string',
            'Name': 'string',
            'FolderType': 'SHARED',
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string'
}

Response Structure

(dict) --
- Status (integer) --
  
  The status. If succeeded, the status is SC_OK
- FolderSummaryList (list) --
  
  A structure that contains all of the folders in your AWS account. This structure provides basic information about the folders.
  - (dict) --
    
    A summary of the folder.
    - Arn (string) --
      
      The Amazon Resource Name (ARN).
    - FolderId (string) --
      
      The folder ID.
    - Name (string) --
      
      The display name of the folder.
    - FolderType (string) --
      
      The type of folder.
    - CreatedTime (datetime) --
      
      The time that the folder was created.
    - LastUpdatedTime (datetime) --
      
      The time that the folder was last updated.
- NextToken (string) --
  
  The token for the next set of results, or null if there are no more results.
- RequestId (string) --
  
  The request ID.

CreateFolderMembership (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.create_folder_membership(
    AwsAccountId='string',
    FolderId='string',
    MemberId='string',
    MemberType='DASHBOARD'|'ANALYSIS'|'DATASET'
)

type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The AWS Account ID.

type FolderId

string

param FolderId

[REQUIRED]

The folder ID.

type MemberId

string

param MemberId

[REQUIRED]

The ID of the asset (the dashboard, analysis, or dataset).

type MemberType

string

param MemberType

[REQUIRED]

The type of the member, including DASHBOARD , ANALYSIS , and DATASET .

rtype

dict

returns

Response Syntax

{
    'Status': 123,
    'FolderMember': {
        'MemberId': 'string',
        'MemberType': 'DASHBOARD'|'ANALYSIS'|'DATASET'
    },
    'RequestId': 'string'
}

Response Structure

(dict) --
- Status (integer) --
  
  The status of the folder membership. If succeeded, the status is SC_OK (200) .
- FolderMember (dict) --
  
  Information about the member in the folder.
  - MemberId (string) --
    
    The ID of the asset.
  - MemberType (string) --
    
    The type of the asset.
- RequestId (string) --
  
  The request ID.

CreateFolder (new)

Link ¶

Creates an empty shared folder.

See also: AWS API Documentation

Request Syntax

client.create_folder(
    AwsAccountId='string',
    FolderId='string',
    Name='string',
    FolderType='SHARED',
    ParentFolderArn='string',
    Permissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The AWS Account ID.

type FolderId

string

param FolderId

[REQUIRED]

The folder ID.

type Name

string

param Name

The name of the folder.

type FolderType

string

param FolderType

The type of folder. By default, folderType is SHARED .

type ParentFolderArn

string

param ParentFolderArn

The Amazon Resource Name (ARN) for the parent folder.

ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

type Permissions

list

param Permissions

A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions .

(dict) --

Permission for the resource.
- Principal (string) -- [REQUIRED]
  
  The Amazon Resource Name (ARN) of the principal. This can be one of the following:
  - The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
  - The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
  - The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.)
- Actions (list) -- [REQUIRED]
  
  The IAM action to grant or revoke permissions on.
  - (string) --

type Tags

list

param Tags

Tags for the folder.

(dict) --

The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
- Key (string) -- [REQUIRED]
  
  Tag key.
- Value (string) -- [REQUIRED]
  
  Tag value.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- Status (integer) --
  
  The status of the newly created folder. If succeeded, the status is SC_OK (200) .
- Arn (string) --
  
  The Amazon Resource Name (ARN) for the newly created folder.
- FolderId (string) --
  
  The folder ID for the newly created folder.
- RequestId (string) --
  
  The request ID for the newly created folder.

DescribeFolder (new)

Link ¶

Describes a folder.

See also: AWS API Documentation

Request Syntax

client.describe_folder(
    AwsAccountId='string',
    FolderId='string'
)

type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The AWS account ID.

type FolderId

string

param FolderId

[REQUIRED]

The folder ID.

rtype

dict

returns

Response Syntax

{
    'Status': 123,
    'Folder': {
        'FolderId': 'string',
        'Arn': 'string',
        'Name': 'string',
        'FolderType': 'SHARED',
        'FolderPath': [
            'string',
        ],
        'CreatedTime': datetime(2015, 1, 1),
        'LastUpdatedTime': datetime(2015, 1, 1)
    },
    'RequestId': 'string'
}

Response Structure

(dict) --
- Status (integer) --
  
  The status. If succeeded, the status is SC_OK (200) .
- Folder (dict) --
  
  Information about the folder.
  - FolderId (string) --
    
    The folder ID.
  - Arn (string) --
    
    The folder Amazon Resource Name (ARN).
  - Name (string) --
    
    A display name for the folder.
  - FolderType (string) --
    
    The type of the folder.
  - FolderPath (list) --
    
    An array of ancestor folder ARN strings.
    - (string) --
  - CreatedTime (datetime) --
    
    The time that the folder was created.
  - LastUpdatedTime (datetime) --
    
    The time that the folder was last updated.
- RequestId (string) --
  
  The request ID.

DescribeFolderPermissions (new)

Link ¶

Describes permissions for a folder.

See also: AWS API Documentation

Request Syntax

client.describe_folder_permissions(
    AwsAccountId='string',
    FolderId='string'
)

type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The AWS Account ID.

type FolderId

string

param FolderId

[REQUIRED]

The folder ID.

rtype

dict

returns

Response Syntax

{
    'Status': 123,
    'FolderId': 'string',
    'Arn': 'string',
    'Permissions': [
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    'RequestId': 'string'
}

Response Structure

(dict) --
- Status (integer) --
  
  The status. If succeeded, the status is SC_OK .
- FolderId (string) --
  
  The folder ID.
- Arn (string) --
  
  The Amazon Resource Name (ARN) for the folder.
- Permissions (list) --
  
  Information about the permissions on the folder.
  - (dict) --
    
    Permission for the resource.
    - Principal (string) --
      
      The Amazon Resource Name (ARN) of the principal. This can be one of the following:
      - The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
      - The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
      - The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.)
    - Actions (list) --
      
      The IAM action to grant or revoke permissions on.
      - (string) --
- RequestId (string) --
  
  The request ID.

DescribeFolderResolvedPermissions (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.describe_folder_resolved_permissions(
    AwsAccountId='string',
    FolderId='string'
)

type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The AWS account ID.

type FolderId

string

param FolderId

[REQUIRED]

The folder ID.

rtype

dict

returns

Response Syntax

{
    'Status': 123,
    'FolderId': 'string',
    'Arn': 'string',
    'Permissions': [
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    'RequestId': 'string'
}

Response Structure

(dict) --
- Status (integer) --
  
  The status. If succeeded, the status is SC_OK
- FolderId (string) --
  
  The folder ID.
- Arn (string) --
  
  The Amazon Resource Name (ARN).
- Permissions (list) --
  
  Information about the permissions on the dashboard.
  - (dict) --
    
    Permission for the resource.
    - Principal (string) --
      
      The Amazon Resource Name (ARN) of the principal. This can be one of the following:
      - The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
      - The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
      - The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.)
    - Actions (list) --
      
      The IAM action to grant or revoke permissions on.
      - (string) --
- RequestId (string) --
  
  The request ID.

DeleteFolderMembership (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.delete_folder_membership(
    AwsAccountId='string',
    FolderId='string',
    MemberId='string',
    MemberType='DASHBOARD'|'ANALYSIS'|'DATASET'
)

type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The AWS Account ID.

type FolderId

string

param FolderId

[REQUIRED]

The Folder ID.

type MemberId

string

param MemberId

[REQUIRED]

The ID of the asset (the dashboard, analysis, or dataset) that you want to delete.

type MemberType

string

param MemberType

[REQUIRED]

The type of the member, including DASHBOARD , ANALYSIS , and DATASET

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- Status (integer) --
  
  The status of deleting the asset. If succeeded, the status is SC_OK (200) .
- RequestId (string) --
  
  The request ID.

SearchFolders (new)

Link ¶

Searches the subfolders in a folder.

See also: AWS API Documentation

Request Syntax

client.search_folders(
    AwsAccountId='string',
    Filters=[
        {
            'Operator': 'StringEquals',
            'Name': 'PARENT_FOLDER_ARN',
            'Value': 'string'
        },
    ],
    NextToken='string',
    MaxResults=123
)

type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The AWS account ID.

type Filters

list

param Filters

[REQUIRED]

The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, "Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ] .

(dict) --

Searches a folder by a filter.
- Operator (string) --
  
  The comparison operator that you want to use as a filter. For example, "Operator": "StringEquals" .
- Name (string) --
  
  The name of the value that you want to use as a filter. For example, "Name": "PARENT_FOLDER_ARN" .
- Value (string) --
  
  The value of the named item (in this example, PARENT_FOLDER_ARN ), that you want to use as a filter. For example, "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" .

type NextToken

string

param NextToken

The token for the next set of results, or null if there are no more results.

type MaxResults

integer

param MaxResults

The maximum number of results to be returned per request.

rtype

dict

returns

Response Syntax

{
    'Status': 123,
    'FolderSummaryList': [
        {
            'Arn': 'string',
            'FolderId': 'string',
            'Name': 'string',
            'FolderType': 'SHARED',
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string'
}

Response Structure

(dict) --
- Status (integer) --
  
  The status. If succeeded, the status is SC_OK .
- FolderSummaryList (list) --
  
  A structure that contains all of the folders in your AWS account. This structure provides basic information about the folders.
  - (dict) --
    
    A summary of the folder.
    - Arn (string) --
      
      The Amazon Resource Name (ARN).
    - FolderId (string) --
      
      The folder ID.
    - Name (string) --
      
      The display name of the folder.
    - FolderType (string) --
      
      The type of folder.
    - CreatedTime (datetime) --
      
      The time that the folder was created.
    - LastUpdatedTime (datetime) --
      
      The time that the folder was last updated.
- NextToken (string) --
  
  The token for the next set of results, or null if there are no more results.
- RequestId (string) --
  
  The request ID.