2020/07/22 - Amazon QuickSight - 11 new8 updated api methods
Changes Update quicksight client to latest version
Describes the current namespace.
See also: AWS API Documentation
Request Syntax
client.describe_namespace(
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The ID for the AWS account that contains the QuickSight namespace that you want to describe.
string
[REQUIRED]
The namespace that you want to describe.
dict
Response Syntax
{
'Namespace': {
'Name': 'string',
'Arn': 'string',
'CapacityRegion': 'string',
'CreationStatus': 'CREATED'|'CREATING'|'DELETING'|'RETRYABLE_FAILURE'|'NON_RETRYABLE_FAILURE',
'IdentityStore': 'QUICKSIGHT',
'NamespaceError': {
'Type': 'PERMISSION_DENIED'|'INTERNAL_SERVICE_ERROR',
'Message': 'string'
}
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Namespace (dict) --
The information about the namespace that you're describing. The response includes the namespace ARN, name, AWS Region, creation status, and identity store. DescribeNamespace also works for namespaces that are in the process of being created. For incomplete namespaces, this API lists the namespace error types and messages associated with the creation process.
Name (string) --
The name of the error.
Arn (string) --
The namespace ARN.
CapacityRegion (string) --
The namespace AWS Region.
CreationStatus (string) --
The creation status of a namespace that is not yet completely created.
IdentityStore (string) --
The identity store used for the namespace.
NamespaceError (dict) --
An error that occured when the namespace was created.
Type (string) --
The error type.
Message (string) --
The message for the error.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Lists the namespaces for the specified AWS account.
See also: AWS API Documentation
Request Syntax
client.list_namespaces(
AwsAccountId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID for the AWS account that contains the QuickSight namespaces that you want to list.
string
A pagination token that can be used in a subsequent request.
integer
The maximum number of results to return.
dict
Response Syntax
{
'Namespaces': [
{
'Name': 'string',
'Arn': 'string',
'CapacityRegion': 'string',
'CreationStatus': 'CREATED'|'CREATING'|'DELETING'|'RETRYABLE_FAILURE'|'NON_RETRYABLE_FAILURE',
'IdentityStore': 'QUICKSIGHT',
'NamespaceError': {
'Type': 'PERMISSION_DENIED'|'INTERNAL_SERVICE_ERROR',
'Message': 'string'
}
},
],
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Namespaces (list) --
The information about the namespaces in this AWS account. The response includes the namespace ARN, name, AWS Region, notification email address, creation status, and identity store.
(dict) --
The error type.
Name (string) --
The name of the error.
Arn (string) --
The namespace ARN.
CapacityRegion (string) --
The namespace AWS Region.
CreationStatus (string) --
The creation status of a namespace that is not yet completely created.
IdentityStore (string) --
The identity store used for the namespace.
NamespaceError (dict) --
An error that occured when the namespace was created.
Type (string) --
The error type.
Message (string) --
The message for the error.
NextToken (string) --
A pagination token that can be used in a subsequent request.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Generates a session URL and authorization code that you can embed in your web server code.
See also: AWS API Documentation
Request Syntax
client.get_session_embed_url(
AwsAccountId='string',
EntryPoint='string',
SessionLifetimeInMinutes=123,
UserArn='string'
)
string
[REQUIRED]
The ID for the AWS account that contains the QuickSight session that you're embedding.
string
The entry point for the embedded session.
integer
How many minutes the session is valid. The session lifetime must be 15-600 minutes.
string
The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:
Active Directory (AD) users or group members
Invited nonfederated users
IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.
dict
Response Syntax
{
'EmbedUrl': 'string',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
EmbedUrl (string) --
A single-use URL that you can put into your server-side web page to embed your QuickSight session. This URL is valid for 5 minutes. The API provides the URL with an auth_code value that enables one (and only one) sign-on to a user session that is valid for 10 hours.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The AWS request ID for this operation.
Describes the settings that were used when your QuickSight subscription was first created in this AWS Account.
See also: AWS API Documentation
Request Syntax
client.describe_account_settings(
AwsAccountId='string'
)
string
[REQUIRED]
The ID for the AWS account that contains the QuickSight namespaces that you want to list.
dict
Response Syntax
{
'AccountSettings': {
'AccountName': 'string',
'Edition': 'STANDARD'|'ENTERPRISE',
'DefaultNamespace': 'string',
'NotificationEmail': 'string'
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
AccountSettings (dict) --
The settings associated with the QuickSight subscription associated with this AWS account. This information includes the edition of Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the QuickSight subscription. The QuickSight console, the QuickSight subscription is sometimes referred to as a QuickSight "account" even though it is technically not an account, but a subscription in your AWS account.
AccountName (string) --
The name associated with the QuickSight subscription in your AWS account.
Edition (string) --
The edition of QuickSight that you're currently subscribed to.
DefaultNamespace (string) --
The default QuickSight namespace for your AWS account.
NotificationEmail (string) --
The main notification email for your QuickSight subscription.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Updates customizations associated with the QuickSight subscription on your AWS account.
See also: AWS API Documentation
Request Syntax
client.update_account_customization(
AwsAccountId='string',
Namespace='string',
AccountCustomization={
'DefaultTheme': 'string'
}
)
string
[REQUIRED]
The ID for the AWS account that you want to update QuickSight customizations for.
string
The namespace associated with the customization that you're updating.
dict
[REQUIRED]
The customizations you want to update in QuickSight.
DefaultTheme (string) --
The default theme for this QuickSight subscription.
dict
Response Syntax
{
'AwsAccountId': 'string',
'Namespace': 'string',
'AccountCustomization': {
'DefaultTheme': 'string'
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
AwsAccountId (string) --
The ID for the AWS account that you want to update QuickSight customizations for.
Namespace (string) --
The namespace associated with the customization that you're updating.
AccountCustomization (dict) --
The customizations associated with your QuickSight subscription.
DefaultTheme (string) --
The default theme for this QuickSight subscription.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Describes the customizations associated with your AWS account.
See also: AWS API Documentation
Request Syntax
client.describe_account_customization(
AwsAccountId='string',
Namespace='string',
Resolved=True|False
)
string
[REQUIRED]
The ID for the AWS account that you want to describe QuickSight customizations for.
string
The namespace associated with the customization that you're describing.
boolean
The status of the creation of the customization. This is an asynchronous process. A status of CREATED means that your customization is ready to use.
dict
Response Syntax
{
'AwsAccountId': 'string',
'Namespace': 'string',
'AccountCustomization': {
'DefaultTheme': 'string'
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
AwsAccountId (string) --
The ID for the AWS account that you want to describe QuickSight customizations for.
Namespace (string) --
The namespace associated with the customization that you're describing.
AccountCustomization (dict) --
The customizations associated with QuickSight.
DefaultTheme (string) --
The default theme for this QuickSight subscription.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your AWS account is subscribed to QuickSight. The namespace must be unique within the AWS account. By default, there is a limit of 100 namespaces per AWS account. To increase your limit, create a ticket with AWS Support.
See also: AWS API Documentation
Request Syntax
client.create_namespace(
AwsAccountId='string',
Namespace='string',
IdentityStore='QUICKSIGHT',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ID for the AWS account that you want to create the QuickSight namespace in.
string
[REQUIRED]
The name that you want to use to describe the new namespace.
string
[REQUIRED]
Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.
list
The tags that you want to associate with the namespace that you're creating.
(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.
dict
Response Syntax
{
'Arn': 'string',
'Name': 'string',
'CapacityRegion': 'string',
'CreationStatus': 'CREATED'|'CREATING'|'DELETING'|'RETRYABLE_FAILURE'|'NON_RETRYABLE_FAILURE',
'IdentityStore': 'QUICKSIGHT',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The ARN of the QuickSight namespace you created.
Name (string) --
The name of the new namespace that you created.
CapacityRegion (string) --
The AWS Region that you want to use for the free SPICE capacity for the new namespace. This is set to the region that you run CreateNamespace in.
CreationStatus (string) --
The status of the creation of the namespace. This is an asynchronous process. A status of CREATED means that your namespace is ready to use. If an error occurs, it indicates if the process is retryable or non-retryable. In the case of a non-retryable error, refer to the error message for follow-up actions.
IdentityStore (string) --
Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Creates a customization for the Amazon QuickSight subscription associated with your AWS account.
See also: AWS API Documentation
Request Syntax
client.create_account_customization(
AwsAccountId='string',
Namespace='string',
AccountCustomization={
'DefaultTheme': 'string'
}
)
string
[REQUIRED]
The ID for the AWS account that you want to customize QuickSight for.
string
The namespace associated with the customization that you're creating.
dict
[REQUIRED]
The customizations you're adding to the QuickSight subscription for the AWS account. For example, you could add a default theme by setting AccountCustomization to the midnight theme ( DefaultTheme="arn:aws:quicksight::aws:theme/MIDNIGHT") or to a custom theme ( DefaultTheme="arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639").
DefaultTheme (string) --
The default theme for this QuickSight subscription.
dict
Response Syntax
{
'AwsAccountId': 'string',
'Namespace': 'string',
'AccountCustomization': {
'DefaultTheme': 'string'
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
AwsAccountId (string) --
The ID for the AWS account that you want to customize QuickSight for.
Namespace (string) --
The namespace associated with the customization you're creating.
AccountCustomization (dict) --
The customizations you're adding to the QuickSight subscription for the AWS account.
DefaultTheme (string) --
The default theme for this QuickSight subscription.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Updates the settings for the Amazon QuickSight subscription in your AWS Account.
See also: AWS API Documentation
Request Syntax
client.update_account_settings(
AwsAccountId='string',
DefaultNamespace='string',
NotificationEmail='string'
)
string
[REQUIRED]
The ID for the AWS account that contains the QuickSight namespaces that you want to list.
string
[REQUIRED]
The default namespace for this AWS Account. Currently, the default is default. IAM users who register for the first time with QuickSight provide an email that becomes associated with the default namespace.
string
Email address used to send notifications regarding administration of QuickSight.
dict
Response Syntax
{
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Deletes customizations for the QuickSight subscription on your AWS account.
See also: AWS API Documentation
Request Syntax
client.delete_account_customization(
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The ID for the AWS account that you want to delete QuickSight customizations from.
string
The namespace associated with the customization that you're deleting.
dict
Response Syntax
{
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the APIs for the relevant asset.
See also: AWS API Documentation
Request Syntax
client.delete_namespace(
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The ID for the AWS account that you want to delete the QuickSight namespace from.
string
[REQUIRED]
The namespace that you want to delete.
dict
Response Syntax
{
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'RowLevelPermissionDataSet': {'Namespace': 'string'}}
Creates a dataset.
See also: AWS API Documentation
Request Syntax
client.create_data_set(
AwsAccountId='string',
DataSetId='string',
Name='string',
PhysicalTableMap={
'string': {
'RelationalTable': {
'DataSourceArn': 'string',
'Schema': 'string',
'Name': 'string',
'InputColumns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'
},
]
},
'CustomSql': {
'DataSourceArn': 'string',
'Name': 'string',
'SqlQuery': 'string',
'Columns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'
},
]
},
'S3Source': {
'DataSourceArn': 'string',
'UploadSettings': {
'Format': 'CSV'|'TSV'|'CLF'|'ELF'|'XLSX'|'JSON',
'StartFromRow': 123,
'ContainsHeader': True|False,
'TextQualifier': 'DOUBLE_QUOTE'|'SINGLE_QUOTE',
'Delimiter': 'string'
},
'InputColumns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'
},
]
}
}
},
LogicalTableMap={
'string': {
'Alias': 'string',
'DataTransforms': [
{
'ProjectOperation': {
'ProjectedColumns': [
'string',
]
},
'FilterOperation': {
'ConditionExpression': 'string'
},
'CreateColumnsOperation': {
'Columns': [
{
'ColumnName': 'string',
'ColumnId': 'string',
'Expression': 'string'
},
]
},
'RenameColumnOperation': {
'ColumnName': 'string',
'NewColumnName': 'string'
},
'CastColumnTypeOperation': {
'ColumnName': 'string',
'NewColumnType': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME',
'Format': 'string'
},
'TagColumnOperation': {
'ColumnName': 'string',
'Tags': [
{
'ColumnGeographicRole': 'COUNTRY'|'STATE'|'COUNTY'|'CITY'|'POSTCODE'|'LONGITUDE'|'LATITUDE'
},
]
}
},
],
'Source': {
'JoinInstruction': {
'LeftOperand': 'string',
'RightOperand': 'string',
'Type': 'INNER'|'OUTER'|'LEFT'|'RIGHT',
'OnClause': 'string'
},
'PhysicalTableId': 'string'
}
}
},
ImportMode='SPICE'|'DIRECT_QUERY',
ColumnGroups=[
{
'GeoSpatialColumnGroup': {
'Name': 'string',
'CountryCode': 'US',
'Columns': [
'string',
]
}
},
],
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
RowLevelPermissionDataSet={
'Namespace': 'string',
'Arn': 'string',
'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The AWS account ID.
string
[REQUIRED]
An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
string
[REQUIRED]
The display name for the dataset.
dict
[REQUIRED]
Declares the physical tables that are available in the underlying data sources.
(string) --
(dict) --
A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
RelationalTable (dict) --
A physical table type for relational data sources.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the data source.
Schema (string) --
The schema name. This name applies to certain relational database engines.
Name (string) -- [REQUIRED]
The name of the relational table.
InputColumns (list) -- [REQUIRED]
The column schema of the table.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Type (string) -- [REQUIRED]
The data type of the column.
CustomSql (dict) --
A physical table type built from the results of the custom SQL query.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the data source.
Name (string) -- [REQUIRED]
A display name for the SQL query result.
SqlQuery (string) -- [REQUIRED]
The SQL query.
Columns (list) --
The column schema from the SQL query result set.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Type (string) -- [REQUIRED]
The data type of the column.
S3Source (dict) --
A physical table type for as S3 data source.
DataSourceArn (string) -- [REQUIRED]
The amazon Resource Name (ARN) for the data source.
UploadSettings (dict) --
Information about the format for the S3 source file or files.
Format (string) --
File format.
StartFromRow (integer) --
A row number to start reading data from.
ContainsHeader (boolean) --
Whether the file has a header row, or the files each have a header row.
TextQualifier (string) --
Text qualifier.
Delimiter (string) --
The delimiter between values in the file.
InputColumns (list) -- [REQUIRED]
A physical table type for as S3 data source.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Type (string) -- [REQUIRED]
The data type of the column.
dict
Configures the combination and transformation of the data from the physical tables.
(string) --
(dict) --
A logical table is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.
Alias (string) -- [REQUIRED]
A display name for the logical table.
DataTransforms (list) --
Transform operations that act on this logical table.
(dict) --
A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ProjectOperation (dict) --
An operation that projects columns. Operations that come after a projection can only refer to projected columns.
ProjectedColumns (list) -- [REQUIRED]
Projected columns.
(string) --
FilterOperation (dict) --
An operation that filters rows based on some condition.
ConditionExpression (string) -- [REQUIRED]
An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
CreateColumnsOperation (dict) --
An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
Columns (list) -- [REQUIRED]
Calculated columns to create.
(dict) --
A calculated column for a dataset.
ColumnName (string) -- [REQUIRED]
Column name.
ColumnId (string) -- [REQUIRED]
A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.
Expression (string) -- [REQUIRED]
An expression that defines the calculated column.
RenameColumnOperation (dict) --
An operation that renames a column.
ColumnName (string) -- [REQUIRED]
The name of the column to be renamed.
NewColumnName (string) -- [REQUIRED]
The new name for the column.
CastColumnTypeOperation (dict) --
A transform operation that casts a column to a different type.
ColumnName (string) -- [REQUIRED]
Column name.
NewColumnType (string) -- [REQUIRED]
New column data type.
Format (string) --
When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.
TagColumnOperation (dict) --
An operation that tags a column with additional information.
ColumnName (string) -- [REQUIRED]
The column that this operation acts on.
Tags (list) -- [REQUIRED]
The dataset column tag, currently only used for geospatial type tagging. .
(dict) --
A tag for a column in a TagColumnOperation structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ColumnGeographicRole (string) --
A geospatial role for a column.
Source (dict) -- [REQUIRED]
Source of this logical table.
JoinInstruction (dict) --
Specifies the result of a join of two logical tables.
LeftOperand (string) -- [REQUIRED]
Left operand.
RightOperand (string) -- [REQUIRED]
Right operand.
Type (string) -- [REQUIRED]
Type.
OnClause (string) -- [REQUIRED]
On Clause.
PhysicalTableId (string) --
Physical table ID.
string
[REQUIRED]
Indicates whether you want to import the data into SPICE.
list
Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.
(dict) --
Groupings of columns that work together in certain Amazon QuickSight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
GeoSpatialColumnGroup (dict) --
Geospatial column group that denotes a hierarchy.
Name (string) -- [REQUIRED]
A display name for the hierarchy.
CountryCode (string) -- [REQUIRED]
Country code.
Columns (list) -- [REQUIRED]
Columns in this hierarchy.
(string) --
list
A list of resource permissions on the dataset.
(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, group, or namespace. (This is most common.)
The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.)
Actions (list) -- [REQUIRED]
The action to grant or revoke permissions on, for example "quicksight:DescribeDashboard".
(string) --
dict
The row-level security configuration for the data that you want to create.
Namespace (string) --
The namespace associated with the row-level permissions dataset.
Arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the permission dataset.
PermissionPolicy (string) -- [REQUIRED]
Permission policy.
list
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
(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.
dict
Response Syntax
{
'Arn': 'string',
'DataSetId': 'string',
'IngestionArn': 'string',
'IngestionId': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the dataset.
DataSetId (string) --
The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
IngestionArn (string) --
The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
IngestionId (string) --
The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'DataSet': {'RowLevelPermissionDataSet': {'Namespace': 'string'}}}
Describes a dataset.
See also: AWS API Documentation
Request Syntax
client.describe_data_set(
AwsAccountId='string',
DataSetId='string'
)
string
[REQUIRED]
The AWS account ID.
string
[REQUIRED]
The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
dict
Response Syntax
{
'DataSet': {
'Arn': 'string',
'DataSetId': 'string',
'Name': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'PhysicalTableMap': {
'string': {
'RelationalTable': {
'DataSourceArn': 'string',
'Schema': 'string',
'Name': 'string',
'InputColumns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'
},
]
},
'CustomSql': {
'DataSourceArn': 'string',
'Name': 'string',
'SqlQuery': 'string',
'Columns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'
},
]
},
'S3Source': {
'DataSourceArn': 'string',
'UploadSettings': {
'Format': 'CSV'|'TSV'|'CLF'|'ELF'|'XLSX'|'JSON',
'StartFromRow': 123,
'ContainsHeader': True|False,
'TextQualifier': 'DOUBLE_QUOTE'|'SINGLE_QUOTE',
'Delimiter': 'string'
},
'InputColumns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'
},
]
}
}
},
'LogicalTableMap': {
'string': {
'Alias': 'string',
'DataTransforms': [
{
'ProjectOperation': {
'ProjectedColumns': [
'string',
]
},
'FilterOperation': {
'ConditionExpression': 'string'
},
'CreateColumnsOperation': {
'Columns': [
{
'ColumnName': 'string',
'ColumnId': 'string',
'Expression': 'string'
},
]
},
'RenameColumnOperation': {
'ColumnName': 'string',
'NewColumnName': 'string'
},
'CastColumnTypeOperation': {
'ColumnName': 'string',
'NewColumnType': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME',
'Format': 'string'
},
'TagColumnOperation': {
'ColumnName': 'string',
'Tags': [
{
'ColumnGeographicRole': 'COUNTRY'|'STATE'|'COUNTY'|'CITY'|'POSTCODE'|'LONGITUDE'|'LATITUDE'
},
]
}
},
],
'Source': {
'JoinInstruction': {
'LeftOperand': 'string',
'RightOperand': 'string',
'Type': 'INNER'|'OUTER'|'LEFT'|'RIGHT',
'OnClause': 'string'
},
'PhysicalTableId': 'string'
}
}
},
'OutputColumns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'
},
],
'ImportMode': 'SPICE'|'DIRECT_QUERY',
'ConsumedSpiceCapacityInBytes': 123,
'ColumnGroups': [
{
'GeoSpatialColumnGroup': {
'Name': 'string',
'CountryCode': 'US',
'Columns': [
'string',
]
}
},
],
'RowLevelPermissionDataSet': {
'Namespace': 'string',
'Arn': 'string',
'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS'
}
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
DataSet (dict) --
Information on the dataset.
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
DataSetId (string) --
The ID of the dataset.
Name (string) --
A display name for the dataset.
CreatedTime (datetime) --
The time that this dataset was created.
LastUpdatedTime (datetime) --
The last time that this dataset was updated.
PhysicalTableMap (dict) --
Declares the physical tables that are available in the underlying data sources.
(string) --
(dict) --
A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
RelationalTable (dict) --
A physical table type for relational data sources.
DataSourceArn (string) --
The Amazon Resource Name (ARN) for the data source.
Schema (string) --
The schema name. This name applies to certain relational database engines.
Name (string) --
The name of the relational table.
InputColumns (list) --
The column schema of the table.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) --
The name of this column in the underlying data source.
Type (string) --
The data type of the column.
CustomSql (dict) --
A physical table type built from the results of the custom SQL query.
DataSourceArn (string) --
The Amazon Resource Name (ARN) of the data source.
Name (string) --
A display name for the SQL query result.
SqlQuery (string) --
The SQL query.
Columns (list) --
The column schema from the SQL query result set.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) --
The name of this column in the underlying data source.
Type (string) --
The data type of the column.
S3Source (dict) --
A physical table type for as S3 data source.
DataSourceArn (string) --
The amazon Resource Name (ARN) for the data source.
UploadSettings (dict) --
Information about the format for the S3 source file or files.
Format (string) --
File format.
StartFromRow (integer) --
A row number to start reading data from.
ContainsHeader (boolean) --
Whether the file has a header row, or the files each have a header row.
TextQualifier (string) --
Text qualifier.
Delimiter (string) --
The delimiter between values in the file.
InputColumns (list) --
A physical table type for as S3 data source.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) --
The name of this column in the underlying data source.
Type (string) --
The data type of the column.
LogicalTableMap (dict) --
Configures the combination and transformation of the data from the physical tables.
(string) --
(dict) --
A logical table is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.
Alias (string) --
A display name for the logical table.
DataTransforms (list) --
Transform operations that act on this logical table.
(dict) --
A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ProjectOperation (dict) --
An operation that projects columns. Operations that come after a projection can only refer to projected columns.
ProjectedColumns (list) --
Projected columns.
(string) --
FilterOperation (dict) --
An operation that filters rows based on some condition.
ConditionExpression (string) --
An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
CreateColumnsOperation (dict) --
An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
Columns (list) --
Calculated columns to create.
(dict) --
A calculated column for a dataset.
ColumnName (string) --
Column name.
ColumnId (string) --
A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.
Expression (string) --
An expression that defines the calculated column.
RenameColumnOperation (dict) --
An operation that renames a column.
ColumnName (string) --
The name of the column to be renamed.
NewColumnName (string) --
The new name for the column.
CastColumnTypeOperation (dict) --
A transform operation that casts a column to a different type.
ColumnName (string) --
Column name.
NewColumnType (string) --
New column data type.
Format (string) --
When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.
TagColumnOperation (dict) --
An operation that tags a column with additional information.
ColumnName (string) --
The column that this operation acts on.
Tags (list) --
The dataset column tag, currently only used for geospatial type tagging. .
(dict) --
A tag for a column in a TagColumnOperation structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ColumnGeographicRole (string) --
A geospatial role for a column.
Source (dict) --
Source of this logical table.
JoinInstruction (dict) --
Specifies the result of a join of two logical tables.
LeftOperand (string) --
Left operand.
RightOperand (string) --
Right operand.
Type (string) --
Type.
OnClause (string) --
On Clause.
PhysicalTableId (string) --
Physical table ID.
OutputColumns (list) --
The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.
(dict) --
Output column.
Name (string) --
A display name for the dataset.
Type (string) --
Type.
ImportMode (string) --
Indicates whether you want to import the data into SPICE.
ConsumedSpiceCapacityInBytes (integer) --
The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.
ColumnGroups (list) --
Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
(dict) --
Groupings of columns that work together in certain Amazon QuickSight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
GeoSpatialColumnGroup (dict) --
Geospatial column group that denotes a hierarchy.
Name (string) --
A display name for the hierarchy.
CountryCode (string) --
Country code.
Columns (list) --
Columns in this hierarchy.
(string) --
RowLevelPermissionDataSet (dict) --
The row-level security configuration for the dataset.
Namespace (string) --
The namespace associated with the row-level permissions dataset.
Arn (string) --
The Amazon Resource Name (ARN) of the permission dataset.
PermissionPolicy (string) --
Permission policy.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'User': {'CustomPermissionsName': 'string'}}
Returns information about a user, given the user name.
See also: AWS API Documentation
Request Syntax
client.describe_user(
UserName='string',
AwsAccountId='string',
Namespace='string'
)
string
[REQUIRED]
The name of the user that you want to describe.
string
[REQUIRED]
The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace. Currently, you should set this to default.
dict
Response Syntax
{
'User': {
'Arn': 'string',
'UserName': 'string',
'Email': 'string',
'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
'IdentityType': 'IAM'|'QUICKSIGHT',
'Active': True|False,
'PrincipalId': 'string',
'CustomPermissionsName': 'string'
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
User (dict) --
The user name.
Arn (string) --
The Amazon Resource Name (ARN) for the user.
UserName (string) --
The user's user name.
Email (string) --
The user's email address.
Role (string) --
The Amazon QuickSight role for the user. The user role can be one of the following:.
READER: A user who has read-only access to dashboards.
AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.
ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.
RESTRICTED_READER: This role isn't currently available for use.
RESTRICTED_AUTHOR: This role isn't currently available for use.
IdentityType (string) --
The type of identity authentication used by the user.
Active (boolean) --
The active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
PrincipalId (string) --
The principal ID of the user.
CustomPermissionsName (string) --
The custom permissions profile associated with this user.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'DataSetSummaries': {'RowLevelPermissionDataSet': {'Namespace': 'string'}}}
Lists all of the datasets belonging to the current AWS account in an AWS Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
See also: AWS API Documentation
Request Syntax
client.list_data_sets(
AwsAccountId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The AWS account ID.
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
{
'DataSetSummaries': [
{
'Arn': 'string',
'DataSetId': 'string',
'Name': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'ImportMode': 'SPICE'|'DIRECT_QUERY',
'RowLevelPermissionDataSet': {
'Namespace': 'string',
'Arn': 'string',
'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS'
}
},
],
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
DataSetSummaries (list) --
The list of dataset summaries.
(dict) --
Dataset summary.
Arn (string) --
The Amazon Resource Name (ARN) of the dataset.
DataSetId (string) --
The ID of the dataset.
Name (string) --
A display name for the dataset.
CreatedTime (datetime) --
The time that this dataset was created.
LastUpdatedTime (datetime) --
The last time that this dataset was updated.
ImportMode (string) --
Indicates whether you want to import the data into SPICE.
RowLevelPermissionDataSet (dict) --
The row-level security configuration for the dataset.
Namespace (string) --
The namespace associated with the row-level permissions dataset.
Arn (string) --
The Amazon Resource Name (ARN) of the permission dataset.
PermissionPolicy (string) --
Permission policy.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'UserList': {'CustomPermissionsName': 'string'}}
Returns a list of all of the Amazon QuickSight users belonging to this account.
See also: AWS API Documentation
Request Syntax
client.list_users(
AwsAccountId='string',
NextToken='string',
MaxResults=123,
Namespace='string'
)
string
[REQUIRED]
The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
string
A pagination token that can be used in a subsequent request.
integer
The maximum number of results to return from this request.
string
[REQUIRED]
The namespace. Currently, you should set this to default.
dict
Response Syntax
{
'UserList': [
{
'Arn': 'string',
'UserName': 'string',
'Email': 'string',
'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
'IdentityType': 'IAM'|'QUICKSIGHT',
'Active': True|False,
'PrincipalId': 'string',
'CustomPermissionsName': 'string'
},
],
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
UserList (list) --
The list of users.
(dict) --
A registered user of Amazon QuickSight. Currently, an Amazon QuickSight subscription can't contain more than 20 million users.
Arn (string) --
The Amazon Resource Name (ARN) for the user.
UserName (string) --
The user's user name.
Email (string) --
The user's email address.
Role (string) --
The Amazon QuickSight role for the user. The user role can be one of the following:.
READER: A user who has read-only access to dashboards.
AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.
ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.
RESTRICTED_READER: This role isn't currently available for use.
RESTRICTED_AUTHOR: This role isn't currently available for use.
IdentityType (string) --
The type of identity authentication used by the user.
Active (boolean) --
The active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
PrincipalId (string) --
The principal ID of the user.
CustomPermissionsName (string) --
The custom permissions profile associated with this user.
NextToken (string) --
A pagination token that can be used in a subsequent request.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'CustomPermissionsName': 'string'}
Response {'User': {'CustomPermissionsName': 'string'}}
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
See also: AWS API Documentation
Request Syntax
client.register_user(
IdentityType='IAM'|'QUICKSIGHT',
Email='string',
UserRole='ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
IamArn='string',
SessionName='string',
AwsAccountId='string',
Namespace='string',
UserName='string',
CustomPermissionsName='string'
)
string
[REQUIRED]
Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:
IAM: A user whose identity maps to an existing IAM user or role.
QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.
string
[REQUIRED]
The email address of the user that you want to register.
string
[REQUIRED]
The Amazon QuickSight role for the user. The user role can be one of the following:
READER: A user who has read-only access to dashboards.
AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.
ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.
RESTRICTED_READER: This role isn't currently available for use.
RESTRICTED_AUTHOR: This role isn't currently available for use.
string
The ARN of the IAM user or role that you are registering with Amazon QuickSight.
string
You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon QuickSight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see assume-role in the AWS CLI Reference.
string
[REQUIRED]
The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace. Currently, you should set this to default.
string
The Amazon QuickSight user name that you want to create for the user you are registering.
string
(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Currently, custom permissions profile names are assigned to permissions profiles in the QuickSight console. You use this API to assign the named set of permissions to a QuickSight user.
Customizing permissions in the QuickSight UI allows you to control a user's access to the following operations:
QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts (admin, author, reader) in QuickSight.
This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).
dict
Response Syntax
{
'User': {
'Arn': 'string',
'UserName': 'string',
'Email': 'string',
'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
'IdentityType': 'IAM'|'QUICKSIGHT',
'Active': True|False,
'PrincipalId': 'string',
'CustomPermissionsName': 'string'
},
'UserInvitationUrl': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
User (dict) --
The user name.
Arn (string) --
The Amazon Resource Name (ARN) for the user.
UserName (string) --
The user's user name.
Email (string) --
The user's email address.
Role (string) --
The Amazon QuickSight role for the user. The user role can be one of the following:.
READER: A user who has read-only access to dashboards.
AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.
ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.
RESTRICTED_READER: This role isn't currently available for use.
RESTRICTED_AUTHOR: This role isn't currently available for use.
IdentityType (string) --
The type of identity authentication used by the user.
Active (boolean) --
The active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
PrincipalId (string) --
The principal ID of the user.
CustomPermissionsName (string) --
The custom permissions profile associated with this user.
UserInvitationUrl (string) --
The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of QUICKSIGHT.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'RowLevelPermissionDataSet': {'Namespace': 'string'}}
Updates a dataset.
See also: AWS API Documentation
Request Syntax
client.update_data_set(
AwsAccountId='string',
DataSetId='string',
Name='string',
PhysicalTableMap={
'string': {
'RelationalTable': {
'DataSourceArn': 'string',
'Schema': 'string',
'Name': 'string',
'InputColumns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'
},
]
},
'CustomSql': {
'DataSourceArn': 'string',
'Name': 'string',
'SqlQuery': 'string',
'Columns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'
},
]
},
'S3Source': {
'DataSourceArn': 'string',
'UploadSettings': {
'Format': 'CSV'|'TSV'|'CLF'|'ELF'|'XLSX'|'JSON',
'StartFromRow': 123,
'ContainsHeader': True|False,
'TextQualifier': 'DOUBLE_QUOTE'|'SINGLE_QUOTE',
'Delimiter': 'string'
},
'InputColumns': [
{
'Name': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'
},
]
}
}
},
LogicalTableMap={
'string': {
'Alias': 'string',
'DataTransforms': [
{
'ProjectOperation': {
'ProjectedColumns': [
'string',
]
},
'FilterOperation': {
'ConditionExpression': 'string'
},
'CreateColumnsOperation': {
'Columns': [
{
'ColumnName': 'string',
'ColumnId': 'string',
'Expression': 'string'
},
]
},
'RenameColumnOperation': {
'ColumnName': 'string',
'NewColumnName': 'string'
},
'CastColumnTypeOperation': {
'ColumnName': 'string',
'NewColumnType': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME',
'Format': 'string'
},
'TagColumnOperation': {
'ColumnName': 'string',
'Tags': [
{
'ColumnGeographicRole': 'COUNTRY'|'STATE'|'COUNTY'|'CITY'|'POSTCODE'|'LONGITUDE'|'LATITUDE'
},
]
}
},
],
'Source': {
'JoinInstruction': {
'LeftOperand': 'string',
'RightOperand': 'string',
'Type': 'INNER'|'OUTER'|'LEFT'|'RIGHT',
'OnClause': 'string'
},
'PhysicalTableId': 'string'
}
}
},
ImportMode='SPICE'|'DIRECT_QUERY',
ColumnGroups=[
{
'GeoSpatialColumnGroup': {
'Name': 'string',
'CountryCode': 'US',
'Columns': [
'string',
]
}
},
],
RowLevelPermissionDataSet={
'Namespace': 'string',
'Arn': 'string',
'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS'
}
)
string
[REQUIRED]
The AWS account ID.
string
[REQUIRED]
The ID for the dataset that you want to update. This ID is unique per AWS Region for each AWS account.
string
[REQUIRED]
The display name for the dataset.
dict
[REQUIRED]
Declares the physical tables that are available in the underlying data sources.
(string) --
(dict) --
A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
RelationalTable (dict) --
A physical table type for relational data sources.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the data source.
Schema (string) --
The schema name. This name applies to certain relational database engines.
Name (string) -- [REQUIRED]
The name of the relational table.
InputColumns (list) -- [REQUIRED]
The column schema of the table.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Type (string) -- [REQUIRED]
The data type of the column.
CustomSql (dict) --
A physical table type built from the results of the custom SQL query.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the data source.
Name (string) -- [REQUIRED]
A display name for the SQL query result.
SqlQuery (string) -- [REQUIRED]
The SQL query.
Columns (list) --
The column schema from the SQL query result set.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Type (string) -- [REQUIRED]
The data type of the column.
S3Source (dict) --
A physical table type for as S3 data source.
DataSourceArn (string) -- [REQUIRED]
The amazon Resource Name (ARN) for the data source.
UploadSettings (dict) --
Information about the format for the S3 source file or files.
Format (string) --
File format.
StartFromRow (integer) --
A row number to start reading data from.
ContainsHeader (boolean) --
Whether the file has a header row, or the files each have a header row.
TextQualifier (string) --
Text qualifier.
Delimiter (string) --
The delimiter between values in the file.
InputColumns (list) -- [REQUIRED]
A physical table type for as S3 data source.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Type (string) -- [REQUIRED]
The data type of the column.
dict
Configures the combination and transformation of the data from the physical tables.
(string) --
(dict) --
A logical table is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.
Alias (string) -- [REQUIRED]
A display name for the logical table.
DataTransforms (list) --
Transform operations that act on this logical table.
(dict) --
A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ProjectOperation (dict) --
An operation that projects columns. Operations that come after a projection can only refer to projected columns.
ProjectedColumns (list) -- [REQUIRED]
Projected columns.
(string) --
FilterOperation (dict) --
An operation that filters rows based on some condition.
ConditionExpression (string) -- [REQUIRED]
An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
CreateColumnsOperation (dict) --
An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
Columns (list) -- [REQUIRED]
Calculated columns to create.
(dict) --
A calculated column for a dataset.
ColumnName (string) -- [REQUIRED]
Column name.
ColumnId (string) -- [REQUIRED]
A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.
Expression (string) -- [REQUIRED]
An expression that defines the calculated column.
RenameColumnOperation (dict) --
An operation that renames a column.
ColumnName (string) -- [REQUIRED]
The name of the column to be renamed.
NewColumnName (string) -- [REQUIRED]
The new name for the column.
CastColumnTypeOperation (dict) --
A transform operation that casts a column to a different type.
ColumnName (string) -- [REQUIRED]
Column name.
NewColumnType (string) -- [REQUIRED]
New column data type.
Format (string) --
When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.
TagColumnOperation (dict) --
An operation that tags a column with additional information.
ColumnName (string) -- [REQUIRED]
The column that this operation acts on.
Tags (list) -- [REQUIRED]
The dataset column tag, currently only used for geospatial type tagging. .
(dict) --
A tag for a column in a TagColumnOperation structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ColumnGeographicRole (string) --
A geospatial role for a column.
Source (dict) -- [REQUIRED]
Source of this logical table.
JoinInstruction (dict) --
Specifies the result of a join of two logical tables.
LeftOperand (string) -- [REQUIRED]
Left operand.
RightOperand (string) -- [REQUIRED]
Right operand.
Type (string) -- [REQUIRED]
Type.
OnClause (string) -- [REQUIRED]
On Clause.
PhysicalTableId (string) --
Physical table ID.
string
[REQUIRED]
Indicates whether you want to import the data into SPICE.
list
Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.
(dict) --
Groupings of columns that work together in certain Amazon QuickSight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
GeoSpatialColumnGroup (dict) --
Geospatial column group that denotes a hierarchy.
Name (string) -- [REQUIRED]
A display name for the hierarchy.
CountryCode (string) -- [REQUIRED]
Country code.
Columns (list) -- [REQUIRED]
Columns in this hierarchy.
(string) --
dict
The row-level security configuration for the data you want to create.
Namespace (string) --
The namespace associated with the row-level permissions dataset.
Arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the permission dataset.
PermissionPolicy (string) -- [REQUIRED]
Permission policy.
dict
Response Syntax
{
'Arn': 'string',
'DataSetId': 'string',
'IngestionArn': 'string',
'IngestionId': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the dataset.
DataSetId (string) --
The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
IngestionArn (string) --
The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
IngestionId (string) --
The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'CustomPermissionsName': 'string', 'UnapplyCustomPermissions': 'boolean'}
Response {'User': {'CustomPermissionsName': 'string'}}
Updates an Amazon QuickSight user.
See also: AWS API Documentation
Request Syntax
client.update_user(
UserName='string',
AwsAccountId='string',
Namespace='string',
Email='string',
Role='ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
CustomPermissionsName='string',
UnapplyCustomPermissions=True|False
)
string
[REQUIRED]
The Amazon QuickSight user name that you want to update.
string
[REQUIRED]
The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
string
[REQUIRED]
The namespace. Currently, you should set this to default.
string
[REQUIRED]
The email address of the user that you want to update.
string
[REQUIRED]
The Amazon QuickSight role of the user. The user role can be one of the following:
READER: A user who has read-only access to dashboards.
AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.
ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.
string
The name of the custom permissions profile that you want to assign to this user. Currently, custom permissions profile names are assigned to permissions profiles in the QuickSight console. You use this API to assign the named set of permissions to a QuickSight user.
boolean
A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn't accept any other value.
dict
Response Syntax
{
'User': {
'Arn': 'string',
'UserName': 'string',
'Email': 'string',
'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
'IdentityType': 'IAM'|'QUICKSIGHT',
'Active': True|False,
'PrincipalId': 'string',
'CustomPermissionsName': 'string'
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
User (dict) --
The Amazon QuickSight user.
Arn (string) --
The Amazon Resource Name (ARN) for the user.
UserName (string) --
The user's user name.
Email (string) --
The user's email address.
Role (string) --
The Amazon QuickSight role for the user. The user role can be one of the following:.
READER: A user who has read-only access to dashboards.
AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.
ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.
RESTRICTED_READER: This role isn't currently available for use.
RESTRICTED_AUTHOR: This role isn't currently available for use.
IdentityType (string) --
The type of identity authentication used by the user.
Active (boolean) --
The active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
PrincipalId (string) --
The principal ID of the user.
CustomPermissionsName (string) --
The custom permissions profile associated with this user.
RequestId (string) --
The AWS request ID for this operation.
Status (integer) --
The HTTP status of the request.