2023/12/14 - Amazon QuickSight - 1 new 10 updated api methods
Changes Update Dashboard Links support; SingleAxisOptions support; Scatterplot Query limit support.
Updates the linked analyses on a dashboard.
See also: AWS API Documentation
Request Syntax
client.update_dashboard_links(
AwsAccountId='string',
DashboardId='string',
LinkEntities=[
'string',
]
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the dashboard whose links you want to update.
string
[REQUIRED]
The ID for the dashboard.
list
[REQUIRED]
list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
(string) --
dict
Response Syntax
{
'RequestId': 'string',
'Status': 123,
'DashboardArn': 'string',
'LinkEntities': [
'string',
]
}
Response Structure
(dict) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
DashboardArn (string) --
The Amazon Resource Name (ARN) of the dashboard.
LinkEntities (list) --
A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
(string) --
{'Definition': {'Sheets': {'Visuals': {'ComboChartVisual': {'ChartConfiguration': {'SingleAxisOptions': {'YAxisOptions': {'YAxis': 'PRIMARY_Y_AXIS'}}}},
'LineChartVisual': {'ChartConfiguration': {'SingleAxisOptions': {'YAxisOptions': {'YAxis': 'PRIMARY_Y_AXIS'}}}},
'ScatterPlotVisual': {'ChartConfiguration': {'SortConfiguration': {'ScatterPlotLimitConfiguration': {'ItemsLimit': 'long',
'OtherCategories': 'INCLUDE '
'| '
'EXCLUDE'}}}}}}}}
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': {'ComboChartVisual': {'ChartConfiguration': {'SingleAxisOptions': {'YAxisOptions': {'YAxis': 'PRIMARY_Y_AXIS'}}}},
'LineChartVisual': {'ChartConfiguration': {'SingleAxisOptions': {'YAxisOptions': {'YAxis': 'PRIMARY_Y_AXIS'}}}},
'ScatterPlotVisual': {'ChartConfiguration': {'SortConfiguration': {'ScatterPlotLimitConfiguration': {'ItemsLimit': 'long',
'OtherCategories': 'INCLUDE '
'| '
'EXCLUDE'}}}}}}},
'LinkEntities': ['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.
{'Definition': {'Sheets': {'Visuals': {'ComboChartVisual': {'ChartConfiguration': {'SingleAxisOptions': {'YAxisOptions': {'YAxis': 'PRIMARY_Y_AXIS'}}}},
'LineChartVisual': {'ChartConfiguration': {'SingleAxisOptions': {'YAxisOptions': {'YAxis': 'PRIMARY_Y_AXIS'}}}},
'ScatterPlotVisual': {'ChartConfiguration': {'SortConfiguration': {'ScatterPlotLimitConfiguration': {'ItemsLimit': 'long',
'OtherCategories': 'INCLUDE '
'| '
'EXCLUDE'}}}}}}}}
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.
{'Definition': {'Sheets': {'Visuals': {'ComboChartVisual': {'ChartConfiguration': {'SingleAxisOptions': {'YAxisOptions': {'YAxis': 'PRIMARY_Y_AXIS'}}}},
'LineChartVisual': {'ChartConfiguration': {'SingleAxisOptions': {'YAxisOptions': {'YAxis': 'PRIMARY_Y_AXIS'}}}},
'ScatterPlotVisual': {'ChartConfiguration': {'SortConfiguration': {'ScatterPlotLimitConfiguration': {'ItemsLimit': 'long',
'OtherCategories': 'INCLUDE '
'| '
'EXCLUDE'}}}}}}}}
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.
{'Dashboard': {'LinkEntities': ['string']}}
Provides a summary for a dashboard.
See also: AWS API Documentation
Request Syntax
client.describe_dashboard(
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
{
'Dashboard': {
'DashboardId': 'string',
'Arn': 'string',
'Name': 'string',
'Version': {
'CreatedTime': datetime(2015, 1, 1),
'Errors': [
{
'Type': 'ACCESS_DENIED'|'SOURCE_NOT_FOUND'|'DATA_SET_NOT_FOUND'|'INTERNAL_FAILURE'|'PARAMETER_VALUE_INCOMPATIBLE'|'PARAMETER_TYPE_INVALID'|'PARAMETER_NOT_FOUND'|'COLUMN_TYPE_MISMATCH'|'COLUMN_GEOGRAPHIC_ROLE_MISMATCH'|'COLUMN_REPLACEMENT_MISSING',
'Message': 'string',
'ViolatedEntities': [
{
'Path': 'string'
},
]
},
],
'VersionNumber': 123,
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Arn': 'string',
'SourceEntityArn': 'string',
'DataSetArns': [
'string',
],
'Description': 'string',
'ThemeArn': 'string',
'Sheets': [
{
'SheetId': 'string',
'Name': 'string'
},
]
},
'CreatedTime': datetime(2015, 1, 1),
'LastPublishedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'LinkEntities': [
'string',
]
},
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Dashboard (dict) --
Information about the dashboard.
DashboardId (string) --
Dashboard ID.
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
Name (string) --
A display name for the dashboard.
Version (dict) --
Version.
CreatedTime (datetime) --
The time that this dashboard version was created.
Errors (list) --
Errors associated with this dashboard version.
(dict) --
Dashboard error.
Type (string) --
Type.
Message (string) --
Message.
ViolatedEntities (list) --
Lists the violated entities that caused the dashboard error.
(dict) --
An object, structure, or sub-structure of an analysis, template, or dashboard.
Path (string) --
The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
VersionNumber (integer) --
Version number for this version of the dashboard.
Status (string) --
The HTTP status of the request.
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
SourceEntityArn (string) --
Source entity ARN.
DataSetArns (list) --
The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard.
(string) --
Description (string) --
Description.
ThemeArn (string) --
The ARN of the theme associated with a version of the dashboard.
Sheets (list) --
A list of the associated sheets with the unique identifier and name of each sheet.
(dict) --
A sheet , which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.
SheetId (string) --
The unique identifier associated with a sheet.
Name (string) --
The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
CreatedTime (datetime) --
The time that this dashboard was created.
LastPublishedTime (datetime) --
The last time that this dashboard was published.
LastUpdatedTime (datetime) --
The last time that this dashboard was updated.
LinkEntities (list) --
A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
(string) --
Status (integer) --
The HTTP status of this request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Definition': {'Sheets': {'Visuals': {'ComboChartVisual': {'ChartConfiguration': {'SingleAxisOptions': {'YAxisOptions': {'YAxis': 'PRIMARY_Y_AXIS'}}}},
'LineChartVisual': {'ChartConfiguration': {'SingleAxisOptions': {'YAxisOptions': {'YAxis': 'PRIMARY_Y_AXIS'}}}},
'ScatterPlotVisual': {'ChartConfiguration': {'SortConfiguration': {'ScatterPlotLimitConfiguration': {'ItemsLimit': 'long',
'OtherCategories': 'INCLUDE '
'| '
'EXCLUDE'}}}}}}}}
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.
{'Definition': {'Sheets': {'Visuals': {'ComboChartVisual': {'ChartConfiguration': {'SingleAxisOptions': {'YAxisOptions': {'YAxis': 'PRIMARY_Y_AXIS'}}}},
'LineChartVisual': {'ChartConfiguration': {'SingleAxisOptions': {'YAxisOptions': {'YAxis': 'PRIMARY_Y_AXIS'}}}},
'ScatterPlotVisual': {'ChartConfiguration': {'SortConfiguration': {'ScatterPlotLimitConfiguration': {'ItemsLimit': 'long',
'OtherCategories': 'INCLUDE '
'| '
'EXCLUDE'}}}}}}}}
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.
{'Definition': {'Sheets': {'Visuals': {'ComboChartVisual': {'ChartConfiguration': {'SingleAxisOptions': {'YAxisOptions': {'YAxis': 'PRIMARY_Y_AXIS'}}}},
'LineChartVisual': {'ChartConfiguration': {'SingleAxisOptions': {'YAxisOptions': {'YAxis': 'PRIMARY_Y_AXIS'}}}},
'ScatterPlotVisual': {'ChartConfiguration': {'SortConfiguration': {'ScatterPlotLimitConfiguration': {'ItemsLimit': 'long',
'OtherCategories': 'INCLUDE '
'| '
'EXCLUDE'}}}}}}}}
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': {'ComboChartVisual': {'ChartConfiguration': {'SingleAxisOptions': {'YAxisOptions': {'YAxis': 'PRIMARY_Y_AXIS'}}}},
'LineChartVisual': {'ChartConfiguration': {'SingleAxisOptions': {'YAxisOptions': {'YAxis': 'PRIMARY_Y_AXIS'}}}},
'ScatterPlotVisual': {'ChartConfiguration': {'SortConfiguration': {'ScatterPlotLimitConfiguration': {'ItemsLimit': 'long',
'OtherCategories': 'INCLUDE '
'| '
'EXCLUDE'}}}}}}}}
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.
{'Definition': {'Sheets': {'Visuals': {'ComboChartVisual': {'ChartConfiguration': {'SingleAxisOptions': {'YAxisOptions': {'YAxis': 'PRIMARY_Y_AXIS'}}}},
'LineChartVisual': {'ChartConfiguration': {'SingleAxisOptions': {'YAxisOptions': {'YAxis': 'PRIMARY_Y_AXIS'}}}},
'ScatterPlotVisual': {'ChartConfiguration': {'SortConfiguration': {'ScatterPlotLimitConfiguration': {'ItemsLimit': 'long',
'OtherCategories': 'INCLUDE '
'| '
'EXCLUDE'}}}}}}}}
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.