QuickSight / Client / start_asset_bundle_import_job

start_asset_bundle_import_job

QuickSight.Client.start_asset_bundle_import_job(**kwargs)

Starts an Asset Bundle import job.

An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 10 import jobs concurrently.

The API caller must have the necessary "create", "describe", and "update" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.

See also: AWS API Documentation

Request Syntax

response = client.start_asset_bundle_import_job(
    AwsAccountId='string',
    AssetBundleImportJobId='string',
    AssetBundleImportSource={
        'Body': b'bytes',
        'S3Uri': 'string'
    },
    OverrideParameters={
        'ResourceIdOverrideConfiguration': {
            'PrefixForAllResources': 'string'
        },
        'VPCConnections': [
            {
                'VPCConnectionId': 'string',
                'Name': 'string',
                'SubnetIds': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ],
                'DnsResolvers': [
                    'string',
                ],
                'RoleArn': 'string'
            },
        ],
        'RefreshSchedules': [
            {
                'DataSetId': 'string',
                'ScheduleId': 'string',
                'StartAfterDateTime': datetime(2015, 1, 1)
            },
        ],
        'DataSources': [
            {
                'DataSourceId': 'string',
                'Name': 'string',
                'DataSourceParameters': {
                    'AmazonElasticsearchParameters': {
                        'Domain': 'string'
                    },
                    'AthenaParameters': {
                        'WorkGroup': 'string',
                        'RoleArn': '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'
                        },
                        'RoleArn': '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
                    },
                    'AmazonOpenSearchParameters': {
                        'Domain': 'string'
                    },
                    'ExasolParameters': {
                        'Host': 'string',
                        'Port': 123
                    },
                    'DatabricksParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'SqlEndpointPath': 'string'
                    }
                },
                'VpcConnectionProperties': {
                    'VpcConnectionArn': 'string'
                },
                'SslProperties': {
                    'DisableSsl': True|False
                },
                'Credentials': {
                    'CredentialPair': {
                        'Username': 'string',
                        'Password': 'string'
                    },
                    'SecretArn': 'string'
                }
            },
        ],
        'DataSets': [
            {
                'DataSetId': 'string',
                'Name': 'string'
            },
        ],
        'Themes': [
            {
                'ThemeId': 'string',
                'Name': 'string'
            },
        ],
        'Analyses': [
            {
                'AnalysisId': 'string',
                'Name': 'string'
            },
        ],
        'Dashboards': [
            {
                'DashboardId': 'string',
                'Name': 'string'
            },
        ]
    },
    FailureAction='DO_NOTHING'|'ROLLBACK'
)

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

  The ID of the Amazon Web Services account to import assets into.

• AssetBundleImportJobId (string) –

  [REQUIRED]

  The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

• AssetBundleImportSource (dict) –

  [REQUIRED]

  The source of the asset bundle zip file that contains the data that you want to import.

  • Body (bytes) –

    The bytes of the Base64 encoded asset bundle import zip file. This file can’t exceed 20MB.

    If you are calling the APIs from the Amazon Web Services Java, JavaScript, Python, or PHP SDKs, the SDK encodes Base64 automatically to allow the direct setting of the zip file’s bytes. If you are using a SDK of a different language or are receiving related errors, try to Base64 encode your data.

  • S3Uri (string) –

    The Amazon S3 uri for an asset bundle import file that exists in an Amazon S3 bucket that the caller has read access to. The file must be a zip format file and can’t exceed 20MB.

• OverrideParameters (dict) –

  Optional overrides to be applied to the resource configuration before import.

  • ResourceIdOverrideConfiguration (dict) –

    An optional structure that configures resource ID overrides to be applied within the import job.

    • PrefixForAllResources (string) –

      An option to request a CloudFormation variable for a prefix to be prepended to each resource’s ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.

  • VPCConnections (list) –

    A list of overrides for any VPCConnection resources that are present in the asset bundle that is imported.

    • (dict) –

      The override parameters for a single VPC connection that is imported.

      • VPCConnectionId (string) – [REQUIRED]

        The ID of the VPC Connection to apply overrides to.

      • Name (string) –

        A new name for the VPC connection.

      • SubnetIds (list) –

        A list of new subnet IDs for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or region.

        • (string) –

      • SecurityGroupIds (list) –

        A new security group ID for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or region.

        • (string) –

      • DnsResolvers (list) –

        An optional override of dns resolvers to be used by the VPC connection.

        • (string) –

      • RoleArn (string) –

        An optional override of the role ARN to be used by the VPC connection.

  • RefreshSchedules (list) –

    A list of overrides for any RefreshSchedule resources that are present in the asset bundle that is imported.

    • (dict) –

      A list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.

      • DataSetId (string) – [REQUIRED]

        A partial identifier for the specific RefreshSchedule resource that is being overridden. This structure is used together with the ScheduleID structure.

      • ScheduleId (string) – [REQUIRED]

        A partial identifier for the specific RefreshSchedule resource being overridden. This structure is used together with the DataSetId structure.

      • StartAfterDateTime (datetime) –

        An override for the StartAfterDateTime of a RefreshSchedule to ensure that the StartAfterDateTime is set to a time that takes place in the future.

  • DataSources (list) –

    A list of overrides for any DataSource resources that are present in the asset bundle that is imported.

    • (dict) –

      The override parameters for a single data source that is being imported.

      • DataSourceId (string) – [REQUIRED]

        The ID of the data source to apply overrides to.

      • Name (string) –

        A new name for the data source.

      • DataSourceParameters (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) –

          The parameters for OpenSearch.

          • Domain (string) – [REQUIRED]

            The OpenSearch domain.

        • AthenaParameters (dict) –

          The parameters for Amazon Athena.

          • WorkGroup (string) –

            The workgroup that Amazon Athena uses.

          • RoleArn (string) –

            Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.

        • AuroraParameters (dict) –

          The parameters for Amazon Aurora MySQL.

          • Host (string) – [REQUIRED]

            Host.

          • Port (integer) – [REQUIRED]

            Port.

          • Database (string) – [REQUIRED]

            Database.

        • AuroraPostgreSqlParameters (dict) –

          The parameters for Amazon Aurora.

          • Host (string) – [REQUIRED]

            The Amazon Aurora PostgreSQL-Compatible host to connect to.

          • Port (integer) – [REQUIRED]

            The port that Amazon Aurora PostgreSQL is listening on.

          • Database (string) – [REQUIRED]

            The Amazon Aurora PostgreSQL database to connect to.

        • AwsIotAnalyticsParameters (dict) –

          The parameters for IoT Analytics.

          • DataSetName (string) – [REQUIRED]

            Dataset name.

        • JiraParameters (dict) –

          The parameters for Jira.

          • SiteBaseUrl (string) – [REQUIRED]

            The base URL of the Jira site.

        • MariaDbParameters (dict) –

          The parameters for MariaDB.

          • Host (string) – [REQUIRED]

            Host.

          • Port (integer) – [REQUIRED]

            Port.

          • Database (string) – [REQUIRED]

            Database.

        • MySqlParameters (dict) –

          The parameters for MySQL.

          • Host (string) – [REQUIRED]

            Host.

          • Port (integer) – [REQUIRED]

            Port.

          • Database (string) – [REQUIRED]

            Database.

        • OracleParameters (dict) –

          The parameters for Oracle.

          • Host (string) – [REQUIRED]

            An Oracle host.

          • Port (integer) – [REQUIRED]

            The port.

          • Database (string) – [REQUIRED]

            The database.

        • PostgreSqlParameters (dict) –

          The parameters for PostgreSQL.

          • Host (string) – [REQUIRED]

            Host.

          • Port (integer) – [REQUIRED]

            Port.

          • Database (string) – [REQUIRED]

            Database.

        • PrestoParameters (dict) –

          The parameters for Presto.

          • Host (string) – [REQUIRED]

            Host.

          • Port (integer) – [REQUIRED]

            Port.

          • Catalog (string) – [REQUIRED]

            Catalog.

        • RdsParameters (dict) –

          The parameters for Amazon RDS.

          • InstanceId (string) – [REQUIRED]

            Instance ID.

          • Database (string) – [REQUIRED]

            Database.

        • RedshiftParameters (dict) –

          The parameters for Amazon Redshift.

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

          The parameters for S3.

          • ManifestFileLocation (dict) – [REQUIRED]

            Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.

            • Bucket (string) – [REQUIRED]

              Amazon S3 bucket.

            • Key (string) – [REQUIRED]

              Amazon S3 key that identifies an object.

          • RoleArn (string) –

            Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

        • ServiceNowParameters (dict) –

          The parameters for ServiceNow.

          • SiteBaseUrl (string) – [REQUIRED]

            URL of the base site.

        • SnowflakeParameters (dict) –

          The parameters for Snowflake.

          • Host (string) – [REQUIRED]

            Host.

          • Database (string) – [REQUIRED]

            Database.

          • Warehouse (string) – [REQUIRED]

            Warehouse.

        • SparkParameters (dict) –

          The parameters for Spark.

          • Host (string) – [REQUIRED]

            Host.

          • Port (integer) – [REQUIRED]

            Port.

        • SqlServerParameters (dict) –

          The parameters for SQL Server.

          • Host (string) – [REQUIRED]

            Host.

          • Port (integer) – [REQUIRED]

            Port.

          • Database (string) – [REQUIRED]

            Database.

        • TeradataParameters (dict) –

          The parameters for Teradata.

          • Host (string) – [REQUIRED]

            Host.

          • Port (integer) – [REQUIRED]

            Port.

          • Database (string) – [REQUIRED]

            Database.

        • TwitterParameters (dict) –

          The parameters for Twitter.

          • Query (string) – [REQUIRED]

            Twitter query string.

          • MaxRows (integer) – [REQUIRED]

            Maximum number of rows to query Twitter.

        • AmazonOpenSearchParameters (dict) –

          The parameters for OpenSearch.

          • Domain (string) – [REQUIRED]

            The OpenSearch domain.

        • ExasolParameters (dict) –

          The parameters for Exasol.

          • Host (string) – [REQUIRED]

            The hostname or IP address of the Exasol data source.

          • Port (integer) – [REQUIRED]

            The port for the Exasol data source.

        • DatabricksParameters (dict) –

          The required parameters that are needed to connect to a Databricks data source.

          • Host (string) – [REQUIRED]

            The host name of the Databricks data source.

          • Port (integer) – [REQUIRED]

            The port for the Databricks data source.

          • SqlEndpointPath (string) – [REQUIRED]

            The HTTP path of the Databricks data source.

      • VpcConnectionProperties (dict) –

        VPC connection properties.

        • VpcConnectionArn (string) – [REQUIRED]

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

      • SslProperties (dict) –

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

        • DisableSsl (boolean) –

          A Boolean option to control whether SSL should be disabled.

      • Credentials (dict) –

        An optional structure that provides the credentials to be used to create the imported data source.

        • CredentialPair (dict) –

          A username and password credential pair to be used to create the imported data source. Leave this field blank if you are using an Secrets Manager Secret to provide credentials.

          • Username (string) – [REQUIRED]

            The username for the data source connection.

          • Password (string) – [REQUIRED]

            The password for the data source connection.

        • SecretArn (string) –

          The ARN of the Secrets Manager Secret to be used to create the imported data source leave this field blank if you aren’t using a Secret in place of a credential pair.

  • DataSets (list) –

    A list of overrides for any DataSet resources that are present in the asset bundle that is imported.

    • (dict) –

      The override parameters for a single dataset that is being imported.

      • DataSetId (string) – [REQUIRED]

        The ID of the dataset to apply overrides to.

      • Name (string) –

        A new name for the dataset.

  • Themes (list) –

    A list of overrides for any Theme resources that are present in the asset bundle that is imported.

    • (dict) –

      The override parameters for a single theme that is imported.

      • ThemeId (string) – [REQUIRED]

        The ID of the theme to apply overrides to.

      • Name (string) –

        A new name for the theme.

  • Analyses (list) –

    A list of overrides for any Analysis resources that are present in the asset bundle that is imported.

    • (dict) –

      The override parameters for a single analysis that is being imported.

      • AnalysisId (string) – [REQUIRED]

        The ID of the analysis that you ant to apply overrides to.

      • Name (string) –

        A new name for the analysis.

  • Dashboards (list) –

    A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.

    • (dict) –

      The override parameters for a single dashboard that is being imported.

      • DashboardId (string) – [REQUIRED]

        The ID of the dashboard that you want to apply overrides to.

      • Name (string) –

        A new name for the dashboard.

• FailureAction (string) –

  The failure action for the import job.

  If you choose ROLLBACK, failed import jobs will attempt to undo any asset changes caused by the failed job.

  If you choose DO_NOTHING, failed import jobs will not attempt to roll back any asset changes caused by the failed job, possibly leaving the Amazon QuickSight account in an inconsistent state.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'AssetBundleImportJobId': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

• (dict) –

  • Arn (string) –

    The Amazon Resource Name (ARN) for the import job.

  • AssetBundleImportJobId (string) –

    The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

  • RequestId (string) –

    The Amazon Web Services response ID for this operation.

  • Status (integer) –

    The HTTP status of the response.

Exceptions

• QuickSight.Client.exceptions.UnsupportedUserEditionException

• QuickSight.Client.exceptions.ThrottlingException

• QuickSight.Client.exceptions.InvalidParameterValueException

• QuickSight.Client.exceptions.AccessDeniedException

• QuickSight.Client.exceptions.LimitExceededException

• QuickSight.Client.exceptions.ConflictException

• QuickSight.Client.exceptions.ResourceNotFoundException