2023/08/24 - Amazon QuickSight - 18 updated api methods
Changes Excel support in Snapshot Export APIs. Removed Required trait for some insight Computations. Namespace-shared Folders support. Global Filters support. Table pin Column support.
{'Definition': {'FilterGroups': {'ScopeConfiguration': {'AllSheets': {}}},
'Sheets': {'Visuals': {'TableVisual': {'ChartConfiguration': {'FieldOptions': {'PinnedFieldOptions': {'PinnedLeftFields': ['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': {'FilterGroups': {'ScopeConfiguration': {'AllSheets': {}}},
'Sheets': {'Visuals': {'TableVisual': {'ChartConfiguration': {'FieldOptions': {'PinnedFieldOptions': {'PinnedLeftFields': ['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.
{'SharingModel': 'ACCOUNT | NAMESPACE'}
Creates an empty shared folder.
See also: AWS API Documentation
Request Syntax
client.create_folder(
AwsAccountId='string',
FolderId='string',
Name='string',
FolderType='SHARED',
ParentFolderArn='string',
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
SharingModel='ACCOUNT'|'NAMESPACE'
)
string
[REQUIRED]
The ID for the Amazon Web Services account where you want to create the folder.
string
[REQUIRED]
The ID of the folder.
string
The name of the folder.
string
The type of folder. By default, folderType is SHARED .
string
The Amazon Resource Name (ARN) for the parent folder.
ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.
list
A structure that describes the principals and the resource-level permissions of a folder.
To specify no permissions, omit Permissions .
(dict) --
Permission for the resource.
Principal (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
Actions (list) -- [REQUIRED]
The IAM action to grant or revoke permissions on.
(string) --
list
Tags for the folder.
(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.
string
An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT .
dict
Response Syntax
{
'Status': 123,
'Arn': 'string',
'FolderId': 'string',
'RequestId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
Arn (string) --
The Amazon Resource Name (ARN) for the newly created folder.
FolderId (string) --
The folder ID for the newly created folder.
RequestId (string) --
The request ID for the newly created folder.
{'Definition': {'FilterGroups': {'ScopeConfiguration': {'AllSheets': {}}},
'Sheets': {'Visuals': {'TableVisual': {'ChartConfiguration': {'FieldOptions': {'PinnedFieldOptions': {'PinnedLeftFields': ['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.
{'Definition': {'FilterGroups': {'ScopeConfiguration': {'AllSheets': {}}},
'Sheets': {'Visuals': {'TableVisual': {'ChartConfiguration': {'FieldOptions': {'PinnedFieldOptions': {'PinnedLeftFields': ['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': {'FilterGroups': {'ScopeConfiguration': {'AllSheets': {}}},
'Sheets': {'Visuals': {'TableVisual': {'ChartConfiguration': {'FieldOptions': {'PinnedFieldOptions': {'PinnedLeftFields': ['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.
{'SnapshotConfiguration': {'FileGroups': {'Files': {'FormatType': {'EXCEL'}}}}}
Describes an existing snapshot job.
Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus .
See also: AWS API Documentation
Request Syntax
client.describe_dashboard_snapshot_job(
AwsAccountId='string',
DashboardId='string',
SnapshotJobId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
string
[REQUIRED]
The ID of the dashboard that you have started a snapshot job for.
string
[REQUIRED]
The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.
dict
Response Syntax
{
'AwsAccountId': 'string',
'DashboardId': 'string',
'SnapshotJobId': 'string',
'UserConfiguration': {
'AnonymousUsers': [
{
'RowLevelPermissionTagKeys': [
'string',
]
},
]
},
'SnapshotConfiguration': {
'FileGroups': [
{
'Files': [
{
'SheetSelections': [
{
'SheetId': 'string',
'SelectionScope': 'ALL_VISUALS'|'SELECTED_VISUALS',
'VisualIds': [
'string',
]
},
],
'FormatType': 'CSV'|'PDF'|'EXCEL'
},
]
},
],
'DestinationConfiguration': {
'S3Destinations': [
{
'BucketConfiguration': {
'BucketName': 'string',
'BucketPrefix': 'string',
'BucketRegion': 'string'
}
},
]
},
'Parameters': {
'StringParameters': [
{
'Name': 'string',
'Values': [
'string',
]
},
],
'IntegerParameters': [
{
'Name': 'string',
'Values': [
123,
]
},
],
'DecimalParameters': [
{
'Name': 'string',
'Values': [
123.0,
]
},
],
'DateTimeParameters': [
{
'Name': 'string',
'Values': [
datetime(2015, 1, 1),
]
},
]
}
},
'Arn': 'string',
'JobStatus': 'QUEUED'|'RUNNING'|'COMPLETED'|'FAILED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
AwsAccountId (string) --
The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
DashboardId (string) --
The ID of the dashboard that you have started a snapshot job for.
SnapshotJobId (string) --
The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.
UserConfiguration (dict) --
The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.
AnonymousUsers (list) --
An array of records that describe anonymous users that the dashboard snapshot is generated for. Sensitive user information is excluded.
(dict) --
Use this structure to redact sensitive information that you provide about an anonymous user from the snapshot.
RowLevelPermissionTagKeys (list) --
The tag keys for the RowLevelPermissionTags .
(string) --
SnapshotConfiguration (dict) --
The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.
FileGroups (list) --
A list of SnapshotJobResultFileGroup objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 FileGroup configurations.
(dict) --
A structure that contains the information on the snapshot files.
Files (list) --
A list of SnapshotFile objects that contain the information on the snapshot files that need to be generated. This structure can hold 1 configuration at a time.
(dict) --
A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.
SheetSelections (list) --
A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.
(dict) --
A structure that contains information that identifies the snapshot that needs to be generated.
SheetId (string) --
The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.
SelectionScope (string) --
The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.
ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.
SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook.
VisualIds (list) --
A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.
(string) --
FormatType (string) --
The format of the snapshot file to be generated. You can choose between CSV , Excel , or PDF .
DestinationConfiguration (dict) --
A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.
S3Destinations (list) --
A list of SnapshotS3DestinationConfiguration objects that contain Amazon S3 destination configurations. This structure can hold a maximum of 1 S3DestinationConfiguration .
(dict) --
A structure that describes the Amazon S3 settings to use to save the generated dashboard snapshot.
BucketConfiguration (dict) --
A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in.
BucketName (string) --
The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.
BucketPrefix (string) --
The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
BucketRegion (string) --
The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.
Parameters (dict) --
A list of Amazon QuickSight parameters and the list's override values.
StringParameters (list) --
The parameters that have a data type of string.
(dict) --
A string parameter.
Name (string) --
A display name for a string parameter.
Values (list) --
The values of a string parameter.
(string) --
IntegerParameters (list) --
The parameters that have a data type of integer.
(dict) --
An integer parameter.
Name (string) --
The name of the integer parameter.
Values (list) --
The values for the integer parameter.
(integer) --
DecimalParameters (list) --
The parameters that have a data type of decimal.
(dict) --
A decimal parameter.
Name (string) --
A display name for the decimal parameter.
Values (list) --
The values for the decimal parameter.
(float) --
DateTimeParameters (list) --
The parameters that have a data type of date-time.
(dict) --
A date-time parameter.
Name (string) --
A display name for the date-time parameter.
Values (list) --
The values for the date-time parameter.
(datetime) --
Arn (string) --
The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.
JobStatus (string) --
Indicates the status of a job. The status updates as the job executes. This shows one of the following values.
COMPLETED - The job was completed successfully.
FAILED - The job failed to execute.
QUEUED - The job is queued and hasn't started yet.
RUNNING - The job is still running.
CreatedTime (datetime) --
The time that the snapshot job was created.
LastUpdatedTime (datetime) --
The time that the snapshot job status was last updated.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request
{'Result': {'AnonymousUsers': {'FileGroups': {'Files': {'FormatType': {'EXCEL'}}}}}}
Describes the result of an existing snapshot job that has finished running.
A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call.
If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id <SnapshotjobId> has not reached a terminal state. .
See also: AWS API Documentation
Request Syntax
client.describe_dashboard_snapshot_job_result(
AwsAccountId='string',
DashboardId='string',
SnapshotJobId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
string
[REQUIRED]
The ID of the dashboard that you have started a snapshot job for.
string
[REQUIRED]
The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.
dict
Response Syntax
{
'Arn': 'string',
'JobStatus': 'QUEUED'|'RUNNING'|'COMPLETED'|'FAILED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'Result': {
'AnonymousUsers': [
{
'FileGroups': [
{
'Files': [
{
'SheetSelections': [
{
'SheetId': 'string',
'SelectionScope': 'ALL_VISUALS'|'SELECTED_VISUALS',
'VisualIds': [
'string',
]
},
],
'FormatType': 'CSV'|'PDF'|'EXCEL'
},
],
'S3Results': [
{
'S3DestinationConfiguration': {
'BucketConfiguration': {
'BucketName': 'string',
'BucketPrefix': 'string',
'BucketRegion': 'string'
}
},
'S3Uri': 'string',
'ErrorInfo': [
{
'ErrorMessage': 'string',
'ErrorType': 'string'
},
]
},
]
},
]
},
]
},
'ErrorInfo': {
'ErrorMessage': 'string',
'ErrorType': 'string'
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.
JobStatus (string) --
Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.
CreatedTime (datetime) --
The time that a snapshot job was created.
LastUpdatedTime (datetime) --
The time that a snapshot job status was last updated.
Result (dict) --
The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.
AnonymousUsers (list) --
A list of AnonymousUserSnapshotJobResult objects that contain information on anonymous users and their user configurations. This data provided by you when you make a StartDashboardSnapshotJob API call.
(dict) --
A structure that contains the file groups that are requested for the artifact generation in a StartDashboardSnapshotJob API call.
FileGroups (list) --
A list of SnapshotJobResultFileGroup objects that contain information on the files that are requested during a StartDashboardSnapshotJob API call. If the job succeeds, these objects contain the location where the snapshot artifacts are stored. If the job fails, the objects contain information about the error that caused the job to fail.
(dict) --
A structure that contains information on the generated snapshot file groups.
Files (list) --
A list of SnapshotFile objects.
(dict) --
A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.
SheetSelections (list) --
A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.
(dict) --
A structure that contains information that identifies the snapshot that needs to be generated.
SheetId (string) --
The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.
SelectionScope (string) --
The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.
ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.
SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook.
VisualIds (list) --
A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.
(string) --
FormatType (string) --
The format of the snapshot file to be generated. You can choose between CSV , Excel , or PDF .
S3Results (list) --
A list of SnapshotJobS3Result objects.
(dict) --
The Amazon S3 result from the snapshot job. The result includes the DestinationConfiguration and the Amazon S3 Uri. If an error occured during the job, the result returns information on the error.
S3DestinationConfiguration (dict) --
A list of Amazon S3 bucket configurations that are provided when you make a StartDashboardSnapshotJob API call.
BucketConfiguration (dict) --
A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in.
BucketName (string) --
The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.
BucketPrefix (string) --
The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
BucketRegion (string) --
The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.
S3Uri (string) --
The Amazon S3 Uri.
ErrorInfo (list) --
An array of error records that describe any failures that occur while the dashboard snapshot job runs.
(dict) --
Information on the error that caused the snapshot job to fail.
ErrorMessage (string) --
The error message.
ErrorType (string) --
The error type.
ErrorInfo (dict) --
Displays information for the error that caused a job to fail.
ErrorMessage (string) --
The error message.
ErrorType (string) --
The error type.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request
{'Folder': {'SharingModel': 'ACCOUNT | NAMESPACE'}}
Describes a folder.
See also: AWS API Documentation
Request Syntax
client.describe_folder(
AwsAccountId='string',
FolderId='string'
)
string
[REQUIRED]
The ID for the Amazon Web Services account that contains the folder.
string
[REQUIRED]
The ID of the folder.
dict
Response Syntax
{
'Status': 123,
'Folder': {
'FolderId': 'string',
'Arn': 'string',
'Name': 'string',
'FolderType': 'SHARED',
'FolderPath': [
'string',
],
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'SharingModel': 'ACCOUNT'|'NAMESPACE'
},
'RequestId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
Folder (dict) --
Information about the folder.
FolderId (string) --
The ID of the folder.
Arn (string) --
The Amazon Resource Name (ARN) for the folder.
Name (string) --
A display name for the folder.
FolderType (string) --
The type of folder it is.
FolderPath (list) --
An array of ancestor ARN strings for the folder.
(string) --
CreatedTime (datetime) --
The time that the folder was created.
LastUpdatedTime (datetime) --
The time that the folder was last updated.
SharingModel (string) --
The sharing scope of the folder.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'MaxResults': 'integer', 'Namespace': 'string', 'NextToken': 'string'}
Response {'NextToken': 'string'}
Describes permissions for a folder.
See also: AWS API Documentation
Request Syntax
client.describe_folder_permissions(
AwsAccountId='string',
FolderId='string',
Namespace='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID for the Amazon Web Services account that contains the folder.
string
[REQUIRED]
The ID of the folder.
string
The namespace of the folder whose permissions you want described.
integer
The maximum number of results to be returned per request.
string
A pagination token for the next set of results.
dict
Response Syntax
{
'Status': 123,
'FolderId': 'string',
'Arn': 'string',
'Permissions': [
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
'RequestId': 'string',
'NextToken': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
FolderId (string) --
The ID of the folder.
Arn (string) --
The Amazon Resource Name (ARN) for the folder.
Permissions (list) --
Information about the permissions on the folder.
(dict) --
Permission for the resource.
Principal (string) --
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
Actions (list) --
The IAM action to grant or revoke permissions on.
(string) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
NextToken (string) --
The pagination token for the next set of results, or null if there are no more results.
{'MaxResults': 'integer', 'Namespace': 'string', 'NextToken': 'string'}
Response {'NextToken': 'string'}
Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
See also: AWS API Documentation
Request Syntax
client.describe_folder_resolved_permissions(
AwsAccountId='string',
FolderId='string',
Namespace='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID for the Amazon Web Services account that contains the folder.
string
[REQUIRED]
The ID of the folder.
string
The namespace of the folder whose permissions you want described.
integer
The maximum number of results to be returned per request.
string
A pagination token for the next set of results.
dict
Response Syntax
{
'Status': 123,
'FolderId': 'string',
'Arn': 'string',
'Permissions': [
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
'RequestId': 'string',
'NextToken': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
FolderId (string) --
The ID of the folder.
Arn (string) --
The Amazon Resource Name (ARN) of the folder.
Permissions (list) --
Information about the permissions for the folder.
(dict) --
Permission for the resource.
Principal (string) --
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
Actions (list) --
The IAM action to grant or revoke permissions on.
(string) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
NextToken (string) --
A pagination token for the next set of results, or null if there are no more results.
{'Definition': {'FilterGroups': {'ScopeConfiguration': {'AllSheets': {}}},
'Sheets': {'Visuals': {'TableVisual': {'ChartConfiguration': {'FieldOptions': {'PinnedFieldOptions': {'PinnedLeftFields': ['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.
{'FolderSummaryList': {'SharingModel': 'ACCOUNT | NAMESPACE'}}
Lists all folders in an account.
See also: AWS API Documentation
Request Syntax
client.list_folders(
AwsAccountId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID for the Amazon Web Services account that contains the folder.
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
{
'Status': 123,
'FolderSummaryList': [
{
'Arn': 'string',
'FolderId': 'string',
'Name': 'string',
'FolderType': 'SHARED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'SharingModel': 'ACCOUNT'|'NAMESPACE'
},
],
'NextToken': 'string',
'RequestId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
FolderSummaryList (list) --
A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.
(dict) --
A summary of information about an existing Amazon QuickSight folder.
Arn (string) --
The Amazon Resource Name (ARN) of the folder.
FolderId (string) --
The ID of the folder.
Name (string) --
The display name of the folder.
FolderType (string) --
The type of folder.
CreatedTime (datetime) --
The time that the folder was created.
LastUpdatedTime (datetime) --
The time that the folder was last updated.
SharingModel (string) --
The sharing scope of the folder.
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.
{'FolderSummaryList': {'SharingModel': 'ACCOUNT | NAMESPACE'}}
Searches the subfolders in a folder.
See also: AWS API Documentation
Request Syntax
client.search_folders(
AwsAccountId='string',
Filters=[
{
'Operator': 'StringEquals'|'StringLike',
'Name': 'PARENT_FOLDER_ARN'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'QUICKSIGHT_OWNER'|'QUICKSIGHT_VIEWER_OR_OWNER'|'FOLDER_NAME',
'Value': 'string'
},
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID for the Amazon Web Services account that contains the folder.
list
[REQUIRED]
The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, "Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ] .
(dict) --
A filter to use to search an Amazon QuickSight folder.
Operator (string) --
The comparison operator that you want to use as a filter, for example "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" .
If you set the operator value to "StringEquals" , you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
If you set the value to "StringLike" , you need to provide the name of the folders you are searching for. For example, "Name":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test" . The "StringLike" operator only supports the NAME value FOLDER_NAME .
Name (string) --
The name of a value that you want to use in the filter. For example, "Name": "QUICKSIGHT_OWNER" .
Valid values are defined as follows:
QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any folders with that ARN listed as one of the folder's owners or viewers are returned. Implicit permissions from folders or groups are considered.
QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are considered.
DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any folders with that ARN listed as the only owner of the folder are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners or viewers of the folders are returned. Implicit permissions from folders or groups are not considered.
FOLDER_NAME : Any folders whose names have a substring match to this value will be returned.
PARENT_FOLDER_ARN : Provide an ARN of a folder, and any folders that are directly under that parent folder are returned. If you choose to use this option and leave the value blank, all root-level folders in the account are returned.
Value (string) --
The value of the named item (in this example, PARENT_FOLDER_ARN ), that you want to use as a filter. For example, "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" .
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
{
'Status': 123,
'FolderSummaryList': [
{
'Arn': 'string',
'FolderId': 'string',
'Name': 'string',
'FolderType': 'SHARED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'SharingModel': 'ACCOUNT'|'NAMESPACE'
},
],
'NextToken': 'string',
'RequestId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
FolderSummaryList (list) --
A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.
(dict) --
A summary of information about an existing Amazon QuickSight folder.
Arn (string) --
The Amazon Resource Name (ARN) of the folder.
FolderId (string) --
The ID of the folder.
Name (string) --
The display name of the folder.
FolderType (string) --
The type of folder.
CreatedTime (datetime) --
The time that the folder was created.
LastUpdatedTime (datetime) --
The time that the folder was last updated.
SharingModel (string) --
The sharing scope of the folder.
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.
{'SnapshotConfiguration': {'FileGroups': {'Files': {'FormatType': {'EXCEL'}}}}}
Starts an asynchronous job that generates a dashboard snapshot. You can request one of the following format configurations per API call.
1 paginated PDF
1 Excel workbook
5 CSVs
Poll job descriptions with a DescribeDashboardSnapshotJob API call. Once the job succeeds, use the DescribeDashboardSnapshotJobResult API to obtain the download URIs that the job generates.
See also: AWS API Documentation
Request Syntax
client.start_dashboard_snapshot_job(
AwsAccountId='string',
DashboardId='string',
SnapshotJobId='string',
UserConfiguration={
'AnonymousUsers': [
{
'RowLevelPermissionTags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
},
SnapshotConfiguration={
'FileGroups': [
{
'Files': [
{
'SheetSelections': [
{
'SheetId': 'string',
'SelectionScope': 'ALL_VISUALS'|'SELECTED_VISUALS',
'VisualIds': [
'string',
]
},
],
'FormatType': 'CSV'|'PDF'|'EXCEL'
},
]
},
],
'DestinationConfiguration': {
'S3Destinations': [
{
'BucketConfiguration': {
'BucketName': 'string',
'BucketPrefix': 'string',
'BucketRegion': 'string'
}
},
]
},
'Parameters': {
'StringParameters': [
{
'Name': 'string',
'Values': [
'string',
]
},
],
'IntegerParameters': [
{
'Name': 'string',
'Values': [
123,
]
},
],
'DecimalParameters': [
{
'Name': 'string',
'Values': [
123.0,
]
},
],
'DateTimeParameters': [
{
'Name': 'string',
'Values': [
datetime(2015, 1, 1),
]
},
]
}
}
)
string
[REQUIRED]
The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
string
[REQUIRED]
The ID of the dashboard that you want to start a snapshot job for.
string
[REQUIRED]
An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.
dict
[REQUIRED]
A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.
AnonymousUsers (list) --
An array of records that describe the anonymous users that the dashboard snapshot is generated for.
(dict) --
A structure that contains information on the anonymous user configuration.
RowLevelPermissionTags (list) --
The tags to be used for row-level security (RLS). Make sure that the relevant datasets have RLS tags configured before you start a snapshot export job. You can configure the RLS tags of a dataset with a DataSet$RowLevelPermissionTagConfiguration API call.
These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in Amazon QuickSight, 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.
dict
[REQUIRED]
A structure that describes the configuration of the dashboard snapshot.
FileGroups (list) -- [REQUIRED]
A list of SnapshotJobResultFileGroup objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 FileGroup configurations.
(dict) --
A structure that contains the information on the snapshot files.
Files (list) --
A list of SnapshotFile objects that contain the information on the snapshot files that need to be generated. This structure can hold 1 configuration at a time.
(dict) --
A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.
SheetSelections (list) -- [REQUIRED]
A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.
(dict) --
A structure that contains information that identifies the snapshot that needs to be generated.
SheetId (string) -- [REQUIRED]
The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.
SelectionScope (string) -- [REQUIRED]
The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.
ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.
SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook.
VisualIds (list) --
A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.
(string) --
FormatType (string) -- [REQUIRED]
The format of the snapshot file to be generated. You can choose between CSV , Excel , or PDF .
DestinationConfiguration (dict) --
A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.
S3Destinations (list) --
A list of SnapshotS3DestinationConfiguration objects that contain Amazon S3 destination configurations. This structure can hold a maximum of 1 S3DestinationConfiguration .
(dict) --
A structure that describes the Amazon S3 settings to use to save the generated dashboard snapshot.
BucketConfiguration (dict) --
A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in.
BucketName (string) -- [REQUIRED]
The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.
BucketPrefix (string) -- [REQUIRED]
The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
BucketRegion (string) -- [REQUIRED]
The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.
Parameters (dict) --
A list of Amazon QuickSight parameters and the list's override values.
StringParameters (list) --
The parameters that have a data type of string.
(dict) --
A string parameter.
Name (string) -- [REQUIRED]
A display name for a string parameter.
Values (list) -- [REQUIRED]
The values of a string parameter.
(string) --
IntegerParameters (list) --
The parameters that have a data type of integer.
(dict) --
An integer parameter.
Name (string) -- [REQUIRED]
The name of the integer parameter.
Values (list) -- [REQUIRED]
The values for the integer parameter.
(integer) --
DecimalParameters (list) --
The parameters that have a data type of decimal.
(dict) --
A decimal parameter.
Name (string) -- [REQUIRED]
A display name for the decimal parameter.
Values (list) -- [REQUIRED]
The values for the decimal parameter.
(float) --
DateTimeParameters (list) --
The parameters that have a data type of date-time.
(dict) --
A date-time parameter.
Name (string) -- [REQUIRED]
A display name for the date-time parameter.
Values (list) -- [REQUIRED]
The values for the date-time parameter.
(datetime) --
dict
Response Syntax
{
'Arn': 'string',
'SnapshotJobId': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) for the dashboard snapshot job.
SnapshotJobId (string) --
The ID of the job. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request
{'Definition': {'FilterGroups': {'ScopeConfiguration': {'AllSheets': {}}},
'Sheets': {'Visuals': {'TableVisual': {'ChartConfiguration': {'FieldOptions': {'PinnedFieldOptions': {'PinnedLeftFields': ['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': {'FilterGroups': {'ScopeConfiguration': {'AllSheets': {}}},
'Sheets': {'Visuals': {'TableVisual': {'ChartConfiguration': {'FieldOptions': {'PinnedFieldOptions': {'PinnedLeftFields': ['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.
{'Definition': {'FilterGroups': {'ScopeConfiguration': {'AllSheets': {}}},
'Sheets': {'Visuals': {'TableVisual': {'ChartConfiguration': {'FieldOptions': {'PinnedFieldOptions': {'PinnedLeftFields': ['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.