Skip to content
AWS for Query.Farm

aws.dynamodb.describe_import

Example SQL Queries

SELECT * FROM
aws.dynamodb.describe_import
WHERE
"import_arn" = 'VALUE';

Description

Represents the properties of the import.

Table Definition

Column NameColumn Data Type
import_arn Required Input Column

The Amazon Resource Name (ARN) associated with the table you're importing to. 

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
import_table_description

Represents the properties of the table created for the import, and parameters of the import. The import parameters include import status, how many items were processed, and how many errors were encountered. 

STRUCT(
    "import_arn" VARCHAR,
    "import_status" VARCHAR,
    "table_arn" VARCHAR,
    "table_id" VARCHAR,
    "client_token" VARCHAR,
    "s3_bucket_source" STRUCT(
        "s3_bucket_owner" VARCHAR,
        "s3_bucket" VARCHAR,
        "s3_key_prefix" VARCHAR
    ),
    "error_count" BIGINT,
    "cloud_watch_log_group_arn" VARCHAR,
    "input_format" VARCHAR,
    "input_format_options" STRUCT(
        "csv" STRUCT(
            "delimiter" VARCHAR,
            "header_list" VARCHAR[]
        )
    ),
    "input_compression_type" VARCHAR,
    "table_creation_parameters" STRUCT(
        "table_name" VARCHAR,
        "attribute_definitions" STRUCT(
            "attribute_name" VARCHAR,
            "attribute_type" VARCHAR
        )[],
        "key_schema" STRUCT(
            "attribute_name" VARCHAR,
            "key_type" VARCHAR
        )[],
        "billing_mode" VARCHAR,
        "provisioned_throughput" STRUCT(
            "read_capacity_units" BIGINT,
            "write_capacity_units" BIGINT
        ),
        "on_demand_throughput" STRUCT(
            "max_read_request_units" BIGINT,
            "max_write_request_units" BIGINT
        ),
        "sse_specification" STRUCT(
            "enabled" BOOLEAN,
            "sse_type" VARCHAR,
            "kms_master_key_id" VARCHAR
        ),
        "global_secondary_indexes" STRUCT(
            "index_name" VARCHAR,
            "key_schema" STRUCT(
                "attribute_name" VARCHAR,
                "key_type" VARCHAR
            )[],
            "projection" STRUCT(
                "projection_type" VARCHAR,
                "non_key_attributes" VARCHAR[]
            ),
            "provisioned_throughput" STRUCT(
                "read_capacity_units" BIGINT,
                "write_capacity_units" BIGINT
            ),
            "on_demand_throughput" STRUCT(
                "max_read_request_units" BIGINT,
                "max_write_request_units" BIGINT
            )
        )[]
    ),
    "start_time" TIMESTAMP_S,
    "end_time" TIMESTAMP_S,
    "processed_size_bytes" BIGINT,
    "processed_item_count" BIGINT,
    "imported_item_count" BIGINT,
    "failure_code" VARCHAR,
    "failure_message" VARCHAR
)
Show child fields
import_table_description.client_token

The client token that was provided for the import task. Reusing the client token on retry makes a call to ImportTable idempotent.

import_table_description.cloud_watch_log_group_arn

The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with the target table.

import_table_description.end_time

The time at which the creation of the table associated with this import task completed.

import_table_description.error_count

The number of errors occurred on importing the source file into the target table.

import_table_description.failure_code

The error code corresponding to the failure that the import job ran into during execution.

import_table_description.failure_message

The error message corresponding to the failure that the import job ran into during execution.

import_table_description.import_arn

The Amazon Resource Number (ARN) corresponding to the import request.

import_table_description.import_status

The status of the import.

import_table_description.imported_item_count

The number of items successfully imported into the new table.

import_table_description.input_compression_type

The compression options for the data that has been imported into the target table. The values are NONE, GZIP, or ZSTD.

import_table_description.input_format

The format of the source data going into the target table.

import_table_description.input_format_options

The format options for the data that was imported into the target table. There is one value, CsvOption.

Show child fields
import_table_description.input_format_options.csv

The options for imported source files in CSV format. The values are Delimiter and HeaderList.

Show child fields
import_table_description.input_format_options.csv.delimiter

The delimiter used for separating items in the CSV file being imported.

import_table_description.input_format_options.csv.header_list[]
import_table_description.processed_item_count

The total number of items processed from the source file.

import_table_description.processed_size_bytes

The total size of data processed from the source file, in Bytes.

import_table_description.s3_bucket_source

Values for the S3 bucket the source file is imported from. Includes bucket name (required), key prefix (optional) and bucket account owner ID (optional).

Show child fields
import_table_description.s3_bucket_source.s3_bucket

The S3 bucket that is being imported from.

import_table_description.s3_bucket_source.s3_bucket_owner

The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional.

import_table_description.s3_bucket_source.s3_key_prefix

The key prefix shared by all S3 Objects that are being imported.

import_table_description.start_time

The time when this import task started.

import_table_description.table_arn

The Amazon Resource Number (ARN) of the table being imported into.

import_table_description.table_creation_parameters

The parameters for the new table that is being imported into.

Show child fields
import_table_description.table_creation_parameters.attribute_definitions[]
Show child fields
import_table_description.table_creation_parameters.attribute_definitions[].attribute_name

A name for the attribute.

import_table_description.table_creation_parameters.attribute_definitions[].attribute_type

The data type for the attribute, where:

  • S - the attribute is of type String

  • N - the attribute is of type Number

  • B - the attribute is of type Binary

import_table_description.table_creation_parameters.billing_mode

The billing mode for provisioning the table created as part of the import operation.

import_table_description.table_creation_parameters.global_secondary_indexes[]
Show child fields
import_table_description.table_creation_parameters.global_secondary_indexes[].index_name

The name of the global secondary index. The name must be unique among all other indexes on this table.

import_table_description.table_creation_parameters.global_secondary_indexes[].key_schema[]
Show child fields
import_table_description.table_creation_parameters.global_secondary_indexes[].key_schema[].attribute_name

The name of a key attribute.

import_table_description.table_creation_parameters.global_secondary_indexes[].key_schema[].key_type

The role that this key attribute will assume:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

import_table_description.table_creation_parameters.global_secondary_indexes[].on_demand_throughput

The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

Show child fields
import_table_description.table_creation_parameters.global_secondary_indexes[].on_demand_throughput.max_read_request_units

Maximum number of read request units for the specified table.

To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.

import_table_description.table_creation_parameters.global_secondary_indexes[].on_demand_throughput.max_write_request_units

Maximum number of write request units for the specified table.

To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.

import_table_description.table_creation_parameters.global_secondary_indexes[].projection

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Show child fields
import_table_description.table_creation_parameters.global_secondary_indexes[].projection.non_key_attributes[]
import_table_description.table_creation_parameters.global_secondary_indexes[].projection.projection_type

The set of attributes that are projected into the index:

  • KEYS_ONLY - Only the index and primary keys are projected into the index.

  • INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.

  • ALL - All of the table attributes are projected into the index.

When using the DynamoDB console, ALL is selected by default.

import_table_description.table_creation_parameters.global_secondary_indexes[].provisioned_throughput

Represents the provisioned throughput settings for the specified global secondary index.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

Show child fields
import_table_description.table_creation_parameters.global_secondary_indexes[].provisioned_throughput.read_capacity_units

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

import_table_description.table_creation_parameters.global_secondary_indexes[].provisioned_throughput.write_capacity_units

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

import_table_description.table_creation_parameters.key_schema[]
Show child fields
import_table_description.table_creation_parameters.key_schema[].attribute_name

The name of a key attribute.

import_table_description.table_creation_parameters.key_schema[].key_type

The role that this key attribute will assume:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

import_table_description.table_creation_parameters.on_demand_throughput

Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

Show child fields
import_table_description.table_creation_parameters.on_demand_throughput.max_read_request_units

Maximum number of read request units for the specified table.

To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.

import_table_description.table_creation_parameters.on_demand_throughput.max_write_request_units

Maximum number of write request units for the specified table.

To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.

import_table_description.table_creation_parameters.provisioned_throughput

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

Show child fields
import_table_description.table_creation_parameters.provisioned_throughput.read_capacity_units

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

import_table_description.table_creation_parameters.provisioned_throughput.write_capacity_units

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

import_table_description.table_creation_parameters.sse_specification

Represents the settings used to enable server-side encryption.

Show child fields
import_table_description.table_creation_parameters.sse_specification.enabled

Indicates whether server-side encryption is done using an Amazon Web Services managed key or an Amazon Web Services owned key. If enabled (true), server-side encryption type is set to KMS and an Amazon Web Services managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to Amazon Web Services owned key.

import_table_description.table_creation_parameters.sse_specification.kms_master_key_id

The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb.

import_table_description.table_creation_parameters.sse_specification.sse_type

Server-side encryption type. The only supported value is:

  • KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).

import_table_description.table_creation_parameters.table_name

The name of the table created as part of the import operation.

import_table_description.table_id

The table id corresponding to the table created by import table process.