Amazon QuickSight

2020/11/11 - Amazon QuickSight - 8 updated api methods

Changes  QuickSight now supports Column-level security and connecting to Oracle data source.

CreateDataSet (updated) Link ¶
Changes (request)
{'ColumnLevelPermissionRules': [{'ColumnNames': ['string'],
                                 'Principals': ['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',
                                'ColumnDescription': {
                                    'Text': 'string'
                                }
                            },
                        ]
                    }
                },
            ],
            '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'
    },
    ColumnLevelPermissionRules=[
        {
            'Principals': [
                'string',
            ],
            'ColumnNames': [
                'string',
            ]
        },
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The AWS account ID.

type DataSetId

string

param DataSetId

[REQUIRED]

An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.

type Name

string

param Name

[REQUIRED]

The display name for the dataset.

type PhysicalTableMap

dict

param PhysicalTableMap

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

type LogicalTableMap

dict

param LogicalTableMap

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

              Note

              This is not tags for the AWS tagging feature. .

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

                • ColumnDescription (dict) --

                  A description for a column.

                  • Text (string) --

                    The text of a description 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.

type ImportMode

string

param ImportMode

[REQUIRED]

Indicates whether you want to import the data into SPICE.

type ColumnGroups

list

param ColumnGroups

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

type Permissions

list

param Permissions

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 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 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 IAM action to grant or revoke permissions on.

      • (string) --

type RowLevelPermissionDataSet

dict

param RowLevelPermissionDataSet

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.

type ColumnLevelPermissionRules

list

param ColumnLevelPermissionRules

A set of one or more definitions of a `` ColumnLevelPermissionRule `` .

  • (dict) --

    A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.

    • Principals (list) --

      An array of Amazon Resource Names (ARNs) for QuickSight users or groups.

      • (string) --

    • ColumnNames (list) --

      An array of column names.

      • (string) --

type Tags

list

param Tags

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.

rtype

dict

returns

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.

CreateDataSource (updated) Link ¶
Changes (request)
{'Credentials': {'CredentialPair': {'AlternateDataSourceParameters': {'OracleParameters': {'Database': 'string',
                                                                                           'Host': 'string',
                                                                                           'Port': 'integer'}}}},
 'DataSourceParameters': {'OracleParameters': {'Database': 'string',
                                               'Host': 'string',
                                               'Port': 'integer'}},
 'Type': {'ORACLE'}}

Creates a data source.

See also: AWS API Documentation

Request Syntax

client.create_data_source(
    AwsAccountId='string',
    DataSourceId='string',
    Name='string',
    Type='ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM',
    DataSourceParameters={
        'AmazonElasticsearchParameters': {
            'Domain': 'string'
        },
        'AthenaParameters': {
            'WorkGroup': 'string'
        },
        'AuroraParameters': {
            'Host': 'string',
            'Port': 123,
            'Database': 'string'
        },
        'AuroraPostgreSqlParameters': {
            'Host': 'string',
            'Port': 123,
            'Database': 'string'
        },
        'AwsIotAnalyticsParameters': {
            'DataSetName': 'string'
        },
        'JiraParameters': {
            'SiteBaseUrl': 'string'
        },
        'MariaDbParameters': {
            'Host': 'string',
            'Port': 123,
            'Database': 'string'
        },
        'MySqlParameters': {
            'Host': 'string',
            'Port': 123,
            'Database': 'string'
        },
        'OracleParameters': {
            'Host': 'string',
            'Port': 123,
            'Database': 'string'
        },
        'PostgreSqlParameters': {
            'Host': 'string',
            'Port': 123,
            'Database': 'string'
        },
        'PrestoParameters': {
            'Host': 'string',
            'Port': 123,
            'Catalog': 'string'
        },
        'RdsParameters': {
            'InstanceId': 'string',
            'Database': 'string'
        },
        'RedshiftParameters': {
            'Host': 'string',
            'Port': 123,
            'Database': 'string',
            'ClusterId': 'string'
        },
        'S3Parameters': {
            'ManifestFileLocation': {
                'Bucket': 'string',
                'Key': 'string'
            }
        },
        'ServiceNowParameters': {
            'SiteBaseUrl': 'string'
        },
        'SnowflakeParameters': {
            'Host': 'string',
            'Database': 'string',
            'Warehouse': 'string'
        },
        'SparkParameters': {
            'Host': 'string',
            'Port': 123
        },
        'SqlServerParameters': {
            'Host': 'string',
            'Port': 123,
            'Database': 'string'
        },
        'TeradataParameters': {
            'Host': 'string',
            'Port': 123,
            'Database': 'string'
        },
        'TwitterParameters': {
            'Query': 'string',
            'MaxRows': 123
        }
    },
    Credentials={
        'CredentialPair': {
            'Username': 'string',
            'Password': 'string',
            'AlternateDataSourceParameters': [
                {
                    'AmazonElasticsearchParameters': {
                        'Domain': 'string'
                    },
                    'AthenaParameters': {
                        'WorkGroup': 'string'
                    },
                    'AuroraParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'AuroraPostgreSqlParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'AwsIotAnalyticsParameters': {
                        'DataSetName': 'string'
                    },
                    'JiraParameters': {
                        'SiteBaseUrl': 'string'
                    },
                    'MariaDbParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'MySqlParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'OracleParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'PostgreSqlParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'PrestoParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Catalog': 'string'
                    },
                    'RdsParameters': {
                        'InstanceId': 'string',
                        'Database': 'string'
                    },
                    'RedshiftParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string',
                        'ClusterId': 'string'
                    },
                    'S3Parameters': {
                        'ManifestFileLocation': {
                            'Bucket': 'string',
                            'Key': 'string'
                        }
                    },
                    'ServiceNowParameters': {
                        'SiteBaseUrl': 'string'
                    },
                    'SnowflakeParameters': {
                        'Host': 'string',
                        'Database': 'string',
                        'Warehouse': 'string'
                    },
                    'SparkParameters': {
                        'Host': 'string',
                        'Port': 123
                    },
                    'SqlServerParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'TeradataParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'TwitterParameters': {
                        'Query': 'string',
                        'MaxRows': 123
                    }
                },
            ]
        },
        'CopySourceArn': 'string'
    },
    Permissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    VpcConnectionProperties={
        'VpcConnectionArn': 'string'
    },
    SslProperties={
        'DisableSsl': True|False
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The AWS account ID.

type DataSourceId

string

param DataSourceId

[REQUIRED]

An ID for the data source. This ID is unique per AWS Region for each AWS account.

type Name

string

param Name

[REQUIRED]

A display name for the data source.

type Type

string

param Type

[REQUIRED]

The type of the data source. Currently, the supported types for this operation are: ATHENA, AURORA, AURORA_POSTGRESQL, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA . Use ListDataSources to return a list of all data sources.

type DataSourceParameters

dict

param DataSourceParameters

The parameters that QuickSight uses to connect to your underlying source.

  • AmazonElasticsearchParameters (dict) --

    Amazon Elasticsearch Service parameters.

    • Domain (string) -- [REQUIRED]

      The Amazon Elasticsearch Service domain.

  • AthenaParameters (dict) --

    Amazon Athena parameters.

    • WorkGroup (string) --

      The workgroup that Amazon Athena uses.

  • AuroraParameters (dict) --

    Amazon Aurora MySQL parameters.

    • Host (string) -- [REQUIRED]

      Host.

    • Port (integer) -- [REQUIRED]

      Port.

    • Database (string) -- [REQUIRED]

      Database.

  • AuroraPostgreSqlParameters (dict) --

    Aurora PostgreSQL parameters.

    • Host (string) -- [REQUIRED]

      Host.

    • Port (integer) -- [REQUIRED]

      Port.

    • Database (string) -- [REQUIRED]

      Database.

  • AwsIotAnalyticsParameters (dict) --

    AWS IoT Analytics parameters.

    • DataSetName (string) -- [REQUIRED]

      Dataset name.

  • JiraParameters (dict) --

    Jira parameters.

    • SiteBaseUrl (string) -- [REQUIRED]

      The base URL of the Jira site.

  • MariaDbParameters (dict) --

    MariaDB parameters.

    • Host (string) -- [REQUIRED]

      Host.

    • Port (integer) -- [REQUIRED]

      Port.

    • Database (string) -- [REQUIRED]

      Database.

  • MySqlParameters (dict) --

    MySQL parameters.

    • Host (string) -- [REQUIRED]

      Host.

    • Port (integer) -- [REQUIRED]

      Port.

    • Database (string) -- [REQUIRED]

      Database.

  • OracleParameters (dict) --

    Oracle parameters.

    • Host (string) -- [REQUIRED]

      An Oracle host.

    • Port (integer) -- [REQUIRED]

      Port.

    • Database (string) -- [REQUIRED]

      Database.

  • PostgreSqlParameters (dict) --

    PostgreSQL parameters.

    • Host (string) -- [REQUIRED]

      Host.

    • Port (integer) -- [REQUIRED]

      Port.

    • Database (string) -- [REQUIRED]

      Database.

  • PrestoParameters (dict) --

    Presto parameters.

    • Host (string) -- [REQUIRED]

      Host.

    • Port (integer) -- [REQUIRED]

      Port.

    • Catalog (string) -- [REQUIRED]

      Catalog.

  • RdsParameters (dict) --

    Amazon RDS parameters.

    • InstanceId (string) -- [REQUIRED]

      Instance ID.

    • Database (string) -- [REQUIRED]

      Database.

  • RedshiftParameters (dict) --

    Amazon Redshift parameters.

    • Host (string) --

      Host. This field can be blank if ClusterId is provided.

    • Port (integer) --

      Port. This field can be blank if the ClusterId is provided.

    • Database (string) -- [REQUIRED]

      Database.

    • ClusterId (string) --

      Cluster ID. This field can be blank if the Host and Port are provided.

  • S3Parameters (dict) --

    S3 parameters.

    • ManifestFileLocation (dict) -- [REQUIRED]

      Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.

      • Bucket (string) -- [REQUIRED]

        Amazon S3 bucket.

      • Key (string) -- [REQUIRED]

        Amazon S3 key that identifies an object.

  • ServiceNowParameters (dict) --

    ServiceNow parameters.

    • SiteBaseUrl (string) -- [REQUIRED]

      URL of the base site.

  • SnowflakeParameters (dict) --

    Snowflake parameters.

    • Host (string) -- [REQUIRED]

      Host.

    • Database (string) -- [REQUIRED]

      Database.

    • Warehouse (string) -- [REQUIRED]

      Warehouse.

  • SparkParameters (dict) --

    Spark parameters.

    • Host (string) -- [REQUIRED]

      Host.

    • Port (integer) -- [REQUIRED]

      Port.

  • SqlServerParameters (dict) --

    SQL Server parameters.

    • Host (string) -- [REQUIRED]

      Host.

    • Port (integer) -- [REQUIRED]

      Port.

    • Database (string) -- [REQUIRED]

      Database.

  • TeradataParameters (dict) --

    Teradata parameters.

    • Host (string) -- [REQUIRED]

      Host.

    • Port (integer) -- [REQUIRED]

      Port.

    • Database (string) -- [REQUIRED]

      Database.

  • TwitterParameters (dict) --

    Twitter parameters.

    • Query (string) -- [REQUIRED]

      Twitter query string.

    • MaxRows (integer) -- [REQUIRED]

      Maximum number of rows to query Twitter.

type Credentials

dict

param Credentials

The credentials QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

  • CredentialPair (dict) --

    Credential pair. For more information, see CredentialPair .

    • Username (string) -- [REQUIRED]

      User name.

    • Password (string) -- [REQUIRED]

      Password.

    • AlternateDataSourceParameters (list) --

      A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.

      • (dict) --

        The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

        • AmazonElasticsearchParameters (dict) --

          Amazon Elasticsearch Service parameters.

          • Domain (string) -- [REQUIRED]

            The Amazon Elasticsearch Service domain.

        • AthenaParameters (dict) --

          Amazon Athena parameters.

          • WorkGroup (string) --

            The workgroup that Amazon Athena uses.

        • AuroraParameters (dict) --

          Amazon Aurora MySQL parameters.

          • Host (string) -- [REQUIRED]

            Host.

          • Port (integer) -- [REQUIRED]

            Port.

          • Database (string) -- [REQUIRED]

            Database.

        • AuroraPostgreSqlParameters (dict) --

          Aurora PostgreSQL parameters.

          • Host (string) -- [REQUIRED]

            Host.

          • Port (integer) -- [REQUIRED]

            Port.

          • Database (string) -- [REQUIRED]

            Database.

        • AwsIotAnalyticsParameters (dict) --

          AWS IoT Analytics parameters.

          • DataSetName (string) -- [REQUIRED]

            Dataset name.

        • JiraParameters (dict) --

          Jira parameters.

          • SiteBaseUrl (string) -- [REQUIRED]

            The base URL of the Jira site.

        • MariaDbParameters (dict) --

          MariaDB parameters.

          • Host (string) -- [REQUIRED]

            Host.

          • Port (integer) -- [REQUIRED]

            Port.

          • Database (string) -- [REQUIRED]

            Database.

        • MySqlParameters (dict) --

          MySQL parameters.

          • Host (string) -- [REQUIRED]

            Host.

          • Port (integer) -- [REQUIRED]

            Port.

          • Database (string) -- [REQUIRED]

            Database.

        • OracleParameters (dict) --

          Oracle parameters.

          • Host (string) -- [REQUIRED]

            An Oracle host.

          • Port (integer) -- [REQUIRED]

            Port.

          • Database (string) -- [REQUIRED]

            Database.

        • PostgreSqlParameters (dict) --

          PostgreSQL parameters.

          • Host (string) -- [REQUIRED]

            Host.

          • Port (integer) -- [REQUIRED]

            Port.

          • Database (string) -- [REQUIRED]

            Database.

        • PrestoParameters (dict) --

          Presto parameters.

          • Host (string) -- [REQUIRED]

            Host.

          • Port (integer) -- [REQUIRED]

            Port.

          • Catalog (string) -- [REQUIRED]

            Catalog.

        • RdsParameters (dict) --

          Amazon RDS parameters.

          • InstanceId (string) -- [REQUIRED]

            Instance ID.

          • Database (string) -- [REQUIRED]

            Database.

        • RedshiftParameters (dict) --

          Amazon Redshift parameters.

          • Host (string) --

            Host. This field can be blank if ClusterId is provided.

          • Port (integer) --

            Port. This field can be blank if the ClusterId is provided.

          • Database (string) -- [REQUIRED]

            Database.

          • ClusterId (string) --

            Cluster ID. This field can be blank if the Host and Port are provided.

        • S3Parameters (dict) --

          S3 parameters.

          • ManifestFileLocation (dict) -- [REQUIRED]

            Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.

            • Bucket (string) -- [REQUIRED]

              Amazon S3 bucket.

            • Key (string) -- [REQUIRED]

              Amazon S3 key that identifies an object.

        • ServiceNowParameters (dict) --

          ServiceNow parameters.

          • SiteBaseUrl (string) -- [REQUIRED]

            URL of the base site.

        • SnowflakeParameters (dict) --

          Snowflake parameters.

          • Host (string) -- [REQUIRED]

            Host.

          • Database (string) -- [REQUIRED]

            Database.

          • Warehouse (string) -- [REQUIRED]

            Warehouse.

        • SparkParameters (dict) --

          Spark parameters.

          • Host (string) -- [REQUIRED]

            Host.

          • Port (integer) -- [REQUIRED]

            Port.

        • SqlServerParameters (dict) --

          SQL Server parameters.

          • Host (string) -- [REQUIRED]

            Host.

          • Port (integer) -- [REQUIRED]

            Port.

          • Database (string) -- [REQUIRED]

            Database.

        • TeradataParameters (dict) --

          Teradata parameters.

          • Host (string) -- [REQUIRED]

            Host.

          • Port (integer) -- [REQUIRED]

            Port.

          • Database (string) -- [REQUIRED]

            Database.

        • TwitterParameters (dict) --

          Twitter parameters.

          • Query (string) -- [REQUIRED]

            Twitter query string.

          • MaxRows (integer) -- [REQUIRED]

            Maximum number of rows to query Twitter.

  • CopySourceArn (string) --

    The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.

type Permissions

list

param Permissions

A list of resource permissions on the data source.

  • (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 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 IAM action to grant or revoke permissions on.

      • (string) --

type VpcConnectionProperties

dict

param VpcConnectionProperties

Use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.

  • VpcConnectionArn (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) for the VPC connection.

type SslProperties

dict

param SslProperties

Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.

  • DisableSsl (boolean) --

    A Boolean option to control whether SSL should be disabled.

type Tags

list

param Tags

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

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

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'DataSourceId': 'string',
    'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) --

    • Arn (string) --

      The Amazon Resource Name (ARN) of the data source.

    • DataSourceId (string) --

      The ID of the data source. This ID is unique per AWS Region for each AWS account.

    • CreationStatus (string) --

      The status of creating the data source.

    • RequestId (string) --

      The AWS request ID for this operation.

    • Status (integer) --

      The HTTP status of the request.

DescribeDataSet (updated) Link ¶
Changes (response)
{'DataSet': {'ColumnLevelPermissionRules': [{'ColumnNames': ['string'],
                                             'Principals': ['string']}]}}

Describes a dataset.

See also: AWS API Documentation

Request Syntax

client.describe_data_set(
    AwsAccountId='string',
    DataSetId='string'
)
type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The AWS account ID.

type DataSetId

string

param DataSetId

[REQUIRED]

The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.

rtype

dict

returns

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',
                                    'ColumnDescription': {
                                        'Text': 'string'
                                    }
                                },
                            ]
                        }
                    },
                ],
                'Source': {
                    'JoinInstruction': {
                        'LeftOperand': 'string',
                        'RightOperand': 'string',
                        'Type': 'INNER'|'OUTER'|'LEFT'|'RIGHT',
                        'OnClause': 'string'
                    },
                    'PhysicalTableId': 'string'
                }
            }
        },
        'OutputColumns': [
            {
                'Name': 'string',
                'Description': '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'
        },
        'ColumnLevelPermissionRules': [
            {
                'Principals': [
                    'string',
                ],
                'ColumnNames': [
                    'string',
                ]
            },
        ]
    },
    '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. .

                    Note

                    This is not tags for the AWS tagging feature. .

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

                      • ColumnDescription (dict) --

                        A description for a column.

                        • Text (string) --

                          The text of a description 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.

          • Description (string) --

            A description for a column.

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

      • ColumnLevelPermissionRules (list) --

        A set of one or more definitions of a `` ColumnLevelPermissionRule `` .

        • (dict) --

          A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.

          • Principals (list) --

            An array of Amazon Resource Names (ARNs) for QuickSight users or groups.

            • (string) --

          • ColumnNames (list) --

            An array of column names.

            • (string) --

    • RequestId (string) --

      The AWS request ID for this operation.

    • Status (integer) --

      The HTTP status of the request.

DescribeDataSource (updated) Link ¶
Changes (response)
{'DataSource': {'AlternateDataSourceParameters': {'OracleParameters': {'Database': 'string',
                                                                       'Host': 'string',
                                                                       'Port': 'integer'}},
                'DataSourceParameters': {'OracleParameters': {'Database': 'string',
                                                              'Host': 'string',
                                                              'Port': 'integer'}},
                'Type': {'ORACLE'}}}

Describes a data source.

See also: AWS API Documentation

Request Syntax

client.describe_data_source(
    AwsAccountId='string',
    DataSourceId='string'
)
type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The AWS account ID.

type DataSourceId

string

param DataSourceId

[REQUIRED]

The ID of the data source. This ID is unique per AWS Region for each AWS account.

rtype

dict

returns

Response Syntax

{
    'DataSource': {
        'Arn': 'string',
        'DataSourceId': 'string',
        'Name': 'string',
        'Type': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM',
        'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
        'CreatedTime': datetime(2015, 1, 1),
        'LastUpdatedTime': datetime(2015, 1, 1),
        'DataSourceParameters': {
            'AmazonElasticsearchParameters': {
                'Domain': 'string'
            },
            'AthenaParameters': {
                'WorkGroup': 'string'
            },
            'AuroraParameters': {
                'Host': 'string',
                'Port': 123,
                'Database': 'string'
            },
            'AuroraPostgreSqlParameters': {
                'Host': 'string',
                'Port': 123,
                'Database': 'string'
            },
            'AwsIotAnalyticsParameters': {
                'DataSetName': 'string'
            },
            'JiraParameters': {
                'SiteBaseUrl': 'string'
            },
            'MariaDbParameters': {
                'Host': 'string',
                'Port': 123,
                'Database': 'string'
            },
            'MySqlParameters': {
                'Host': 'string',
                'Port': 123,
                'Database': 'string'
            },
            'OracleParameters': {
                'Host': 'string',
                'Port': 123,
                'Database': 'string'
            },
            'PostgreSqlParameters': {
                'Host': 'string',
                'Port': 123,
                'Database': 'string'
            },
            'PrestoParameters': {
                'Host': 'string',
                'Port': 123,
                'Catalog': 'string'
            },
            'RdsParameters': {
                'InstanceId': 'string',
                'Database': 'string'
            },
            'RedshiftParameters': {
                'Host': 'string',
                'Port': 123,
                'Database': 'string',
                'ClusterId': 'string'
            },
            'S3Parameters': {
                'ManifestFileLocation': {
                    'Bucket': 'string',
                    'Key': 'string'
                }
            },
            'ServiceNowParameters': {
                'SiteBaseUrl': 'string'
            },
            'SnowflakeParameters': {
                'Host': 'string',
                'Database': 'string',
                'Warehouse': 'string'
            },
            'SparkParameters': {
                'Host': 'string',
                'Port': 123
            },
            'SqlServerParameters': {
                'Host': 'string',
                'Port': 123,
                'Database': 'string'
            },
            'TeradataParameters': {
                'Host': 'string',
                'Port': 123,
                'Database': 'string'
            },
            'TwitterParameters': {
                'Query': 'string',
                'MaxRows': 123
            }
        },
        'AlternateDataSourceParameters': [
            {
                'AmazonElasticsearchParameters': {
                    'Domain': 'string'
                },
                'AthenaParameters': {
                    'WorkGroup': 'string'
                },
                'AuroraParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'AuroraPostgreSqlParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'AwsIotAnalyticsParameters': {
                    'DataSetName': 'string'
                },
                'JiraParameters': {
                    'SiteBaseUrl': 'string'
                },
                'MariaDbParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'MySqlParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'OracleParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'PostgreSqlParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'PrestoParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Catalog': 'string'
                },
                'RdsParameters': {
                    'InstanceId': 'string',
                    'Database': 'string'
                },
                'RedshiftParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string',
                    'ClusterId': 'string'
                },
                'S3Parameters': {
                    'ManifestFileLocation': {
                        'Bucket': 'string',
                        'Key': 'string'
                    }
                },
                'ServiceNowParameters': {
                    'SiteBaseUrl': 'string'
                },
                'SnowflakeParameters': {
                    'Host': 'string',
                    'Database': 'string',
                    'Warehouse': 'string'
                },
                'SparkParameters': {
                    'Host': 'string',
                    'Port': 123
                },
                'SqlServerParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'TeradataParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'TwitterParameters': {
                    'Query': 'string',
                    'MaxRows': 123
                }
            },
        ],
        'VpcConnectionProperties': {
            'VpcConnectionArn': 'string'
        },
        'SslProperties': {
            'DisableSsl': True|False
        },
        'ErrorInfo': {
            'Type': 'ACCESS_DENIED'|'COPY_SOURCE_NOT_FOUND'|'TIMEOUT'|'ENGINE_VERSION_NOT_SUPPORTED'|'UNKNOWN_HOST'|'GENERIC_SQL_FAILURE'|'CONFLICT'|'UNKNOWN',
            'Message': 'string'
        }
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) --

    • DataSource (dict) --

      The information on the data source.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the data source.

      • DataSourceId (string) --

        The ID of the data source. This ID is unique per AWS Region for each AWS account.

      • Name (string) --

        A display name for the data source.

      • Type (string) --

        The type of the data source. This type indicates which database engine the data source connects to.

      • Status (string) --

        The HTTP status of the request.

      • CreatedTime (datetime) --

        The time that this data source was created.

      • LastUpdatedTime (datetime) --

        The last time that this data source was updated.

      • DataSourceParameters (dict) --

        The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

        • AmazonElasticsearchParameters (dict) --

          Amazon Elasticsearch Service parameters.

          • Domain (string) --

            The Amazon Elasticsearch Service domain.

        • AthenaParameters (dict) --

          Amazon Athena parameters.

          • WorkGroup (string) --

            The workgroup that Amazon Athena uses.

        • AuroraParameters (dict) --

          Amazon Aurora MySQL parameters.

          • Host (string) --

            Host.

          • Port (integer) --

            Port.

          • Database (string) --

            Database.

        • AuroraPostgreSqlParameters (dict) --

          Aurora PostgreSQL parameters.

          • Host (string) --

            Host.

          • Port (integer) --

            Port.

          • Database (string) --

            Database.

        • AwsIotAnalyticsParameters (dict) --

          AWS IoT Analytics parameters.

          • DataSetName (string) --

            Dataset name.

        • JiraParameters (dict) --

          Jira parameters.

          • SiteBaseUrl (string) --

            The base URL of the Jira site.

        • MariaDbParameters (dict) --

          MariaDB parameters.

          • Host (string) --

            Host.

          • Port (integer) --

            Port.

          • Database (string) --

            Database.

        • MySqlParameters (dict) --

          MySQL parameters.

          • Host (string) --

            Host.

          • Port (integer) --

            Port.

          • Database (string) --

            Database.

        • OracleParameters (dict) --

          Oracle parameters.

          • Host (string) --

            An Oracle host.

          • Port (integer) --

            Port.

          • Database (string) --

            Database.

        • PostgreSqlParameters (dict) --

          PostgreSQL parameters.

          • Host (string) --

            Host.

          • Port (integer) --

            Port.

          • Database (string) --

            Database.

        • PrestoParameters (dict) --

          Presto parameters.

          • Host (string) --

            Host.

          • Port (integer) --

            Port.

          • Catalog (string) --

            Catalog.

        • RdsParameters (dict) --

          Amazon RDS parameters.

          • InstanceId (string) --

            Instance ID.

          • Database (string) --

            Database.

        • RedshiftParameters (dict) --

          Amazon Redshift parameters.

          • Host (string) --

            Host. This field can be blank if ClusterId is provided.

          • Port (integer) --

            Port. This field can be blank if the ClusterId is provided.

          • Database (string) --

            Database.

          • ClusterId (string) --

            Cluster ID. This field can be blank if the Host and Port are provided.

        • S3Parameters (dict) --

          S3 parameters.

          • ManifestFileLocation (dict) --

            Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.

            • Bucket (string) --

              Amazon S3 bucket.

            • Key (string) --

              Amazon S3 key that identifies an object.

        • ServiceNowParameters (dict) --

          ServiceNow parameters.

          • SiteBaseUrl (string) --

            URL of the base site.

        • SnowflakeParameters (dict) --

          Snowflake parameters.

          • Host (string) --

            Host.

          • Database (string) --

            Database.

          • Warehouse (string) --

            Warehouse.

        • SparkParameters (dict) --

          Spark parameters.

          • Host (string) --

            Host.

          • Port (integer) --

            Port.

        • SqlServerParameters (dict) --

          SQL Server parameters.

          • Host (string) --

            Host.

          • Port (integer) --

            Port.

          • Database (string) --

            Database.

        • TeradataParameters (dict) --

          Teradata parameters.

          • Host (string) --

            Host.

          • Port (integer) --

            Port.

          • Database (string) --

            Database.

        • TwitterParameters (dict) --

          Twitter parameters.

          • Query (string) --

            Twitter query string.

          • MaxRows (integer) --

            Maximum number of rows to query Twitter.

      • AlternateDataSourceParameters (list) --

        A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.

        • (dict) --

          The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

          • AmazonElasticsearchParameters (dict) --

            Amazon Elasticsearch Service parameters.

            • Domain (string) --

              The Amazon Elasticsearch Service domain.

          • AthenaParameters (dict) --

            Amazon Athena parameters.

            • WorkGroup (string) --

              The workgroup that Amazon Athena uses.

          • AuroraParameters (dict) --

            Amazon Aurora MySQL parameters.

            • Host (string) --

              Host.

            • Port (integer) --

              Port.

            • Database (string) --

              Database.

          • AuroraPostgreSqlParameters (dict) --

            Aurora PostgreSQL parameters.

            • Host (string) --

              Host.

            • Port (integer) --

              Port.

            • Database (string) --

              Database.

          • AwsIotAnalyticsParameters (dict) --

            AWS IoT Analytics parameters.

            • DataSetName (string) --

              Dataset name.

          • JiraParameters (dict) --

            Jira parameters.

            • SiteBaseUrl (string) --

              The base URL of the Jira site.

          • MariaDbParameters (dict) --

            MariaDB parameters.

            • Host (string) --

              Host.

            • Port (integer) --

              Port.

            • Database (string) --

              Database.

          • MySqlParameters (dict) --

            MySQL parameters.

            • Host (string) --

              Host.

            • Port (integer) --

              Port.

            • Database (string) --

              Database.

          • OracleParameters (dict) --

            Oracle parameters.

            • Host (string) --

              An Oracle host.

            • Port (integer) --

              Port.

            • Database (string) --

              Database.

          • PostgreSqlParameters (dict) --

            PostgreSQL parameters.

            • Host (string) --

              Host.

            • Port (integer) --

              Port.

            • Database (string) --

              Database.

          • PrestoParameters (dict) --

            Presto parameters.

            • Host (string) --

              Host.

            • Port (integer) --

              Port.

            • Catalog (string) --

              Catalog.

          • RdsParameters (dict) --

            Amazon RDS parameters.

            • InstanceId (string) --

              Instance ID.

            • Database (string) --

              Database.

          • RedshiftParameters (dict) --

            Amazon Redshift parameters.

            • Host (string) --

              Host. This field can be blank if ClusterId is provided.

            • Port (integer) --

              Port. This field can be blank if the ClusterId is provided.

            • Database (string) --

              Database.

            • ClusterId (string) --

              Cluster ID. This field can be blank if the Host and Port are provided.

          • S3Parameters (dict) --

            S3 parameters.

            • ManifestFileLocation (dict) --

              Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.

              • Bucket (string) --

                Amazon S3 bucket.

              • Key (string) --

                Amazon S3 key that identifies an object.

          • ServiceNowParameters (dict) --

            ServiceNow parameters.

            • SiteBaseUrl (string) --

              URL of the base site.

          • SnowflakeParameters (dict) --

            Snowflake parameters.

            • Host (string) --

              Host.

            • Database (string) --

              Database.

            • Warehouse (string) --

              Warehouse.

          • SparkParameters (dict) --

            Spark parameters.

            • Host (string) --

              Host.

            • Port (integer) --

              Port.

          • SqlServerParameters (dict) --

            SQL Server parameters.

            • Host (string) --

              Host.

            • Port (integer) --

              Port.

            • Database (string) --

              Database.

          • TeradataParameters (dict) --

            Teradata parameters.

            • Host (string) --

              Host.

            • Port (integer) --

              Port.

            • Database (string) --

              Database.

          • TwitterParameters (dict) --

            Twitter parameters.

            • Query (string) --

              Twitter query string.

            • MaxRows (integer) --

              Maximum number of rows to query Twitter.

      • VpcConnectionProperties (dict) --

        The VPC connection information. You need to use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.

        • VpcConnectionArn (string) --

          The Amazon Resource Name (ARN) for the VPC connection.

      • SslProperties (dict) --

        Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.

        • DisableSsl (boolean) --

          A Boolean option to control whether SSL should be disabled.

      • ErrorInfo (dict) --

        Error information from the last update or the creation of the data source.

        • Type (string) --

          Error type.

        • Message (string) --

          Error message.

    • RequestId (string) --

      The AWS request ID for this operation.

    • Status (integer) --

      The HTTP status of the request.

ListDataSets (updated) Link ¶
Changes (response)
{'DataSetSummaries': {'ColumnLevelPermissionRulesApplied': 'boolean'}}

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

string

param AwsAccountId

[REQUIRED]

The AWS account ID.

type NextToken

string

param NextToken

The token for the next set of results, or null if there are no more results.

type MaxResults

integer

param MaxResults

The maximum number of results to be returned per request.

rtype

dict

returns

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'
            },
            'ColumnLevelPermissionRulesApplied': True|False
        },
    ],
    '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.

        • ColumnLevelPermissionRulesApplied (boolean) --

          Indicates if the dataset has column level permission configured.

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

ListDataSources (updated) Link ¶
Changes (response)
{'DataSources': {'AlternateDataSourceParameters': {'OracleParameters': {'Database': 'string',
                                                                        'Host': 'string',
                                                                        'Port': 'integer'}},
                 'DataSourceParameters': {'OracleParameters': {'Database': 'string',
                                                               'Host': 'string',
                                                               'Port': 'integer'}},
                 'Type': {'ORACLE'}}}

Lists data sources in current AWS Region that belong to this AWS account.

See also: AWS API Documentation

Request Syntax

client.list_data_sources(
    AwsAccountId='string',
    NextToken='string',
    MaxResults=123
)
type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The AWS account ID.

type NextToken

string

param NextToken

The token for the next set of results, or null if there are no more results.

type MaxResults

integer

param MaxResults

The maximum number of results to be returned per request.

rtype

dict

returns

Response Syntax

{
    'DataSources': [
        {
            'Arn': 'string',
            'DataSourceId': 'string',
            'Name': 'string',
            'Type': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM',
            'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1),
            'DataSourceParameters': {
                'AmazonElasticsearchParameters': {
                    'Domain': 'string'
                },
                'AthenaParameters': {
                    'WorkGroup': 'string'
                },
                'AuroraParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'AuroraPostgreSqlParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'AwsIotAnalyticsParameters': {
                    'DataSetName': 'string'
                },
                'JiraParameters': {
                    'SiteBaseUrl': 'string'
                },
                'MariaDbParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'MySqlParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'OracleParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'PostgreSqlParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'PrestoParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Catalog': 'string'
                },
                'RdsParameters': {
                    'InstanceId': 'string',
                    'Database': 'string'
                },
                'RedshiftParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string',
                    'ClusterId': 'string'
                },
                'S3Parameters': {
                    'ManifestFileLocation': {
                        'Bucket': 'string',
                        'Key': 'string'
                    }
                },
                'ServiceNowParameters': {
                    'SiteBaseUrl': 'string'
                },
                'SnowflakeParameters': {
                    'Host': 'string',
                    'Database': 'string',
                    'Warehouse': 'string'
                },
                'SparkParameters': {
                    'Host': 'string',
                    'Port': 123
                },
                'SqlServerParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'TeradataParameters': {
                    'Host': 'string',
                    'Port': 123,
                    'Database': 'string'
                },
                'TwitterParameters': {
                    'Query': 'string',
                    'MaxRows': 123
                }
            },
            'AlternateDataSourceParameters': [
                {
                    'AmazonElasticsearchParameters': {
                        'Domain': 'string'
                    },
                    'AthenaParameters': {
                        'WorkGroup': 'string'
                    },
                    'AuroraParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'AuroraPostgreSqlParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'AwsIotAnalyticsParameters': {
                        'DataSetName': 'string'
                    },
                    'JiraParameters': {
                        'SiteBaseUrl': 'string'
                    },
                    'MariaDbParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'MySqlParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'OracleParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'PostgreSqlParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'PrestoParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Catalog': 'string'
                    },
                    'RdsParameters': {
                        'InstanceId': 'string',
                        'Database': 'string'
                    },
                    'RedshiftParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string',
                        'ClusterId': 'string'
                    },
                    'S3Parameters': {
                        'ManifestFileLocation': {
                            'Bucket': 'string',
                            'Key': 'string'
                        }
                    },
                    'ServiceNowParameters': {
                        'SiteBaseUrl': 'string'
                    },
                    'SnowflakeParameters': {
                        'Host': 'string',
                        'Database': 'string',
                        'Warehouse': 'string'
                    },
                    'SparkParameters': {
                        'Host': 'string',
                        'Port': 123
                    },
                    'SqlServerParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'TeradataParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'TwitterParameters': {
                        'Query': 'string',
                        'MaxRows': 123
                    }
                },
            ],
            'VpcConnectionProperties': {
                'VpcConnectionArn': 'string'
            },
            'SslProperties': {
                'DisableSsl': True|False
            },
            'ErrorInfo': {
                'Type': 'ACCESS_DENIED'|'COPY_SOURCE_NOT_FOUND'|'TIMEOUT'|'ENGINE_VERSION_NOT_SUPPORTED'|'UNKNOWN_HOST'|'GENERIC_SQL_FAILURE'|'CONFLICT'|'UNKNOWN',
                'Message': 'string'
            }
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) --

    • DataSources (list) --

      A list of data sources.

      • (dict) --

        The structure of a data source.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the data source.

        • DataSourceId (string) --

          The ID of the data source. This ID is unique per AWS Region for each AWS account.

        • Name (string) --

          A display name for the data source.

        • Type (string) --

          The type of the data source. This type indicates which database engine the data source connects to.

        • Status (string) --

          The HTTP status of the request.

        • CreatedTime (datetime) --

          The time that this data source was created.

        • LastUpdatedTime (datetime) --

          The last time that this data source was updated.

        • DataSourceParameters (dict) --

          The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

          • AmazonElasticsearchParameters (dict) --

            Amazon Elasticsearch Service parameters.

            • Domain (string) --

              The Amazon Elasticsearch Service domain.

          • AthenaParameters (dict) --

            Amazon Athena parameters.

            • WorkGroup (string) --

              The workgroup that Amazon Athena uses.

          • AuroraParameters (dict) --

            Amazon Aurora MySQL parameters.

            • Host (string) --

              Host.

            • Port (integer) --

              Port.

            • Database (string) --

              Database.

          • AuroraPostgreSqlParameters (dict) --

            Aurora PostgreSQL parameters.

            • Host (string) --

              Host.

            • Port (integer) --

              Port.

            • Database (string) --

              Database.

          • AwsIotAnalyticsParameters (dict) --

            AWS IoT Analytics parameters.

            • DataSetName (string) --

              Dataset name.

          • JiraParameters (dict) --

            Jira parameters.

            • SiteBaseUrl (string) --

              The base URL of the Jira site.

          • MariaDbParameters (dict) --

            MariaDB parameters.

            • Host (string) --

              Host.

            • Port (integer) --

              Port.

            • Database (string) --

              Database.

          • MySqlParameters (dict) --

            MySQL parameters.

            • Host (string) --

              Host.

            • Port (integer) --

              Port.

            • Database (string) --

              Database.

          • OracleParameters (dict) --

            Oracle parameters.

            • Host (string) --

              An Oracle host.

            • Port (integer) --

              Port.

            • Database (string) --

              Database.

          • PostgreSqlParameters (dict) --

            PostgreSQL parameters.

            • Host (string) --

              Host.

            • Port (integer) --

              Port.

            • Database (string) --

              Database.

          • PrestoParameters (dict) --

            Presto parameters.

            • Host (string) --

              Host.

            • Port (integer) --

              Port.

            • Catalog (string) --

              Catalog.

          • RdsParameters (dict) --

            Amazon RDS parameters.

            • InstanceId (string) --

              Instance ID.

            • Database (string) --

              Database.

          • RedshiftParameters (dict) --

            Amazon Redshift parameters.

            • Host (string) --

              Host. This field can be blank if ClusterId is provided.

            • Port (integer) --

              Port. This field can be blank if the ClusterId is provided.

            • Database (string) --

              Database.

            • ClusterId (string) --

              Cluster ID. This field can be blank if the Host and Port are provided.

          • S3Parameters (dict) --

            S3 parameters.

            • ManifestFileLocation (dict) --

              Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.

              • Bucket (string) --

                Amazon S3 bucket.

              • Key (string) --

                Amazon S3 key that identifies an object.

          • ServiceNowParameters (dict) --

            ServiceNow parameters.

            • SiteBaseUrl (string) --

              URL of the base site.

          • SnowflakeParameters (dict) --

            Snowflake parameters.

            • Host (string) --

              Host.

            • Database (string) --

              Database.

            • Warehouse (string) --

              Warehouse.

          • SparkParameters (dict) --

            Spark parameters.

            • Host (string) --

              Host.

            • Port (integer) --

              Port.

          • SqlServerParameters (dict) --

            SQL Server parameters.

            • Host (string) --

              Host.

            • Port (integer) --

              Port.

            • Database (string) --

              Database.

          • TeradataParameters (dict) --

            Teradata parameters.

            • Host (string) --

              Host.

            • Port (integer) --

              Port.

            • Database (string) --

              Database.

          • TwitterParameters (dict) --

            Twitter parameters.

            • Query (string) --

              Twitter query string.

            • MaxRows (integer) --

              Maximum number of rows to query Twitter.

        • AlternateDataSourceParameters (list) --

          A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.

          • (dict) --

            The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

            • AmazonElasticsearchParameters (dict) --

              Amazon Elasticsearch Service parameters.

              • Domain (string) --

                The Amazon Elasticsearch Service domain.

            • AthenaParameters (dict) --

              Amazon Athena parameters.

              • WorkGroup (string) --

                The workgroup that Amazon Athena uses.

            • AuroraParameters (dict) --

              Amazon Aurora MySQL parameters.

              • Host (string) --

                Host.

              • Port (integer) --

                Port.

              • Database (string) --

                Database.

            • AuroraPostgreSqlParameters (dict) --

              Aurora PostgreSQL parameters.

              • Host (string) --

                Host.

              • Port (integer) --

                Port.

              • Database (string) --

                Database.

            • AwsIotAnalyticsParameters (dict) --

              AWS IoT Analytics parameters.

              • DataSetName (string) --

                Dataset name.

            • JiraParameters (dict) --

              Jira parameters.

              • SiteBaseUrl (string) --

                The base URL of the Jira site.

            • MariaDbParameters (dict) --

              MariaDB parameters.

              • Host (string) --

                Host.

              • Port (integer) --

                Port.

              • Database (string) --

                Database.

            • MySqlParameters (dict) --

              MySQL parameters.

              • Host (string) --

                Host.

              • Port (integer) --

                Port.

              • Database (string) --

                Database.

            • OracleParameters (dict) --

              Oracle parameters.

              • Host (string) --

                An Oracle host.

              • Port (integer) --

                Port.

              • Database (string) --

                Database.

            • PostgreSqlParameters (dict) --

              PostgreSQL parameters.

              • Host (string) --

                Host.

              • Port (integer) --

                Port.

              • Database (string) --

                Database.

            • PrestoParameters (dict) --

              Presto parameters.

              • Host (string) --

                Host.

              • Port (integer) --

                Port.

              • Catalog (string) --

                Catalog.

            • RdsParameters (dict) --

              Amazon RDS parameters.

              • InstanceId (string) --

                Instance ID.

              • Database (string) --

                Database.

            • RedshiftParameters (dict) --

              Amazon Redshift parameters.

              • Host (string) --

                Host. This field can be blank if ClusterId is provided.

              • Port (integer) --

                Port. This field can be blank if the ClusterId is provided.

              • Database (string) --

                Database.

              • ClusterId (string) --

                Cluster ID. This field can be blank if the Host and Port are provided.

            • S3Parameters (dict) --

              S3 parameters.

              • ManifestFileLocation (dict) --

                Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.

                • Bucket (string) --

                  Amazon S3 bucket.

                • Key (string) --

                  Amazon S3 key that identifies an object.

            • ServiceNowParameters (dict) --

              ServiceNow parameters.

              • SiteBaseUrl (string) --

                URL of the base site.

            • SnowflakeParameters (dict) --

              Snowflake parameters.

              • Host (string) --

                Host.

              • Database (string) --

                Database.

              • Warehouse (string) --

                Warehouse.

            • SparkParameters (dict) --

              Spark parameters.

              • Host (string) --

                Host.

              • Port (integer) --

                Port.

            • SqlServerParameters (dict) --

              SQL Server parameters.

              • Host (string) --

                Host.

              • Port (integer) --

                Port.

              • Database (string) --

                Database.

            • TeradataParameters (dict) --

              Teradata parameters.

              • Host (string) --

                Host.

              • Port (integer) --

                Port.

              • Database (string) --

                Database.

            • TwitterParameters (dict) --

              Twitter parameters.

              • Query (string) --

                Twitter query string.

              • MaxRows (integer) --

                Maximum number of rows to query Twitter.

        • VpcConnectionProperties (dict) --

          The VPC connection information. You need to use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.

          • VpcConnectionArn (string) --

            The Amazon Resource Name (ARN) for the VPC connection.

        • SslProperties (dict) --

          Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.

          • DisableSsl (boolean) --

            A Boolean option to control whether SSL should be disabled.

        • ErrorInfo (dict) --

          Error information from the last update or the creation of the data source.

          • Type (string) --

            Error type.

          • Message (string) --

            Error message.

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

UpdateDataSet (updated) Link ¶
Changes (request)
{'ColumnLevelPermissionRules': [{'ColumnNames': ['string'],
                                 'Principals': ['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',
                                'ColumnDescription': {
                                    'Text': 'string'
                                }
                            },
                        ]
                    }
                },
            ],
            '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'
    },
    ColumnLevelPermissionRules=[
        {
            'Principals': [
                'string',
            ],
            'ColumnNames': [
                'string',
            ]
        },
    ]
)
type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The AWS account ID.

type DataSetId

string

param DataSetId

[REQUIRED]

The ID for the dataset that you want to update. This ID is unique per AWS Region for each AWS account.

type Name

string

param Name

[REQUIRED]

The display name for the dataset.

type PhysicalTableMap

dict

param PhysicalTableMap

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

type LogicalTableMap

dict

param LogicalTableMap

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

              Note

              This is not tags for the AWS tagging feature. .

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

                • ColumnDescription (dict) --

                  A description for a column.

                  • Text (string) --

                    The text of a description 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.

type ImportMode

string

param ImportMode

[REQUIRED]

Indicates whether you want to import the data into SPICE.

type ColumnGroups

list

param ColumnGroups

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

type RowLevelPermissionDataSet

dict

param RowLevelPermissionDataSet

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.

type ColumnLevelPermissionRules

list

param ColumnLevelPermissionRules

A set of one or more definitions of a `` ColumnLevelPermissionRule `` .

  • (dict) --

    A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.

    • Principals (list) --

      An array of Amazon Resource Names (ARNs) for QuickSight users or groups.

      • (string) --

    • ColumnNames (list) --

      An array of column names.

      • (string) --

rtype

dict

returns

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.

UpdateDataSource (updated) Link ¶
Changes (request)
{'Credentials': {'CredentialPair': {'AlternateDataSourceParameters': {'OracleParameters': {'Database': 'string',
                                                                                           'Host': 'string',
                                                                                           'Port': 'integer'}}}},
 'DataSourceParameters': {'OracleParameters': {'Database': 'string',
                                               'Host': 'string',
                                               'Port': 'integer'}}}

Updates a data source.

See also: AWS API Documentation

Request Syntax

client.update_data_source(
    AwsAccountId='string',
    DataSourceId='string',
    Name='string',
    DataSourceParameters={
        'AmazonElasticsearchParameters': {
            'Domain': 'string'
        },
        'AthenaParameters': {
            'WorkGroup': 'string'
        },
        'AuroraParameters': {
            'Host': 'string',
            'Port': 123,
            'Database': 'string'
        },
        'AuroraPostgreSqlParameters': {
            'Host': 'string',
            'Port': 123,
            'Database': 'string'
        },
        'AwsIotAnalyticsParameters': {
            'DataSetName': 'string'
        },
        'JiraParameters': {
            'SiteBaseUrl': 'string'
        },
        'MariaDbParameters': {
            'Host': 'string',
            'Port': 123,
            'Database': 'string'
        },
        'MySqlParameters': {
            'Host': 'string',
            'Port': 123,
            'Database': 'string'
        },
        'OracleParameters': {
            'Host': 'string',
            'Port': 123,
            'Database': 'string'
        },
        'PostgreSqlParameters': {
            'Host': 'string',
            'Port': 123,
            'Database': 'string'
        },
        'PrestoParameters': {
            'Host': 'string',
            'Port': 123,
            'Catalog': 'string'
        },
        'RdsParameters': {
            'InstanceId': 'string',
            'Database': 'string'
        },
        'RedshiftParameters': {
            'Host': 'string',
            'Port': 123,
            'Database': 'string',
            'ClusterId': 'string'
        },
        'S3Parameters': {
            'ManifestFileLocation': {
                'Bucket': 'string',
                'Key': 'string'
            }
        },
        'ServiceNowParameters': {
            'SiteBaseUrl': 'string'
        },
        'SnowflakeParameters': {
            'Host': 'string',
            'Database': 'string',
            'Warehouse': 'string'
        },
        'SparkParameters': {
            'Host': 'string',
            'Port': 123
        },
        'SqlServerParameters': {
            'Host': 'string',
            'Port': 123,
            'Database': 'string'
        },
        'TeradataParameters': {
            'Host': 'string',
            'Port': 123,
            'Database': 'string'
        },
        'TwitterParameters': {
            'Query': 'string',
            'MaxRows': 123
        }
    },
    Credentials={
        'CredentialPair': {
            'Username': 'string',
            'Password': 'string',
            'AlternateDataSourceParameters': [
                {
                    'AmazonElasticsearchParameters': {
                        'Domain': 'string'
                    },
                    'AthenaParameters': {
                        'WorkGroup': 'string'
                    },
                    'AuroraParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'AuroraPostgreSqlParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'AwsIotAnalyticsParameters': {
                        'DataSetName': 'string'
                    },
                    'JiraParameters': {
                        'SiteBaseUrl': 'string'
                    },
                    'MariaDbParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'MySqlParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'OracleParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'PostgreSqlParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'PrestoParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Catalog': 'string'
                    },
                    'RdsParameters': {
                        'InstanceId': 'string',
                        'Database': 'string'
                    },
                    'RedshiftParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string',
                        'ClusterId': 'string'
                    },
                    'S3Parameters': {
                        'ManifestFileLocation': {
                            'Bucket': 'string',
                            'Key': 'string'
                        }
                    },
                    'ServiceNowParameters': {
                        'SiteBaseUrl': 'string'
                    },
                    'SnowflakeParameters': {
                        'Host': 'string',
                        'Database': 'string',
                        'Warehouse': 'string'
                    },
                    'SparkParameters': {
                        'Host': 'string',
                        'Port': 123
                    },
                    'SqlServerParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'TeradataParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Database': 'string'
                    },
                    'TwitterParameters': {
                        'Query': 'string',
                        'MaxRows': 123
                    }
                },
            ]
        },
        'CopySourceArn': 'string'
    },
    VpcConnectionProperties={
        'VpcConnectionArn': 'string'
    },
    SslProperties={
        'DisableSsl': True|False
    }
)
type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The AWS account ID.

type DataSourceId

string

param DataSourceId

[REQUIRED]

The ID of the data source. This ID is unique per AWS Region for each AWS account.

type Name

string

param Name

[REQUIRED]

A display name for the data source.

type DataSourceParameters

dict

param DataSourceParameters

The parameters that QuickSight uses to connect to your underlying source.

  • AmazonElasticsearchParameters (dict) --

    Amazon Elasticsearch Service parameters.

    • Domain (string) -- [REQUIRED]

      The Amazon Elasticsearch Service domain.

  • AthenaParameters (dict) --

    Amazon Athena parameters.

    • WorkGroup (string) --

      The workgroup that Amazon Athena uses.

  • AuroraParameters (dict) --

    Amazon Aurora MySQL parameters.

    • Host (string) -- [REQUIRED]

      Host.

    • Port (integer) -- [REQUIRED]

      Port.

    • Database (string) -- [REQUIRED]

      Database.

  • AuroraPostgreSqlParameters (dict) --

    Aurora PostgreSQL parameters.

    • Host (string) -- [REQUIRED]

      Host.

    • Port (integer) -- [REQUIRED]

      Port.

    • Database (string) -- [REQUIRED]

      Database.

  • AwsIotAnalyticsParameters (dict) --

    AWS IoT Analytics parameters.

    • DataSetName (string) -- [REQUIRED]

      Dataset name.

  • JiraParameters (dict) --

    Jira parameters.

    • SiteBaseUrl (string) -- [REQUIRED]

      The base URL of the Jira site.

  • MariaDbParameters (dict) --

    MariaDB parameters.

    • Host (string) -- [REQUIRED]

      Host.

    • Port (integer) -- [REQUIRED]

      Port.

    • Database (string) -- [REQUIRED]

      Database.

  • MySqlParameters (dict) --

    MySQL parameters.

    • Host (string) -- [REQUIRED]

      Host.

    • Port (integer) -- [REQUIRED]

      Port.

    • Database (string) -- [REQUIRED]

      Database.

  • OracleParameters (dict) --

    Oracle parameters.

    • Host (string) -- [REQUIRED]

      An Oracle host.

    • Port (integer) -- [REQUIRED]

      Port.

    • Database (string) -- [REQUIRED]

      Database.

  • PostgreSqlParameters (dict) --

    PostgreSQL parameters.

    • Host (string) -- [REQUIRED]

      Host.

    • Port (integer) -- [REQUIRED]

      Port.

    • Database (string) -- [REQUIRED]

      Database.

  • PrestoParameters (dict) --

    Presto parameters.

    • Host (string) -- [REQUIRED]

      Host.

    • Port (integer) -- [REQUIRED]

      Port.

    • Catalog (string) -- [REQUIRED]

      Catalog.

  • RdsParameters (dict) --

    Amazon RDS parameters.

    • InstanceId (string) -- [REQUIRED]

      Instance ID.

    • Database (string) -- [REQUIRED]

      Database.

  • RedshiftParameters (dict) --

    Amazon Redshift parameters.

    • Host (string) --

      Host. This field can be blank if ClusterId is provided.

    • Port (integer) --

      Port. This field can be blank if the ClusterId is provided.

    • Database (string) -- [REQUIRED]

      Database.

    • ClusterId (string) --

      Cluster ID. This field can be blank if the Host and Port are provided.

  • S3Parameters (dict) --

    S3 parameters.

    • ManifestFileLocation (dict) -- [REQUIRED]

      Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.

      • Bucket (string) -- [REQUIRED]

        Amazon S3 bucket.

      • Key (string) -- [REQUIRED]

        Amazon S3 key that identifies an object.

  • ServiceNowParameters (dict) --

    ServiceNow parameters.

    • SiteBaseUrl (string) -- [REQUIRED]

      URL of the base site.

  • SnowflakeParameters (dict) --

    Snowflake parameters.

    • Host (string) -- [REQUIRED]

      Host.

    • Database (string) -- [REQUIRED]

      Database.

    • Warehouse (string) -- [REQUIRED]

      Warehouse.

  • SparkParameters (dict) --

    Spark parameters.

    • Host (string) -- [REQUIRED]

      Host.

    • Port (integer) -- [REQUIRED]

      Port.

  • SqlServerParameters (dict) --

    SQL Server parameters.

    • Host (string) -- [REQUIRED]

      Host.

    • Port (integer) -- [REQUIRED]

      Port.

    • Database (string) -- [REQUIRED]

      Database.

  • TeradataParameters (dict) --

    Teradata parameters.

    • Host (string) -- [REQUIRED]

      Host.

    • Port (integer) -- [REQUIRED]

      Port.

    • Database (string) -- [REQUIRED]

      Database.

  • TwitterParameters (dict) --

    Twitter parameters.

    • Query (string) -- [REQUIRED]

      Twitter query string.

    • MaxRows (integer) -- [REQUIRED]

      Maximum number of rows to query Twitter.

type Credentials

dict

param Credentials

The credentials that QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

  • CredentialPair (dict) --

    Credential pair. For more information, see CredentialPair .

    • Username (string) -- [REQUIRED]

      User name.

    • Password (string) -- [REQUIRED]

      Password.

    • AlternateDataSourceParameters (list) --

      A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.

      • (dict) --

        The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

        • AmazonElasticsearchParameters (dict) --

          Amazon Elasticsearch Service parameters.

          • Domain (string) -- [REQUIRED]

            The Amazon Elasticsearch Service domain.

        • AthenaParameters (dict) --

          Amazon Athena parameters.

          • WorkGroup (string) --

            The workgroup that Amazon Athena uses.

        • AuroraParameters (dict) --

          Amazon Aurora MySQL parameters.

          • Host (string) -- [REQUIRED]

            Host.

          • Port (integer) -- [REQUIRED]

            Port.

          • Database (string) -- [REQUIRED]

            Database.

        • AuroraPostgreSqlParameters (dict) --

          Aurora PostgreSQL parameters.

          • Host (string) -- [REQUIRED]

            Host.

          • Port (integer) -- [REQUIRED]

            Port.

          • Database (string) -- [REQUIRED]

            Database.

        • AwsIotAnalyticsParameters (dict) --

          AWS IoT Analytics parameters.

          • DataSetName (string) -- [REQUIRED]

            Dataset name.

        • JiraParameters (dict) --

          Jira parameters.

          • SiteBaseUrl (string) -- [REQUIRED]

            The base URL of the Jira site.

        • MariaDbParameters (dict) --

          MariaDB parameters.

          • Host (string) -- [REQUIRED]

            Host.

          • Port (integer) -- [REQUIRED]

            Port.

          • Database (string) -- [REQUIRED]

            Database.

        • MySqlParameters (dict) --

          MySQL parameters.

          • Host (string) -- [REQUIRED]

            Host.

          • Port (integer) -- [REQUIRED]

            Port.

          • Database (string) -- [REQUIRED]

            Database.

        • OracleParameters (dict) --

          Oracle parameters.

          • Host (string) -- [REQUIRED]

            An Oracle host.

          • Port (integer) -- [REQUIRED]

            Port.

          • Database (string) -- [REQUIRED]

            Database.

        • PostgreSqlParameters (dict) --

          PostgreSQL parameters.

          • Host (string) -- [REQUIRED]

            Host.

          • Port (integer) -- [REQUIRED]

            Port.

          • Database (string) -- [REQUIRED]

            Database.

        • PrestoParameters (dict) --

          Presto parameters.

          • Host (string) -- [REQUIRED]

            Host.

          • Port (integer) -- [REQUIRED]

            Port.

          • Catalog (string) -- [REQUIRED]

            Catalog.

        • RdsParameters (dict) --

          Amazon RDS parameters.

          • InstanceId (string) -- [REQUIRED]

            Instance ID.

          • Database (string) -- [REQUIRED]

            Database.

        • RedshiftParameters (dict) --

          Amazon Redshift parameters.

          • Host (string) --

            Host. This field can be blank if ClusterId is provided.

          • Port (integer) --

            Port. This field can be blank if the ClusterId is provided.

          • Database (string) -- [REQUIRED]

            Database.

          • ClusterId (string) --

            Cluster ID. This field can be blank if the Host and Port are provided.

        • S3Parameters (dict) --

          S3 parameters.

          • ManifestFileLocation (dict) -- [REQUIRED]

            Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.

            • Bucket (string) -- [REQUIRED]

              Amazon S3 bucket.

            • Key (string) -- [REQUIRED]

              Amazon S3 key that identifies an object.

        • ServiceNowParameters (dict) --

          ServiceNow parameters.

          • SiteBaseUrl (string) -- [REQUIRED]

            URL of the base site.

        • SnowflakeParameters (dict) --

          Snowflake parameters.

          • Host (string) -- [REQUIRED]

            Host.

          • Database (string) -- [REQUIRED]

            Database.

          • Warehouse (string) -- [REQUIRED]

            Warehouse.

        • SparkParameters (dict) --

          Spark parameters.

          • Host (string) -- [REQUIRED]

            Host.

          • Port (integer) -- [REQUIRED]

            Port.

        • SqlServerParameters (dict) --

          SQL Server parameters.

          • Host (string) -- [REQUIRED]

            Host.

          • Port (integer) -- [REQUIRED]

            Port.

          • Database (string) -- [REQUIRED]

            Database.

        • TeradataParameters (dict) --

          Teradata parameters.

          • Host (string) -- [REQUIRED]

            Host.

          • Port (integer) -- [REQUIRED]

            Port.

          • Database (string) -- [REQUIRED]

            Database.

        • TwitterParameters (dict) --

          Twitter parameters.

          • Query (string) -- [REQUIRED]

            Twitter query string.

          • MaxRows (integer) -- [REQUIRED]

            Maximum number of rows to query Twitter.

  • CopySourceArn (string) --

    The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.

type VpcConnectionProperties

dict

param VpcConnectionProperties

Use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.

  • VpcConnectionArn (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) for the VPC connection.

type SslProperties

dict

param SslProperties

Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.

  • DisableSsl (boolean) --

    A Boolean option to control whether SSL should be disabled.

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'DataSourceId': 'string',
    'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) --

    • Arn (string) --

      The Amazon Resource Name (ARN) of the data source.

    • DataSourceId (string) --

      The ID of the data source. This ID is unique per AWS Region for each AWS account.

    • UpdateStatus (string) --

      The update status of the data source's last update.

    • RequestId (string) --

      The AWS request ID for this operation.

    • Status (integer) --

      The HTTP status of the request.