Amazon QuickSight

2024/09/27 - Amazon QuickSight - 2 new api methods

Changes  Adding personalization in QuickSight data stories. Admins can enable or disable personalization through QuickSight settings.

DescribeQPersonalizationConfiguration (new) Link ¶

Describes a personalization configuration.

See also: AWS API Documentation

Request Syntax

client.describe_q_personalization_configuration(
    AwsAccountId='string'
)
type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The ID of the Amazon Web Services account that contains the personalization configuration that the user wants described.

rtype

dict

returns

Response Syntax

{
    'PersonalizationMode': 'ENABLED'|'DISABLED',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) --

    • PersonalizationMode (string) --

      A value that indicates whether personalization is enabled or not.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

    • Status (integer) --

      The HTTP status of the request.

UpdateQPersonalizationConfiguration (new) Link ¶

Updates a personalization configuration.

See also: AWS API Documentation

Request Syntax

client.update_q_personalization_configuration(
    AwsAccountId='string',
    PersonalizationMode='ENABLED'|'DISABLED'
)
type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The ID of the Amazon Web Services account account that contains the personalization configuration that the user wants to update.

type PersonalizationMode

string

param PersonalizationMode

[REQUIRED]

An option to allow Amazon QuickSight to customize data stories with user specific metadata, specifically location and job information, in your IAM Identity Center instance.

rtype

dict

returns

Response Syntax

{
    'PersonalizationMode': 'ENABLED'|'DISABLED',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) --

    • PersonalizationMode (string) --

      The personalization mode that is used for the personalization configuration.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

    • Status (integer) --

      The HTTP status of the request.