QuickSight / Client / describe_asset_bundle_import_job

describe_asset_bundle_import_job

QuickSight.Client.describe_asset_bundle_import_job(**kwargs)

Describes an existing import job.

Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.

See also: AWS API Documentation

Request Syntax

response = client.describe_asset_bundle_import_job(
    AwsAccountId='string',
    AssetBundleImportJobId='string'
)

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

  The ID of the Amazon Web Services account the import job was executed in.

• AssetBundleImportJobId (string) –

  [REQUIRED]

  The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.

Return type:

dict

Returns:

Response Syntax

{
    'JobStatus': 'QUEUED_FOR_IMMEDIATE_EXECUTION'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'FAILED_ROLLBACK_IN_PROGRESS'|'FAILED_ROLLBACK_COMPLETED'|'FAILED_ROLLBACK_ERROR',
    'Errors': [
        {
            'Arn': 'string',
            'Type': 'string',
            'Message': 'string'
        },
    ],
    'RollbackErrors': [
        {
            'Arn': 'string',
            'Type': 'string',
            'Message': 'string'
        },
    ],
    'Arn': 'string',
    'CreatedTime': datetime(2015, 1, 1),
    'AssetBundleImportJobId': 'string',
    'AwsAccountId': 'string',
    'AssetBundleImportSource': {
        'Body': 'string',
        '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',
                        'IAMParameters': {
                            'RoleArn': 'string',
                            'DatabaseUser': 'string',
                            'DatabaseGroups': [
                                'string',
                            ],
                            'AutoCreateDatabaseUser': True|False
                        }
                    },
                    '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'
                    },
                    'StarburstParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Catalog': 'string',
                        'ProductType': 'GALAXY'|'ENTERPRISE'
                    },
                    'TrinoParameters': {
                        'Host': 'string',
                        'Port': 123,
                        'Catalog': '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',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

• (dict) –

  • JobStatus (string) –

    Indicates the status of a job through its queuing and execution.

    Poll the DescribeAssetBundleImport API until JobStatus returns one of the following values:

    • SUCCESSFUL

    • FAILED

    • FAILED_ROLLBACK_COMPLETED

    • FAILED_ROLLBACK_ERROR

  • Errors (list) –

    An array of error records that describes any failures that occurred during the export job processing.

    Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.

    • (dict) –

      Describes an error that occurred within an Asset Bundle import execution.

      • Arn (string) –

        The ARN of the resource whose processing caused an error.

      • Type (string) –

        The specific error type or the error that occurred.

      • Message (string) –

        A description of the error.

  • RollbackErrors (list) –

    An array of error records that describes any failures that occurred while an import job was attempting a rollback.

    Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.

    • (dict) –

      Describes an error that occurred within an Asset Bundle import execution.

      • Arn (string) –

        The ARN of the resource whose processing caused an error.

      • Type (string) –

        The specific error type or the error that occurred.

      • Message (string) –

        A description of the error.

  • Arn (string) –

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

  • CreatedTime (datetime) –

    The time that the import job was created.

  • AssetBundleImportJobId (string) –

    The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.

  • AwsAccountId (string) –

    The ID of the Amazon Web Services account the import job was executed in.

  • AssetBundleImportSource (dict) –

    The source of the asset bundle zip file that contains the data that is imported by the job.

    • Body (string) –

      An HTTPS download URL for the provided asset bundle that you optionally provided at the start of the import job. This URL is valid for five minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed. The downloaded asset bundle is a .qs zip file.

    • S3Uri (string) –

      The Amazon S3 URI that you provided at the start of the import job.

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

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

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

        • ScheduleId (string) –

          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. Make sure 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) –

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

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

              Host.

            • Port (integer) –

              Port.

            • Database (string) –

              Database.

          • AuroraPostgreSqlParameters (dict) –

            The parameters for Amazon Aurora.

            • Host (string) –

              The Amazon Aurora PostgreSQL-Compatible host to connect to.

            • Port (integer) –

              The port that Amazon Aurora PostgreSQL is listening on.

            • Database (string) –

              The Amazon Aurora PostgreSQL database to connect to.

          • AwsIotAnalyticsParameters (dict) –

            The parameters for IoT Analytics.

            • DataSetName (string) –

              Dataset name.

          • JiraParameters (dict) –

            The parameters for Jira.

            • SiteBaseUrl (string) –

              The base URL of the Jira site.

          • MariaDbParameters (dict) –

            The parameters for MariaDB.

            • Host (string) –

              Host.

            • Port (integer) –

              Port.

            • Database (string) –

              Database.

          • MySqlParameters (dict) –

            The parameters for MySQL.

            • Host (string) –

              Host.

            • Port (integer) –

              Port.

            • Database (string) –

              Database.

          • OracleParameters (dict) –

            The parameters for Oracle.

            • Host (string) –

              An Oracle host.

            • Port (integer) –

              The port.

            • Database (string) –

              The database.

          • PostgreSqlParameters (dict) –

            The parameters for PostgreSQL.

            • Host (string) –

              Host.

            • Port (integer) –

              Port.

            • Database (string) –

              Database.

          • PrestoParameters (dict) –

            The parameters for Presto.

            • Host (string) –

              Host.

            • Port (integer) –

              Port.

            • Catalog (string) –

              Catalog.

          • RdsParameters (dict) –

            The parameters for Amazon RDS.

            • InstanceId (string) –

              Instance ID.

            • Database (string) –

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

              Database.

            • ClusterId (string) –

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

            • IAMParameters (dict) –

              An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.

              • RoleArn (string) –

                Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role’s trust policy must allow the Amazon QuickSight service principal to assume the role.

              • DatabaseUser (string) –

                The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn’t exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.

              • DatabaseGroups (list) –

                A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.

                • (string) –

              • AutoCreateDatabaseUser (boolean) –

                Automatically creates a database user. If your database doesn’t have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can’t connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.

          • S3Parameters (dict) –

            The parameters for S3.

            • ManifestFileLocation (dict) –

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

              • Bucket (string) –

                Amazon S3 bucket.

              • Key (string) –

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

              URL of the base site.

          • SnowflakeParameters (dict) –

            The parameters for Snowflake.

            • Host (string) –

              Host.

            • Database (string) –

              Database.

            • Warehouse (string) –

              Warehouse.

          • SparkParameters (dict) –

            The parameters for Spark.

            • Host (string) –

              Host.

            • Port (integer) –

              Port.

          • SqlServerParameters (dict) –

            The parameters for SQL Server.

            • Host (string) –

              Host.

            • Port (integer) –

              Port.

            • Database (string) –

              Database.

          • TeradataParameters (dict) –

            The parameters for Teradata.

            • Host (string) –

              Host.

            • Port (integer) –

              Port.

            • Database (string) –

              Database.

          • TwitterParameters (dict) –

            The parameters for Twitter.

            • Query (string) –

              Twitter query string.

            • MaxRows (integer) –

              Maximum number of rows to query Twitter.

          • AmazonOpenSearchParameters (dict) –

            The parameters for OpenSearch.

            • Domain (string) –

              The OpenSearch domain.

          • ExasolParameters (dict) –

            The parameters for Exasol.

            • Host (string) –

              The hostname or IP address of the Exasol data source.

            • Port (integer) –

              The port for the Exasol data source.

          • DatabricksParameters (dict) –

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

            • Host (string) –

              The host name of the Databricks data source.

            • Port (integer) –

              The port for the Databricks data source.

            • SqlEndpointPath (string) –

              The HTTP path of the Databricks data source.

          • StarburstParameters (dict) –

            The parameters that are required to connect to a Starburst data source.

            • Host (string) –

              The host name of the Starburst data source.

            • Port (integer) –

              The port for the Starburst data source.

            • Catalog (string) –

              The catalog name for the Starburst data source.

            • ProductType (string) –

              The product type for the Starburst data source.

          • TrinoParameters (dict) –

            The parameters that are required to connect to a Trino data source.

            • Host (string) –

              The host name of the Trino data source.

            • Port (integer) –

              The port for the Trino data source.

            • Catalog (string) –

              The catalog name for the Trino data source.

        • VpcConnectionProperties (dict) –

          VPC connection properties.

          • VpcConnectionArn (string) –

            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. Keep this field blank if you are using a Secrets Manager secret to provide credentials.

            • Username (string) –

              The username for the data source connection.

            • Password (string) –

              The password for the data source connection.

          • SecretArn (string) –

            The ARN of the Secrets Manager secret that’s used to create the imported data source. Keep this field blank, unless you are 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) –

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

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

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

          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.

  • RequestId (string) –

    The Amazon Web Services request ID for this operation.

  • Status (integer) –

    The HTTP status of the response.

Exceptions

• QuickSight.Client.exceptions.UnsupportedUserEditionException

• QuickSight.Client.exceptions.ThrottlingException

• QuickSight.Client.exceptions.ResourceNotFoundException