AWS API Changes

2026/08/31 - Amazon QuickSight - 6 new api methods

Changes This release adds support for managing apps in Amazon QuickSight with ListApps, SearchApps, DescribeApp, DescribeAppPermissions, UpdateAppPermissions, and DeleteApp

ListApps (new)

Link ¶

Lists the apps in an Amazon Web Services account. Results are paginated; use the NextToken parameter to retrieve additional results.

See also: AWS API Documentation

Request Syntax

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

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the apps.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in a single request. Valid range is 1 to 100. If you don't specify a value, the default is 20.

type NextToken:

string

param NextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'AppSummaryList': [
        {
            'AppId': 'string',
            'Arn': 'string',
            'Name': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1),
            'Visibility': 'PRIVATE'|'PUBLIC'
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string'
}

Response Structure

(dict) --
- AppSummaryList (list) --
  
  A list of app summaries.
  - (dict) --
    
    A summary of an app, including its identifier, name, and metadata.
    - AppId (string) --
      
      The ID of the app.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the app.
    - Name (string) --
      
      The display name of the app.
    - CreatedTime (datetime) --
      
      The time that the app was created.
    - LastUpdatedTime (datetime) --
      
      The time that the app was last updated.
    - Visibility (string) --
      
      The sharing status of the app: PUBLIC if the app is shared publicly, or PRIVATE if it is private.
- NextToken (string) --
  
  The token for the next set of results, or null if there are no more results.
- RequestId (string) --
  
  The Amazon Web Services request ID for this operation.

SearchApps (new)

Link ¶

Searches for apps in an Amazon Web Services account using the specified filters. This operation is eventually consistent; the results might not reflect very recent updates. Results are paginated; use the NextToken parameter to retrieve additional results.

See also: AWS API Documentation

Request Syntax

client.search_apps(
    AwsAccountId='string',
    Filters=[
        {
            'Name': 'APP_ID'|'APP_NAME'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER',
            'Operator': 'StringEquals'|'StringLike',
            'Value': 'string'
        },
    ],
    MaxResults=123,
    NextToken='string'
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the apps to search.

type Filters:

list

param Filters:

[REQUIRED]

The filters to apply to the search.

(dict) --

A filter to apply when searching for apps.
- Name (string) -- [REQUIRED]
  
  The name of the filter attribute.
- Operator (string) -- [REQUIRED]
  
  The comparison operator for the filter.
- Value (string) -- [REQUIRED]
  
  The value to filter on.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in a single request. Valid range is 1 to 100. If you don't specify a value, the default is 20.

type NextToken:

string

param NextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'AppSummaryList': [
        {
            'AppId': 'string',
            'Arn': 'string',
            'Name': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1),
            'Visibility': 'PRIVATE'|'PUBLIC'
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string'
}

Response Structure

(dict) --
- AppSummaryList (list) --
  
  A list of app summaries that match the search criteria.
  - (dict) --
    
    A summary of an app, including its identifier, name, and metadata.
    - AppId (string) --
      
      The ID of the app.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the app.
    - Name (string) --
      
      The display name of the app.
    - CreatedTime (datetime) --
      
      The time that the app was created.
    - LastUpdatedTime (datetime) --
      
      The time that the app was last updated.
    - Visibility (string) --
      
      The sharing status of the app: PUBLIC if the app is shared publicly, or PRIVATE if it is private.
- NextToken (string) --
  
  The token for the next set of results, or null if there are no more results.
- RequestId (string) --
  
  The Amazon Web Services request ID for this operation.

DescribeAppPermissions (new)

Link ¶

Describes the resource permissions for an app.

See also: AWS API Documentation

Request Syntax

client.describe_app_permissions(
    AwsAccountId='string',
    AppId='string'
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the app.

type AppId:

string

param AppId:

[REQUIRED]

The ID of the app.

rtype:

dict

returns:

Response Syntax

{
    'AppId': 'string',
    'Arn': 'string',
    'Permissions': [
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    'RequestId': 'string'
}

Response Structure

(dict) --
- AppId (string) --
  
  The ID of the app.
- Arn (string) --
  
  The Amazon Resource Name (ARN) of the app.
- Permissions (list) --
  
  The resource permissions for the app.
  - (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 Quick Sight user or group associated with a data source or dataset. (This is common.)
      - The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
      - The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
    - Actions (list) --
      
      The IAM action to grant or revoke permissions on.
      - (string) --
- RequestId (string) --
  
  The Amazon Web Services request ID for this operation.

DescribeApp (new)

Link ¶

Describes an app.

See also: AWS API Documentation

Request Syntax

client.describe_app(
    AwsAccountId='string',
    AppId='string'
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the app.

type AppId:

string

param AppId:

[REQUIRED]

The ID of the app that you want to describe.

rtype:

dict

returns:

Response Syntax

{
    'App': {
        'AppId': 'string',
        'Arn': 'string',
        'Name': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'LastUpdatedTime': datetime(2015, 1, 1),
        'Visibility': 'PRIVATE'|'PUBLIC'
    },
    'RequestId': 'string'
}

Response Structure

(dict) --
- App (dict) --
  
  The information about the app.
  - AppId (string) --
    
    The ID of the app.
  - Arn (string) --
    
    The Amazon Resource Name (ARN) of the app.
  - Name (string) --
    
    The display name of the app.
  - CreatedTime (datetime) --
    
    The time that the app was created.
  - LastUpdatedTime (datetime) --
    
    The time that the app was last updated.
  - Visibility (string) --
    
    The sharing status of the app: PUBLIC if the app is shared publicly, or PRIVATE if it is private.
- RequestId (string) --
  
  The Amazon Web Services request ID for this operation.

UpdateAppPermissions (new)

Link ¶

Updates the resource permissions for an app. You can grant or revoke permissions and, optionally, change the app's visibility.

See also: AWS API Documentation

Request Syntax

client.update_app_permissions(
    AwsAccountId='string',
    AppId='string',
    GrantPermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    RevokePermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    Visibility='PRIVATE'|'PUBLIC'
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the app.

type AppId:

string

param AppId:

[REQUIRED]

The ID of the app.

type GrantPermissions:

list

param GrantPermissions:

The permissions that you want to grant on the app.

(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 Quick Sight user or group associated with a data source or dataset. (This is common.)
  - The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
  - The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (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 the app.

(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 Quick Sight user or group associated with a data source or dataset. (This is common.)
  - The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
  - The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
- Actions (list) -- [REQUIRED]
  
  The IAM action to grant or revoke permissions on.
  - (string) --

type Visibility:

string

param Visibility:

The visibility to set for the app. Currently, only PRIVATE is accepted, which removes public (anonymous) access from the app. If you don't specify a value, the app's visibility is unchanged. Setting an app to PUBLIC through this operation is not supported.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'AppId': 'string',
    'Permissions': [
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    'Visibility': 'PRIVATE'|'PUBLIC',
    'RequestId': 'string'
}

Response Structure

(dict) --
- Arn (string) --
  
  The Amazon Resource Name (ARN) of the app.
- AppId (string) --
  
  The ID of the app.
- Permissions (list) --
  
  The updated resource permissions for the app.
  - (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 Quick Sight user or group associated with a data source or dataset. (This is common.)
      - The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
      - The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
    - Actions (list) --
      
      The IAM action to grant or revoke permissions on.
      - (string) --
- Visibility (string) --
  
  The visibility of the app after the update ( PRIVATE or PUBLIC).
- RequestId (string) --
  
  The Amazon Web Services request ID for this operation.

DeleteApp (new)

Link ¶

Deletes an app.

See also: AWS API Documentation

Request Syntax

client.delete_app(
    AwsAccountId='string',
    AppId='string'
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the app.

type AppId:

string

param AppId:

[REQUIRED]

The ID of the app that you want to delete.

rtype:

dict

returns:

Response Syntax

{
    'RequestId': 'string'
}

Response Structure

(dict) --
- RequestId (string) --
  
  The Amazon Web Services request ID for this operation.