2020/05/26 - Amazon QuickSight - 2 updated api methods
Changes Update quicksight client to latest version
{'Dashboard': {'Version': {'DataSetArns': ['string'],
'Errors': {'Type': {'ACCESS_DENIED',
'SOURCE_NOT_FOUND'}}}}}
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 AWS 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'
},
],
'VersionNumber': 123,
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED',
'Arn': 'string',
'SourceEntityArn': 'string',
'DataSetArns': [
'string',
],
'Description': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'LastPublishedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
'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.
(dict) --
Dashboard error.
Type (string) --
Type.
Message (string) --
Message.
VersionNumber (integer) --
Version number.
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 a version of the dashboard.
(string) --
Description (string) --
Description.
CreatedTime (datetime) --
The time that this dataset was created.
LastPublishedTime (datetime) --
The last time that this dataset was published.
LastUpdatedTime (datetime) --
The last time that this dataset was updated.
Status (integer) --
The HTTP status of this request.
RequestId (string) --
The AWS request ID for this operation.
{'Template': {'Version': {'Errors': {'Type': {'SOURCE_NOT_FOUND'}}}}}
Describes a template's metadata.
See also: AWS API Documentation
Request Syntax
client.describe_template(
AwsAccountId='string',
TemplateId='string',
VersionNumber=123,
AliasName='string'
)
string
[REQUIRED]
The ID of the AWS account that contains the template that you're describing.
string
[REQUIRED]
The ID for the template.
integer
(Optional) The number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the template is described.
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
{
'Template': {
'Arn': 'string',
'Name': 'string',
'Version': {
'CreatedTime': datetime(2015, 1, 1),
'Errors': [
{
'Type': 'SOURCE_NOT_FOUND'|'DATA_SET_NOT_FOUND'|'INTERNAL_FAILURE',
'Message': 'string'
},
],
'VersionNumber': 123,
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED',
'DataSetConfigurations': [
{
'Placeholder': 'string',
'DataSetSchema': {
'ColumnSchemaList': [
{
'Name': 'string',
'DataType': 'string',
'GeographicRole': 'string'
},
]
},
'ColumnGroupSchemaList': [
{
'Name': 'string',
'ColumnGroupColumnSchemaList': [
{
'Name': 'string'
},
]
},
]
},
],
'Description': 'string',
'SourceEntityArn': 'string'
},
'TemplateId': 'string',
'LastUpdatedTime': datetime(2015, 1, 1),
'CreatedTime': datetime(2015, 1, 1)
},
'Status': 123
}
Response Structure
(dict) --
Template (dict) --
The template structure for the object you want to describe.
Arn (string) --
The Amazon Resource Name (ARN) of the template.
Name (string) --
The display name of the template.
Version (dict) --
A structure describing the versions of the template.
CreatedTime (datetime) --
The time that this template version was created.
Errors (list) --
Errors associated with the template.
(dict) --
List of errors that occurred when the template version creation failed.
Type (string) --
Type of error.
Message (string) --
Description of the error type.
VersionNumber (integer) --
The version number of the template.
Status (string) --
The HTTP status of the request.
DataSetConfigurations (list) --
Schema of the dataset identified by the placeholder. The idea is that any dashboard created from the template should be bound to new datasets matching the same schema described through this API. .
(dict) --
Dataset configuration.
Placeholder (string) --
Placeholder.
DataSetSchema (dict) --
Dataset schema.
ColumnSchemaList (list) --
A structure containing the list of column schemas.
(dict) --
The column schema.
Name (string) --
The name of the column schema.
DataType (string) --
The data type of the column schema.
GeographicRole (string) --
The geographic role of the column schema.
ColumnGroupSchemaList (list) --
A structure containing the list of column group schemas.
(dict) --
The column group schema.
Name (string) --
The name of the column group schema.
ColumnGroupColumnSchemaList (list) --
A structure containing the list of schemas for column group columns.
(dict) --
A structure describing the name, data type, and geographic role of the columns.
Name (string) --
The name of the column group's column schema.
Description (string) --
The description of the template.
SourceEntityArn (string) --
The Amazon Resource Name (ARN) of the analysis or template which was used to create this template.
TemplateId (string) --
The ID for the template. This is unique per AWS Region for each AWS account.
LastUpdatedTime (datetime) --
Time when this was last updated.
CreatedTime (datetime) --
Time when this was created.
Status (integer) --
The HTTP status of the request.