2024/04/30 - Amazon QuickSight - 1 new 23 updated api methods
Changes New Q embedding supporting Generative Q&A
Updates the SPICE capacity configuration for a Amazon QuickSight account.
See also: AWS API Documentation
Request Syntax
client.update_spice_capacity_configuration(
AwsAccountId='string',
PurchaseMode='MANUAL'|'AUTO_PURCHASE'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the SPICE configuration that you want to update.
string
[REQUIRED]
Determines how SPICE capacity can be purchased. The following options are available.
MANUAL : SPICE capacity can only be purchased manually.
AUTO_PURCHASE : Extra SPICE capacity is automatically purchased on your behalf as needed. SPICE capacity can also be purchased manually with this option.
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.
{'AdminProGroup': ['string'],
'AuthorProGroup': ['string'],
'ReaderProGroup': ['string']}
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK.
Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon QuickSight User Guide . The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSight in the Amazon QuickSight User Guide .
If your IAM policy includes both the Subscribe and CreateAccountSubscription actions, make sure that both actions are set to Allow . If either action is set to Deny , the Deny action prevails and your API call fails.
You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the Amazon QuickSight User Guide .
You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon QuickSight User Guide .
See also: AWS API Documentation
Request Syntax
client.create_account_subscription(
Edition='STANDARD'|'ENTERPRISE'|'ENTERPRISE_AND_Q',
AuthenticationMethod='IAM_AND_QUICKSIGHT'|'IAM_ONLY'|'ACTIVE_DIRECTORY'|'IAM_IDENTITY_CENTER',
AwsAccountId='string',
AccountName='string',
NotificationEmail='string',
ActiveDirectoryName='string',
Realm='string',
DirectoryId='string',
AdminGroup=[
'string',
],
AuthorGroup=[
'string',
],
ReaderGroup=[
'string',
],
AdminProGroup=[
'string',
],
AuthorProGroup=[
'string',
],
ReaderProGroup=[
'string',
],
FirstName='string',
LastName='string',
EmailAddress='string',
ContactNumber='string',
IAMIdentityCenterInstanceArn='string'
)
string
The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from ENTERPRISE or ENTERPRISE_AND_Q .
If you choose ENTERPRISE_AND_Q , the following parameters are required:
FirstName
LastName
EmailAddress
ContactNumber
string
[REQUIRED]
The method that you want to use to authenticate your Amazon QuickSight account.
If you choose ACTIVE_DIRECTORY , provide an ActiveDirectoryName and an AdminGroup associated with your Active Directory.
If you choose IAM_IDENTITY_CENTER , provide an AdminGroup associated with your IAM Identity Center account.
string
[REQUIRED]
The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.
string
[REQUIRED]
The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change AccountName value after the Amazon QuickSight account is created.
string
[REQUIRED]
The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.
string
The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
string
The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
string
The ID of the Active Directory that is associated with your Amazon QuickSight account.
list
The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.
For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
(string) --
list
The author group associated with your Active Directory or IAM Identity Center account.
For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
(string) --
list
The reader group associated with your Active Directory or IAM Identity Center account.
For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
(string) --
list
The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.
For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
(string) --
list
The author pro group associated with your Active Directory or IAM Identity Center account.
For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
(string) --
list
The reader pro group associated with your Active Directory or IAM Identity Center account.
For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
(string) --
string
The first name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.
string
The last name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.
string
The email address of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.
string
A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.
string
The Amazon Resource Name (ARN) for the IAM Identity Center instance.
dict
Response Syntax
{
'SignupResponse': {
'IAMUser': True|False,
'userLoginName': 'string',
'accountName': 'string',
'directoryType': 'string'
},
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
SignupResponse (dict) --
A SignupResponse object that returns information about a newly created Amazon QuickSight account.
IAMUser (boolean) --
A Boolean that is TRUE if the Amazon QuickSight uses IAM as an authentication method.
userLoginName (string) --
The user login name for your Amazon QuickSight account.
accountName (string) --
The name of your Amazon QuickSight account.
directoryType (string) --
The type of Active Directory that is being used to authenticate the Amazon QuickSight account. Valid values are SIMPLE_AD , AD_CONNECTOR , and MICROSOFT_AD .
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'Sheets': {'Visuals': {'GaugeChartVisual': {'ChartConfiguration': {'ColorConfiguration': {'BackgroundColor': 'string',
'ForegroundColor': 'string'}}}}}}}
Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an AnalysisDefinition .
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'AnalysisId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN for the analysis.
AnalysisId (string) --
The ID of the analysis.
CreationStatus (string) --
The status of the creation of the analysis.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'Sheets': {'Visuals': {'GaugeChartVisual': {'ChartConfiguration': {'ColorConfiguration': {'BackgroundColor': 'string',
'ForegroundColor': 'string'}}}}}}}
Creates a dashboard from either a template or directly with a DashboardDefinition . To first create a template, see the CreateTemplate API operation.
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'DashboardId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the dashboard.
VersionArn (string) --
The ARN of the dashboard, including the version number of the first version that is created.
DashboardId (string) --
The ID for the dashboard.
CreationStatus (string) --
The status of the dashboard creation request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Role': {'READER_PRO', 'AUTHOR_PRO', 'ADMIN_PRO'}}
Use CreateRoleMembership to add an existing Amazon QuickSight group to an existing role.
See also: AWS API Documentation
Request Syntax
client.create_role_membership(
MemberName='string',
AwsAccountId='string',
Namespace='string',
Role='ADMIN'|'AUTHOR'|'READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO'
)
string
[REQUIRED]
The name of the group that you want to add to the role.
string
[REQUIRED]
The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace that the role belongs to.
string
[REQUIRED]
The role that you want to add a group to.
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.
{'Definition': {'Sheets': {'Visuals': {'GaugeChartVisual': {'ChartConfiguration': {'ColorConfiguration': {'BackgroundColor': 'string',
'ForegroundColor': 'string'}}}}}}}
Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.
A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'TemplateId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN for the template.
VersionArn (string) --
The ARN for the template, including the version information of the first version.
TemplateId (string) --
The ID of the template.
CreationStatus (string) --
The template creation status.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Role': {'READER_PRO', 'AUTHOR_PRO', 'ADMIN_PRO'}}
Removes custom permissions from the role.
See also: AWS API Documentation
Request Syntax
client.delete_role_custom_permission(
Role='ADMIN'|'AUTHOR'|'READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO',
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The role that you want to remove permissions from.
string
[REQUIRED]
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace that includes the role.
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.
{'Role': {'READER_PRO', 'AUTHOR_PRO', 'ADMIN_PRO'}}
Removes a group from a role.
See also: AWS API Documentation
Request Syntax
client.delete_role_membership(
MemberName='string',
Role='ADMIN'|'AUTHOR'|'READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO',
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The name of the group.
string
[REQUIRED]
The role that you want to remove permissions from.
string
[REQUIRED]
The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace that contains the role.
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.
{'Definition': {'Sheets': {'Visuals': {'GaugeChartVisual': {'ChartConfiguration': {'ColorConfiguration': {'BackgroundColor': 'string',
'ForegroundColor': 'string'}}}}}}}
Provides a detailed description of the definition of an analysis.
Note
If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysis instead.
See also: AWS API Documentation
Request Syntax
client.describe_analysis_definition(
AwsAccountId='string',
AnalysisId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.
string
[REQUIRED]
The ID of the analysis that you're describing. The ID is part of the URL of the analysis.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'Definition': {'Sheets': {'Visuals': {'GaugeChartVisual': {'ChartConfiguration': {'ColorConfiguration': {'BackgroundColor': 'string',
'ForegroundColor': 'string'}}}}}}}
Provides a detailed description of the definition of a dashboard.
Note
If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.
See also: AWS API Documentation
Request Syntax
client.describe_dashboard_definition(
AwsAccountId='string',
DashboardId='string',
VersionNumber=123,
AliasName='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the dashboard that you're describing.
string
[REQUIRED]
The ID for the dashboard.
integer
The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.
string
The alias name.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'Role': {'READER_PRO', 'AUTHOR_PRO', 'ADMIN_PRO'}}
Describes all custom permissions that are mapped to a role.
See also: AWS API Documentation
Request Syntax
client.describe_role_custom_permission(
Role='ADMIN'|'AUTHOR'|'READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO',
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The name of the role whose permissions you want described.
string
[REQUIRED]
The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace that contains the role.
dict
Response Syntax
{
'CustomPermissionsName': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
CustomPermissionsName (string) --
The name of the custom permission that is described.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Definition': {'Sheets': {'Visuals': {'GaugeChartVisual': {'ChartConfiguration': {'ColorConfiguration': {'BackgroundColor': 'string',
'ForegroundColor': 'string'}}}}}}}
Provides a detailed description of the definition of a template.
Note
If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead.
See also: AWS API Documentation
Request Syntax
client.describe_template_definition(
AwsAccountId='string',
TemplateId='string',
VersionNumber=123,
AliasName='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the template. You must be using the Amazon Web Services account that the template is in.
string
[REQUIRED]
The ID of the template that you're describing.
integer
The version number of the template.
string
The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'User': {'Role': {'READER_PRO', 'AUTHOR_PRO', 'ADMIN_PRO'}}}
Returns information about a user, given the user name.
See also: AWS API Documentation
Request Syntax
client.describe_user(
UserName='string',
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The name of the user that you want to describe.
string
[REQUIRED]
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace. Currently, you should set this to default .
dict
Response Syntax
{
'User': {
'Arn': 'string',
'UserName': 'string',
'Email': 'string',
'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO',
'IdentityType': 'IAM'|'QUICKSIGHT'|'IAM_IDENTITY_CENTER',
'Active': True|False,
'PrincipalId': 'string',
'CustomPermissionsName': 'string',
'ExternalLoginFederationProviderType': 'string',
'ExternalLoginFederationProviderUrl': 'string',
'ExternalLoginId': 'string'
},
'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. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.
Email (string) --
The user's email address.
Role (string) --
The Amazon QuickSight role for 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, datasets, analyses, and dashboards.
ADMIN : A user who is an author, who can also manage Amazon Amazon QuickSight settings.
READER_PRO : Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q Business, can build stories with Amazon Q, and can generate executive summaries from dashboards.
AUTHOR_PRO : Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.
ADMIN_PRO : Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.
RESTRICTED_READER : This role isn't currently available for use.
RESTRICTED_AUTHOR : This role isn't currently available for use.
IdentityType (string) --
The type of identity authentication used by the user.
Active (boolean) --
The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
PrincipalId (string) --
The principal ID of the user.
CustomPermissionsName (string) --
The custom permissions profile associated with this user.
ExternalLoginFederationProviderType (string) --
The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
COGNITO : Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
CUSTOM_OIDC : Custom OpenID Connect (OIDC) provider.
ExternalLoginFederationProviderUrl (string) --
The URL of the external login provider.
ExternalLoginId (string) --
The identity ID for the user in the external login provider.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'ExperienceConfiguration': {'GenerativeQnA': {'InitialTopicId': 'string'}}}
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics 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.
See also: AWS API Documentation
Request Syntax
client.generate_embed_url_for_anonymous_user(
AwsAccountId='string',
SessionLifetimeInMinutes=123,
Namespace='string',
SessionTags=[
{
'Key': 'string',
'Value': 'string'
},
],
AuthorizedResourceArns=[
'string',
],
ExperienceConfiguration={
'Dashboard': {
'InitialDashboardId': 'string'
},
'DashboardVisual': {
'InitialDashboardVisualId': {
'DashboardId': 'string',
'SheetId': 'string',
'VisualId': 'string'
}
},
'QSearchBar': {
'InitialTopicId': 'string'
},
'GenerativeQnA': {
'InitialTopicId': 'string'
}
},
AllowedDomains=[
'string',
]
)
string
[REQUIRED]
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
integer
How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
string
[REQUIRED]
The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default .
list
The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.
These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tags in the Amazon QuickSight User Guide .
(dict) --
The key-value pair used for the row-level security tags feature.
Key (string) -- [REQUIRED]
The key for the tag.
Value (string) -- [REQUIRED]
The value that you want to assign the tag.
list
[REQUIRED]
The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session.
If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view.
If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to.
Currently, you can pass up to 25 theme ARNs in each API call.
(string) --
dict
[REQUIRED]
The configuration of the experience that you are embedding.
Dashboard (dict) --
The type of embedding experience. In this case, Amazon QuickSight dashboards.
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.
The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException .
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 see. 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.
QSearchBar (dict) --
The Q search bar that you want to use for anonymous user embedding.
InitialTopicId (string) -- [REQUIRED]
The Amazon QuickSight Q topic ID of the legacy topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this legacy topic pre-selected.
The Amazon Resource Name (ARN) of this Q legacy topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.
GenerativeQnA (dict) --
The Generative Q&A experience that you want to use for anonymous user embedding.
InitialTopicId (string) -- [REQUIRED]
The Amazon QuickSight Q topic ID of the new reader experience topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Generative Q&A experience with this new reader experience topic pre selected.
The Amazon Resource Name (ARN) of this Q new reader experience topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.
list
The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.
To include all subdomains under a specific domain to the allow list, use * . For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com .
(string) --
dict
Response Syntax
{
'EmbedUrl': 'string',
'Status': 123,
'RequestId': 'string',
'AnonymousUserArn': 'string'
}
Response Structure
(dict) --
EmbedUrl (string) --
The embed URL for the dashboard.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
AnonymousUserArn (string) --
The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.
{'ExperienceConfiguration': {'GenerativeQnA': {'InitialTopicId': 'string'}}}
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 registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics 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.
See also: AWS API Documentation
Request Syntax
client.generate_embed_url_for_registered_user(
AwsAccountId='string',
SessionLifetimeInMinutes=123,
UserArn='string',
ExperienceConfiguration={
'Dashboard': {
'InitialDashboardId': 'string',
'FeatureConfigurations': {
'StatePersistence': {
'Enabled': True|False
},
'Bookmarks': {
'Enabled': True|False
}
}
},
'QuickSightConsole': {
'InitialPath': 'string',
'FeatureConfigurations': {
'StatePersistence': {
'Enabled': True|False
}
}
},
'QSearchBar': {
'InitialTopicId': 'string'
},
'DashboardVisual': {
'InitialDashboardVisualId': {
'DashboardId': 'string',
'SheetId': 'string',
'VisualId': 'string'
}
},
'GenerativeQnA': {
'InitialTopicId': 'string'
}
},
AllowedDomains=[
'string',
]
)
string
[REQUIRED]
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
integer
How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
string
[REQUIRED]
The Amazon Resource Name for the registered user.
dict
[REQUIRED]
The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire 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.
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.
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
The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.
To include all subdomains under a specific domain to the allow list, use * . For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com .
(string) --
dict
Response Syntax
{
'EmbedUrl': 'string',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
EmbedUrl (string) --
The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, Generative Q&A experience, or console.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Role': {'READER_PRO', 'AUTHOR_PRO', 'ADMIN_PRO'}}
Lists all groups that are associated with a role.
See also: AWS API Documentation
Request Syntax
client.list_role_memberships(
Role='ADMIN'|'AUTHOR'|'READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO',
NextToken='string',
MaxResults=123,
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The name of the role.
string
A pagination token that can be used in a subsequent request.
integer
The maximum number of results to return.
string
[REQUIRED]
The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace that includes the role.
dict
Response Syntax
{
'MembersList': [
'string',
],
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
MembersList (list) --
The list of groups associated with a role
(string) --
NextToken (string) --
A pagination token that can be used in a subsequent request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'TopicsSummaries': {'UserExperienceVersion': 'LEGACY | NEW_READER_EXPERIENCE'}}
Lists all of the topics within an account.
See also: AWS API Documentation
Request Syntax
client.list_topics(
AwsAccountId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the topics that you want to list.
string
The token for the next set of results, or null if there are no more results.
integer
The maximum number of results to be returned per request.
dict
Response Syntax
{
'TopicsSummaries': [
{
'Arn': 'string',
'TopicId': 'string',
'Name': 'string',
'UserExperienceVersion': 'LEGACY'|'NEW_READER_EXPERIENCE'
},
],
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
TopicsSummaries (list) --
A list of topic summaries.
(dict) --
A topic summary.
Arn (string) --
The Amazon Resource Name (ARN) of the topic.
TopicId (string) --
The ID for the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
Name (string) --
The name of the topic.
UserExperienceVersion (string) --
The user experience version of the topic.
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.
Status (integer) --
The HTTP status of the request.
{'UserList': {'Role': {'READER_PRO', 'AUTHOR_PRO', 'ADMIN_PRO'}}}
Returns a list of all of the Amazon QuickSight users belonging to this account.
See also: AWS API Documentation
Request Syntax
client.list_users(
AwsAccountId='string',
NextToken='string',
MaxResults=123,
Namespace='string'
)
string
[REQUIRED]
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
string
A pagination token that can be used in a subsequent request.
integer
The maximum number of results to return from this request.
string
[REQUIRED]
The namespace. Currently, you should set this to default .
dict
Response Syntax
{
'UserList': [
{
'Arn': 'string',
'UserName': 'string',
'Email': 'string',
'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO',
'IdentityType': 'IAM'|'QUICKSIGHT'|'IAM_IDENTITY_CENTER',
'Active': True|False,
'PrincipalId': 'string',
'CustomPermissionsName': 'string',
'ExternalLoginFederationProviderType': 'string',
'ExternalLoginFederationProviderUrl': 'string',
'ExternalLoginId': 'string'
},
],
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
UserList (list) --
The list of users.
(dict) --
A registered user of Amazon QuickSight.
Arn (string) --
The Amazon Resource Name (ARN) for the user.
UserName (string) --
The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.
Email (string) --
The user's email address.
Role (string) --
The Amazon QuickSight role for 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, datasets, analyses, and dashboards.
ADMIN : A user who is an author, who can also manage Amazon Amazon QuickSight settings.
READER_PRO : Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q Business, can build stories with Amazon Q, and can generate executive summaries from dashboards.
AUTHOR_PRO : Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.
ADMIN_PRO : Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.
RESTRICTED_READER : This role isn't currently available for use.
RESTRICTED_AUTHOR : This role isn't currently available for use.
IdentityType (string) --
The type of identity authentication used by the user.
Active (boolean) --
The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
PrincipalId (string) --
The principal ID of the user.
CustomPermissionsName (string) --
The custom permissions profile associated with this user.
ExternalLoginFederationProviderType (string) --
The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
COGNITO : Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
CUSTOM_OIDC : Custom OpenID Connect (OIDC) provider.
ExternalLoginFederationProviderUrl (string) --
The URL of the external login provider.
ExternalLoginId (string) --
The identity ID for the user in the external login provider.
NextToken (string) --
A pagination token that can be used in a subsequent request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'UserRole': {'READER_PRO', 'AUTHOR_PRO', 'ADMIN_PRO'}}
Response {'User': {'Role': {'READER_PRO', 'AUTHOR_PRO', 'ADMIN_PRO'}}}
Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.
See also: AWS API Documentation
Request Syntax
client.register_user(
IdentityType='IAM'|'QUICKSIGHT'|'IAM_IDENTITY_CENTER',
Email='string',
UserRole='ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO',
IamArn='string',
SessionName='string',
AwsAccountId='string',
Namespace='string',
UserName='string',
CustomPermissionsName='string',
ExternalLoginFederationProviderType='string',
CustomFederationProviderUrl='string',
ExternalLoginId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The identity type that your Amazon QuickSight account uses to manage the identity of users.
string
[REQUIRED]
The email address of the user that you want to register.
string
[REQUIRED]
The Amazon QuickSight role for 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, datasets, analyses, and dashboards.
ADMIN : A user who is an author, who can also manage Amazon QuickSight settings.
RESTRICTED_READER : This role isn't currently available for use.
RESTRICTED_AUTHOR : This role isn't currently available for use.
string
The ARN of the IAM user or role that you are registering with Amazon QuickSight.
string
You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon QuickSight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see assume-role in the CLI Reference.
string
[REQUIRED]
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace. Currently, you should set this to default .
string
The Amazon QuickSight user name that you want to create for the user you are registering.
string
(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:
Create and update data sources
Create and update datasets
Create and update email reports
Subscribe to email reports
To add custom permissions to an existing user, use UpdateUser instead.
A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.
Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader, admin pro, author pro, reader pro).
This feature is available only to Amazon QuickSight Enterprise edition subscriptions.
string
The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.
COGNITO : Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.
CUSTOM_OIDC : Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.
string
The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC .
string
The identity ID for a user in the external login provider.
list
The tags to associate with the user.
(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.
dict
Response Syntax
{
'User': {
'Arn': 'string',
'UserName': 'string',
'Email': 'string',
'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO',
'IdentityType': 'IAM'|'QUICKSIGHT'|'IAM_IDENTITY_CENTER',
'Active': True|False,
'PrincipalId': 'string',
'CustomPermissionsName': 'string',
'ExternalLoginFederationProviderType': 'string',
'ExternalLoginFederationProviderUrl': 'string',
'ExternalLoginId': 'string'
},
'UserInvitationUrl': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
User (dict) --
The user's user name.
Arn (string) --
The Amazon Resource Name (ARN) for the user.
UserName (string) --
The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.
Email (string) --
The user's email address.
Role (string) --
The Amazon QuickSight role for 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, datasets, analyses, and dashboards.
ADMIN : A user who is an author, who can also manage Amazon Amazon QuickSight settings.
READER_PRO : Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q Business, can build stories with Amazon Q, and can generate executive summaries from dashboards.
AUTHOR_PRO : Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.
ADMIN_PRO : Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.
RESTRICTED_READER : This role isn't currently available for use.
RESTRICTED_AUTHOR : This role isn't currently available for use.
IdentityType (string) --
The type of identity authentication used by the user.
Active (boolean) --
The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
PrincipalId (string) --
The principal ID of the user.
CustomPermissionsName (string) --
The custom permissions profile associated with this user.
ExternalLoginFederationProviderType (string) --
The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
COGNITO : Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
CUSTOM_OIDC : Custom OpenID Connect (OIDC) provider.
ExternalLoginFederationProviderUrl (string) --
The URL of the external login provider.
ExternalLoginId (string) --
The identity ID for the user in the external login provider.
UserInvitationUrl (string) --
The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of QUICKSIGHT .
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Definition': {'Sheets': {'Visuals': {'GaugeChartVisual': {'ChartConfiguration': {'ColorConfiguration': {'BackgroundColor': 'string',
'ForegroundColor': 'string'}}}}}}}
Updates an analysis in Amazon QuickSight
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'AnalysisId': 'string',
'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the analysis that you're updating.
AnalysisId (string) --
The ID of the analysis.
UpdateStatus (string) --
The update status of the last update that was made to the analysis.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'Sheets': {'Visuals': {'GaugeChartVisual': {'ChartConfiguration': {'ColorConfiguration': {'BackgroundColor': 'string',
'ForegroundColor': 'string'}}}}}}}
Updates a dashboard in an Amazon Web Services account.
Note
Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'DashboardId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
VersionArn (string) --
The ARN of the dashboard, including the version number.
DashboardId (string) --
The ID for the dashboard.
CreationStatus (string) --
The creation status of the request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Role': {'READER_PRO', 'AUTHOR_PRO', 'ADMIN_PRO'}}
Updates the custom permissions that are associated with a role.
See also: AWS API Documentation
Request Syntax
client.update_role_custom_permission(
CustomPermissionsName='string',
Role='ADMIN'|'AUTHOR'|'READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO',
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The name of the custom permission that you want to update the role with.
string
[REQUIRED]
The name of role tht you want to update.
string
[REQUIRED]
The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace that contains the role 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.
{'Definition': {'Sheets': {'Visuals': {'GaugeChartVisual': {'ChartConfiguration': {'ColorConfiguration': {'BackgroundColor': 'string',
'ForegroundColor': 'string'}}}}}}}
Updates a template from an existing Amazon QuickSight analysis or another template.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'TemplateId': 'string',
'Arn': 'string',
'VersionArn': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
TemplateId (string) --
The ID for the template.
Arn (string) --
The Amazon Resource Name (ARN) for the template.
VersionArn (string) --
The ARN for the template, including the version information of the first version.
CreationStatus (string) --
The creation status of the template.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Role': {'READER_PRO', 'AUTHOR_PRO', 'ADMIN_PRO'}}
Response {'User': {'Role': {'READER_PRO', 'AUTHOR_PRO', 'ADMIN_PRO'}}}
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'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO',
CustomPermissionsName='string',
UnapplyCustomPermissions=True|False,
ExternalLoginFederationProviderType='string',
CustomFederationProviderUrl='string',
ExternalLoginId='string'
)
string
[REQUIRED]
The Amazon QuickSight user name that you want to update.
string
[REQUIRED]
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace. Currently, you should set this to default .
string
[REQUIRED]
The email address of the user that you want to update.
string
[REQUIRED]
The Amazon QuickSight role of the user. The role can be one of the following default security cohorts:
READER : A user who has read-only access to dashboards.
AUTHOR : A user who can create data sources, datasets, analyses, and dashboards.
ADMIN : A user who is an author, who can also manage Amazon QuickSight settings.
READER_PRO : Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q Business, can build stories with Amazon Q, and can generate executive summaries from dashboards.
AUTHOR_PRO : Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.
ADMIN_PRO : Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.
The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.
string
(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:
Create and update data sources
Create and update datasets
Create and update email reports
Subscribe to email reports
A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.
Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader).
This feature is available only to Amazon QuickSight Enterprise edition subscriptions.
boolean
A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn't accept any other value.
string
The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.
COGNITO : Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.
CUSTOM_OIDC : Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.
NONE : This clears all the previously saved external login information for a user. Use the DescribeUser API operation to check the external login information.
string
The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC .
string
The identity ID for a user in the external login provider.
dict
Response Syntax
{
'User': {
'Arn': 'string',
'UserName': 'string',
'Email': 'string',
'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO',
'IdentityType': 'IAM'|'QUICKSIGHT'|'IAM_IDENTITY_CENTER',
'Active': True|False,
'PrincipalId': 'string',
'CustomPermissionsName': 'string',
'ExternalLoginFederationProviderType': 'string',
'ExternalLoginFederationProviderUrl': 'string',
'ExternalLoginId': 'string'
},
'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. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.
Email (string) --
The user's email address.
Role (string) --
The Amazon QuickSight role for 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, datasets, analyses, and dashboards.
ADMIN : A user who is an author, who can also manage Amazon Amazon QuickSight settings.
READER_PRO : Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q Business, can build stories with Amazon Q, and can generate executive summaries from dashboards.
AUTHOR_PRO : Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.
ADMIN_PRO : Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.
RESTRICTED_READER : This role isn't currently available for use.
RESTRICTED_AUTHOR : This role isn't currently available for use.
IdentityType (string) --
The type of identity authentication used by the user.
Active (boolean) --
The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
PrincipalId (string) --
The principal ID of the user.
CustomPermissionsName (string) --
The custom permissions profile associated with this user.
ExternalLoginFederationProviderType (string) --
The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
COGNITO : Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
CUSTOM_OIDC : Custom OpenID Connect (OIDC) provider.
ExternalLoginFederationProviderUrl (string) --
The URL of the external login provider.
ExternalLoginId (string) --
The identity ID for the user in the external login provider.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.