2024/12/03 - Amazon QuickSight - 8 new3 updated api methods
Changes This release includes API needed to support for Unstructured Data in Q in QuickSight Q&A (IDC).
Deletes a linked Amazon Q Business application from an Amazon QuickSight account
See also: AWS API Documentation
Request Syntax
client.delete_default_q_business_application(
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The ID of the Amazon QuickSight account that you want to disconnect from a Amazon Q Business application.
string
The Amazon QuickSight namespace that you want to delete a linked Amazon Q Business application from. If this field is left blank, the Amazon Q Business application is deleted from the default namespace. Currently, the default namespace is the only valid value for this parameter.
dict
Response Syntax
{
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Updates an Amazon QuickSight application with a token exchange grant. This operation only supports Amazon QuickSight applications that are registered with IAM Identity Center.
See also: AWS API Documentation
Request Syntax
client.update_application_with_token_exchange_grant(
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account to be updated with a token exchange grant.
string
[REQUIRED]
The namespace of the Amazon QuickSight application.
dict
Response Syntax
{
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Updates a Amazon Q Business application that is linked to a Amazon QuickSight account.
See also: AWS API Documentation
Request Syntax
client.update_default_q_business_application(
AwsAccountId='string',
Namespace='string',
ApplicationId='string'
)
string
[REQUIRED]
The ID of the Amazon QuickSight account that is connected to the Amazon Q Business application that you want to update.
string
The Amazon QuickSight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter.
string
[REQUIRED]
The ID of the Amazon Q Business application that you want to update.
dict
Response Syntax
{
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Predicts existing visuals or generates new visuals to answer a given query.
See also: AWS API Documentation
Request Syntax
client.predict_qa_results(
AwsAccountId='string',
QueryText='string',
IncludeQuickSightQIndex='INCLUDE'|'EXCLUDE',
IncludeGeneratedAnswer='INCLUDE'|'EXCLUDE',
MaxTopicsToConsider=123
)
string
[REQUIRED]
The ID of the Amazon Web Services account that the user wants to execute Predict QA results in.
string
[REQUIRED]
The query text to be used to predict QA results.
string
Indicates whether Q indicies are included or excluded.
string
Indicates whether generated answers are included or excluded.
integer
The number of maximum topics to be considered to predict QA results.
dict
Response Syntax
{
'PrimaryResult': {
'ResultType': 'DASHBOARD_VISUAL'|'GENERATED_ANSWER'|'NO_ANSWER',
'DashboardVisual': {
'DashboardId': 'string',
'DashboardName': 'string',
'SheetId': 'string',
'SheetName': 'string',
'VisualId': 'string',
'VisualTitle': 'string',
'VisualSubtitle': 'string',
'DashboardUrl': 'string'
},
'GeneratedAnswer': {
'QuestionText': 'string',
'AnswerStatus': 'ANSWER_GENERATED'|'ANSWER_RETRIEVED'|'ANSWER_DOWNGRADE',
'TopicId': 'string',
'TopicName': 'string',
'Restatement': 'string',
'QuestionId': 'string',
'AnswerId': 'string',
'QuestionUrl': 'string'
}
},
'AdditionalResults': [
{
'ResultType': 'DASHBOARD_VISUAL'|'GENERATED_ANSWER'|'NO_ANSWER',
'DashboardVisual': {
'DashboardId': 'string',
'DashboardName': 'string',
'SheetId': 'string',
'SheetName': 'string',
'VisualId': 'string',
'VisualTitle': 'string',
'VisualSubtitle': 'string',
'DashboardUrl': 'string'
},
'GeneratedAnswer': {
'QuestionText': 'string',
'AnswerStatus': 'ANSWER_GENERATED'|'ANSWER_RETRIEVED'|'ANSWER_DOWNGRADE',
'TopicId': 'string',
'TopicName': 'string',
'Restatement': 'string',
'QuestionId': 'string',
'AnswerId': 'string',
'QuestionUrl': 'string'
}
},
],
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
PrimaryResult (dict) --
The primary visual response.
ResultType (string) --
The type of QA result.
DashboardVisual (dict) --
The representation of a dashboard visual result.
DashboardId (string) --
The ID of the dashboard.
DashboardName (string) --
The name of the dashboard.
SheetId (string) --
The ID of the sheet.
SheetName (string) --
The name of the sheet.
VisualId (string) --
The ID of the visual.
VisualTitle (string) --
The title of the visual.
VisualSubtitle (string) --
The subtitle of the visual.
DashboardUrl (string) --
The URL of the dashboard.
GeneratedAnswer (dict) --
The representation of a generated answer result.
QuestionText (string) --
The question text.
AnswerStatus (string) --
The answer status of the generated answer.
TopicId (string) --
The ID of the topic.
TopicName (string) --
The name of the topic.
Restatement (string) --
The restatement for the answer.
QuestionId (string) --
The ID of the question.
AnswerId (string) --
The ID of the answer.
QuestionUrl (string) --
The URL of the question.
AdditionalResults (list) --
Additional visual responses.
(dict) --
The QA result that is made from the DashboardVisual or GeneratedAnswer.
ResultType (string) --
The type of QA result.
DashboardVisual (dict) --
The representation of a dashboard visual result.
DashboardId (string) --
The ID of the dashboard.
DashboardName (string) --
The name of the dashboard.
SheetId (string) --
The ID of the sheet.
SheetName (string) --
The name of the sheet.
VisualId (string) --
The ID of the visual.
VisualTitle (string) --
The title of the visual.
VisualSubtitle (string) --
The subtitle of the visual.
DashboardUrl (string) --
The URL of the dashboard.
GeneratedAnswer (dict) --
The representation of a generated answer result.
QuestionText (string) --
The question text.
AnswerStatus (string) --
The answer status of the generated answer.
TopicId (string) --
The ID of the topic.
TopicName (string) --
The name of the topic.
Restatement (string) --
The restatement for the answer.
QuestionId (string) --
The ID of the question.
AnswerId (string) --
The ID of the answer.
QuestionUrl (string) --
The URL of the question.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user that is registered in an Amazon QuickSight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for.
This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Amazon QuickSight with the scope value set to quicksight:read. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
See also: AWS API Documentation
Request Syntax
client.generate_embed_url_for_registered_user_with_identity(
AwsAccountId='string',
SessionLifetimeInMinutes=123,
ExperienceConfiguration={
'Dashboard': {
'InitialDashboardId': 'string',
'FeatureConfigurations': {
'StatePersistence': {
'Enabled': True|False
},
'SharedView': {
'Enabled': True|False
},
'Bookmarks': {
'Enabled': True|False
}
}
},
'QuickSightConsole': {
'InitialPath': 'string',
'FeatureConfigurations': {
'StatePersistence': {
'Enabled': True|False
},
'SharedView': {
'Enabled': True|False
}
}
},
'QSearchBar': {
'InitialTopicId': 'string'
},
'DashboardVisual': {
'InitialDashboardVisualId': {
'DashboardId': 'string',
'SheetId': 'string',
'VisualId': 'string'
}
},
'GenerativeQnA': {
'InitialTopicId': 'string'
}
},
AllowedDomains=[
'string',
]
)
string
[REQUIRED]
The ID of the Amazon Web Services registered user.
integer
The validity of the session in minutes.
dict
[REQUIRED]
The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.
Dashboard (dict) --
The configuration details for providing a dashboard embedding experience.
InitialDashboardId (string) -- [REQUIRED]
The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.
If the user does not have permission to view this dashboard, they see a permissions error message.
FeatureConfigurations (dict) --
The feature configurations of an embbedded Amazon QuickSight dashboard.
StatePersistence (dict) --
The state persistence settings of an embedded dashboard.
Enabled (boolean) -- [REQUIRED]
Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off.
SharedView (dict) --
The shared view settings of an embedded dashboard.
Enabled (boolean) -- [REQUIRED]
The shared view settings of an embedded dashboard.
Bookmarks (dict) --
The bookmarks configuration for an embedded dashboard in Amazon QuickSight.
Enabled (boolean) -- [REQUIRED]
A Boolean value that determines whether a user can bookmark an embedded dashboard.
QuickSightConsole (dict) --
The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User Guide.
Use GenerateEmbedUrlForRegisteredUser where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console needs to belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use the RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
InitialPath (string) --
The initial URL path for the Amazon QuickSight console. InitialPath is required.
The entry point URL is constrained to the following paths:
/start
/start/analyses
/start/dashboards
/start/favorites
/dashboards/DashboardId. DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard.
/analyses/AnalysisId. AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis.
FeatureConfigurations (dict) --
The embedding configuration of an embedded Amazon QuickSight console.
StatePersistence (dict) --
The state persistence configurations of an embedded Amazon QuickSight console.
Enabled (boolean) -- [REQUIRED]
Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off.
SharedView (dict) --
The shared view settings of an embedded dashboard.
Enabled (boolean) -- [REQUIRED]
The shared view settings of an embedded dashboard.
QSearchBar (dict) --
The configuration details for embedding the Q search bar.
For more information about embedding the Q search bar, see Embedding Overview in the Amazon QuickSight User Guide.
InitialTopicId (string) --
The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Amazon QuickSight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the list of available topics.
If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.
DashboardVisual (dict) --
The type of embedding experience. In this case, Amazon QuickSight visuals.
InitialDashboardVisualId (dict) -- [REQUIRED]
The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.
The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.
DashboardId (string) -- [REQUIRED]
The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.
SheetId (string) -- [REQUIRED]
The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.
VisualId (string) -- [REQUIRED]
The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.
GenerativeQnA (dict) --
The configuration details for embedding the Generative Q&A experience.
For more information about embedding the Generative Q&A experience, see Embedding Overview in the Amazon QuickSight User Guide.
InitialTopicId (string) --
The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A experience. You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening a topic. The ID is in the URL for the topic that you open.
If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience topics is shown in the Generative Q&A experience for your readers. When you select an initial new reader experience topic, you can specify whether or not readers are allowed to select other new reader experience topics from the available ones in the list.
list
A list of domains to be allowed to generate the embed URL.
(string) --
dict
Response Syntax
{
'EmbedUrl': 'string',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
EmbedUrl (string) --
The generated embed URL for the registered user.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Describes the state of a Amazon QuickSight Q Search configuration.
See also: AWS API Documentation
Request Syntax
client.describe_quick_sight_q_search_configuration(
AwsAccountId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the Amazon QuickSight Q Search configuration that the user wants described.
dict
Response Syntax
{
'QSearchStatus': 'ENABLED'|'DISABLED',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
QSearchStatus (string) --
The status of Amazon QuickSight Q Search configuration.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Updates the state of a Amazon QuickSight Q Search configuration.
See also: AWS API Documentation
Request Syntax
client.update_quick_sight_q_search_configuration(
AwsAccountId='string',
QSearchStatus='ENABLED'|'DISABLED'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the Amazon QuickSight Q Search configuration that you want to update.
string
[REQUIRED]
The status of the Amazon QuickSight Q Search configuration that the user wants to update.
dict
Response Syntax
{
'QSearchStatus': 'ENABLED'|'DISABLED',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
QSearchStatus (string) --
The status of the Amazon QuickSight Q Search configuration.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Describes a Amazon Q Business application that is linked to an Amazon QuickSight account.
See also: AWS API Documentation
Request Syntax
client.describe_default_q_business_application(
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The ID of the Amazon QuickSight account that is linked to the Amazon Q Business application that you want described.
string
The Amazon QuickSight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter.
dict
Response Syntax
{
'RequestId': 'string',
'Status': 123,
'ApplicationId': 'string'
}
Response Structure
(dict) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
ApplicationId (string) --
The ID of the Amazon Q Business application that is linked to the Amazon QuickSight account.
{'Service': {'QBUSINESS'}}
Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.
This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.
See also: AWS API Documentation
Request Syntax
client.delete_identity_propagation_config(
AwsAccountId='string',
Service='REDSHIFT'|'QBUSINESS'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that you want to delete an identity propagation configuration from.
string
[REQUIRED]
The name of the Amazon Web Services service that you want to delete the associated access scopes and authorized targets from.
dict
Response Syntax
{
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Services': {'Service': {'QBUSINESS'}}}
Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.
This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.
See also: AWS API Documentation
Request Syntax
client.list_identity_propagation_configs(
AwsAccountId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contain the identity propagation configurations of.
integer
The maximum number of results to be returned.
string
The token for the next set of results, or null if there are no more results.
dict
Response Syntax
{
'Services': [
{
'Service': 'REDSHIFT'|'QBUSINESS',
'AuthorizedTargets': [
'string',
]
},
],
'NextToken': 'string',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Services (list) --
A list of services and their authorized targets that the Amazon QuickSight IAM Identity Center application can access.
(dict) --
The authorized targets that are associated with a service.
Service (string) --
The name of the Amazon Web Services service.
AuthorizedTargets (list) --
Aist of authorized targets that are represented by IAM Identity Center application ARNs.
(string) --
NextToken (string) --
The token for the next set of results, or null if there are no more results.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Service': {'QBUSINESS'}}
Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.
This operation is only supported for Amazon QuickSight accounts using IAM Identity Center
See also: AWS API Documentation
Request Syntax
client.update_identity_propagation_config(
AwsAccountId='string',
Service='REDSHIFT'|'QBUSINESS',
AuthorizedTargets=[
'string',
]
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the identity propagation configuration that you want to update.
string
[REQUIRED]
The name of the Amazon Web Services service that contains the authorized targets that you want to add or update.
list
Specifies a list of application ARNs that represent the authorized targets for a service.
(string) --
dict
Response Syntax
{
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.