Amazon QuickSight

2024/08/22 - Amazon QuickSight - 8 updated api methods

Changes  Explicit query for authors and dashboard viewing sharing for embedded users

CreateAnalysis (updated) Link ¶
Changes (request)
{'Definition': {'QueryExecutionOptions': {'QueryExecutionMode': 'AUTO | '
                                                                'MANUAL'}}}

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.

AWS API Documentation

Parameters

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

rtype

dict

returns

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.

CreateTemplate (updated) Link ¶
Changes (request)
{'Definition': {'QueryExecutionOptions': {'QueryExecutionMode': 'AUTO | '
                                                                'MANUAL'}}}

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.

AWS API Documentation

Parameters

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

rtype

dict

returns

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.

DescribeAnalysisDefinition (updated) Link ¶
Changes (response)
{'Definition': {'QueryExecutionOptions': {'QueryExecutionMode': 'AUTO | '
                                                                'MANUAL'}}}

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'
)
type AwsAccountId

string

param AwsAccountId

[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.

type AnalysisId

string

param AnalysisId

[REQUIRED]

The ID of the analysis that you're describing. The ID is part of the URL of the analysis.

rtype

dict

returns

Response Syntax

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

Response Structure

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

DescribeTemplateDefinition (updated) Link ¶
Changes (response)
{'Definition': {'QueryExecutionOptions': {'QueryExecutionMode': 'AUTO | '
                                                                'MANUAL'}}}

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'
)
type AwsAccountId

string

param AwsAccountId

[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.

type TemplateId

string

param TemplateId

[REQUIRED]

The ID of the template that you're describing.

type VersionNumber

integer

param VersionNumber

The version number of the template.

type AliasName

string

param AliasName

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.

rtype

dict

returns

Response Syntax

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

Response Structure

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

GenerateEmbedUrlForAnonymousUser (updated) Link ¶
Changes (request)
{'ExperienceConfiguration': {'Dashboard': {'DisabledFeatures': ['SHARED_VIEW'],
                                           'EnabledFeatures': ['SHARED_VIEW'],
                                           'FeatureConfigurations': {'SharedView': {'Enabled': 'boolean'}}}}}

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',
            'EnabledFeatures': [
                'SHARED_VIEW',
            ],
            'DisabledFeatures': [
                'SHARED_VIEW',
            ],
            'FeatureConfigurations': {
                'SharedView': {
                    'Enabled': True|False
                }
            }
        },
        'DashboardVisual': {
            'InitialDashboardVisualId': {
                'DashboardId': 'string',
                'SheetId': 'string',
                'VisualId': 'string'
            }
        },
        'QSearchBar': {
            'InitialTopicId': 'string'
        },
        'GenerativeQnA': {
            'InitialTopicId': 'string'
        }
    },
    AllowedDomains=[
        'string',
    ]
)
type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

type SessionLifetimeInMinutes

integer

param SessionLifetimeInMinutes

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

type Namespace

string

param Namespace

[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 .

type SessionTags

list

param SessionTags

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.

type AuthorizedResourceArns

list

param AuthorizedResourceArns

[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) --

type ExperienceConfiguration

dict

param ExperienceConfiguration

[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 .

    • EnabledFeatures (list) --

      A list of all enabled features of a specified anonymous dashboard.

      • (string) --

    • DisabledFeatures (list) --

      A list of all disabled features of a specified anonymous dashboard.

      • (string) --

    • FeatureConfigurations (dict) --

      The feature configuration for an embedded dashboard.

      • SharedView (dict) --

        The shared view settings of an embedded dashboard.

        • Enabled (boolean) -- [REQUIRED]

          The shared view settings of an embedded dashboard.

  • 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.

type AllowedDomains

list

param AllowedDomains

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) --

rtype

dict

returns

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.

GenerateEmbedUrlForRegisteredUser (updated) Link ¶
Changes (request)
{'ExperienceConfiguration': {'Dashboard': {'FeatureConfigurations': {'SharedView': {'Enabled': 'boolean'}}},
                             'QuickSightConsole': {'FeatureConfigurations': {'SharedView': {'Enabled': 'boolean'}}}}}

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
                },
                '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',
    ]
)
type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

type SessionLifetimeInMinutes

integer

param SessionLifetimeInMinutes

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

type UserArn

string

param UserArn

[REQUIRED]

The Amazon Resource Name for the registered user.

type ExperienceConfiguration

dict

param ExperienceConfiguration

[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.

      • 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.

type AllowedDomains

list

param AllowedDomains

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) --

rtype

dict

returns

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.

UpdateAnalysis (updated) Link ¶
Changes (request)
{'Definition': {'QueryExecutionOptions': {'QueryExecutionMode': 'AUTO | '
                                                                'MANUAL'}}}

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.

AWS API Documentation

Parameters

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

rtype

dict

returns

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.

UpdateTemplate (updated) Link ¶
Changes (request)
{'Definition': {'QueryExecutionOptions': {'QueryExecutionMode': 'AUTO | '
                                                                'MANUAL'}}}

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.

AWS API Documentation

Parameters

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

rtype

dict

returns

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.