describe-import
Описание
Представляет свойства импорта.
См. также: Документацию API AWS
Синтаксис
describe-import
--import-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Параметры
--import-arn (строка)
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения, используя значение, предоставленное JSON, так как строка будет восприниматься буквально. Это не может быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если указано без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, он валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.
Глобальные параметры
--debug (булево)
Включить отладочную регистрацию.
--endpoint-url (строка)
Переопределить адрес по умолчанию команды заданным адресом.
--no-verify-ssl (булево)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.
--no-paginate (булево)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования выходных данных команды.
- json
- текст
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определённый профиль из вашего файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки из конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/выключить цветной вывод.
- включено
- выключено
- автоматически
--no-sign-request (булево)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.
--ca-bundle (строка)
Файл сертификата CA для проверки сертификатов SSL. Переопределяет настройки из конфигурации/среды.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как закодированная строка base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, сопоставленного с двоичным блоком, fileb:// всегда будет обрабатываться как двоичное и будет использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для конфигурированного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (булево)
Отключить пейджер CLI для вывода.
--cli-auto-prompt (булево)
Автоматически запрашивать параметры входных данных CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запроса параметров входных данных CLI.
Вывод
ImportTableDescription -> (структура)
Представляет свойства таблицы, созданной для импорта, и параметры импорта. Параметры импорта включают статус импорта, количество обработанных элементов и количество возникших ошибок.
ImportArn -> (строка)
ImportStatus -> (строка)
TableArn -> (строка)
TableId -> (строка)
ClientToken -> (строка)
ImportTable идемпотентным.S3BucketSource -> (структура)
Значения для S3-бакета, из которого импортируется исходный файл. Включает имя ведра (обязательно), префикс ключа (необязательно) и идентификатор владельца учетной записи ведра (необязательно).
S3BucketOwner -> (строка)
S3Bucket -> (строка)
S3KeyPrefix -> (строка)
ErrorCount -> (длинное целое число)
CloudWatchLogGroupArn -> (строка)
InputFormat -> (строка)
InputFormatOptions -> (структура)
Параметры формата данных, импортированных в целевую таблицу. Есть одно значение, CsvOption.
Csv -> (структура)
Параметры импортируемых исходных файлов в формате CSV. Значения — Delimiter и HeaderList.
Delimiter -> (строка)
HeaderList -> (список)
Список заголовков, используемых для указания общего заголовка для всех импортируемых исходных файлов CSV. Если это поле указано, то первая строка каждого файла CSV обрабатывается как данные, а не как заголовок. Если это поле не указано, то первая строка каждого файла CSV обрабатывается как заголовок.
(строка)
InputCompressionType -> (строка)
TableCreationParameters -> (структура)
Параметры новой таблицы, в которую выполняется импорт.
TableName -> (строка)
AttributeDefinitions -> (список)
Атрибуты созданной в рамках операции импорта таблицы.
(структура)
Представляет атрибут для описания схемы таблицы и индексов.
AttributeName -> (строка)
AttributeType -> (строка)
Тип данных атрибута, где:
-
S- атрибут типа Строка -
N- атрибут типа Число -
B- атрибут типа Двоичные данные
KeySchema -> (список)
Основной ключ и необязательный сортировочный ключ созданной в рамках операции импорта таблицы.
(структура)
Представляет один элемент схемы ключей. Схема ключей определяет атрибуты, составляющие первичный ключ таблицы или атрибуты ключа индекса.
KeySchemaElement представляет ровно один атрибут первичного ключа. Например, простой первичный ключ будет представлен одним KeySchemaElement (для разделающего ключа). Составной первичный ключ потребует одного KeySchemaElement для разделающего ключа и другого KeySchemaElement для сортировочного ключа.
KeySchemaElement должен быть скалярным атрибутом верхнего уровня (не вложенным атрибутом). Тип данных должен быть одним из Строка, Число или Двоичные данные. Атрибут не может быть вложенным в Список или Карту.
AttributeName -> (строка)
KeyType -> (строка)
Роль, которую будет выполнять этот атрибут ключа:
-
HASH- разделающий ключ -
RANGE- сортировочный ключ
Примечание
Разделающий ключ элемента также известен как его атрибут хэширования . Термин «атрибут хэширования» происходит от использования DynamoDB внутренней функции хэширования для равномерного распределения элементов данных по разделам на основе их значений разделающего ключа.
Сортировочный ключ элемента также известен как его атрибут диапазона . Термин «атрибут диапазона» происходит от способа, которым DynamoDB хранит элементы с одинаковым разделающим ключом физически близко друг к другу в отсортированном порядке по значениям сортировочного ключа.
BillingMode -> (строка)
ProvisionedThroughput -> (структура)
Представляет параметры пропускной способности для указанного глобального вторичного индекса. Вы должны использовать ProvisionedThroughput или OnDemandThroughput в зависимости от режима емкости вашей таблицы.
Рекомендуемые минимальные и максимальные значения пропускной способности см. в разделе «Квоты сервиса, учетной записи и таблицы» в руководстве разработчика Amazon DynamoDB.
ReadCapacityUnits -> (длинное целое число)
Максимальное количество сильных согласованных чтений, потребляемых в секунду, прежде чем DynamoDB вернет ThrottlingException . Дополнительную информацию см. в разделе «Указание требований к чтению и записи» в руководстве разработчика Amazon DynamoDB.
Если режим емкости чтения/записи равен PAY_PER_REQUEST, значение устанавливается в 0.
WriteCapacityUnits -> (длинное целое число)
Максимальное количество записей, потребляемых в секунду, прежде чем DynamoDB вернет ThrottlingException . Дополнительную информацию см. в разделе «Указание требований к чтению и записи» в руководстве разработчика Amazon DynamoDB.
Если режим емкости чтения/записи равен PAY_PER_REQUEST, значение устанавливается в 0.
OnDemandThroughput -> (структура)
Устанавливает максимальное количество единиц чтения и записи для указанной таблицы по запросу. Если вы используете этот параметр, вы должны указать MaxReadRequestUnits , MaxWriteRequestUnits или оба.
MaxReadRequestUnits -> (длинное целое число)
Максимальное количество единиц запроса чтения для указанной таблицы.
Чтобы указать максимальное OnDemandThroughput для вашей таблицы, установите значение MaxReadRequestUnits как больше или равно 1. Чтобы удалить максимальное OnDemandThroughput, которое в настоящее время установлено для вашей таблицы, установите значение MaxReadRequestUnits в -1.
MaxWriteRequestUnits -> (длинное целое число)
Максимальное количество единиц запроса записи для указанной таблицы.
Чтобы указать максимальное OnDemandThroughput для вашей таблицы, установите значение MaxWriteRequestUnits как больше или равно 1. Чтобы удалить максимальное OnDemandThroughput, которое в настоящее время установлено для вашей таблицы, установите значение MaxWriteRequestUnits в -1.
SSESpecification -> (структура)
Представляет параметры, используемые для включения шифрования на стороне сервера.
Enabled -> (булево значение)
KMS, и используется управляемый Amazon Web Services ключ (применяются сборы KMS). Если отключено (false) или не указано, шифрование на стороне сервера устанавливается в ключ, принадлежащий Amazon Web Services.SSEType -> (строка)
Тип шифрования на стороне сервера. Поддерживается только одно значение:
-
KMS- Шифрование на стороне сервера, использующее Key Management Service. Ключ хранится в вашей учетной записи и управляется KMS (применяются сборы KMS).
KMSMasterKeyId -> (строка)
alias/aws/dynamodb.GlobalSecondaryIndexes -> (список)
Глобальные вторичные индексы (GSI) таблицы, подлежащей созданию в рамках операции импорта.
(структура)
Представляет свойства глобального вторичного индекса.
IndexName -> (строка)
KeySchema -> (список)
Полная схема ключа для глобального вторичного индекса, которая состоит из одной или нескольких пар имён атрибутов и типов ключей:
-
HASH- ключевой атрибут разделения -
RANGE- ключевой атрибут сортировки
Примечание
Ключевой атрибут разделения элемента также известен как его атрибут хеширования. Термин «атрибут хеширования» происходит от использования DynamoDB внутренней хеш-функции для равномерного распределения элементов данных по разделам на основе значений их ключевого атрибута разделения.
Ключевой атрибут сортировки элемента также известен как его атрибут диапазона. Термин «атрибут диапазона» происходит от того, как DynamoDB хранит элементы с одинаковым ключевым атрибутом разделения физически близко друг к другу в отсортированном порядке по значениям ключевого атрибута сортировки.
(структура)
Представляет один элемент схемы ключа. Схема ключа определяет атрибуты, составляющие первичный ключ таблицы или ключевые атрибуты индекса.
KeySchemaElement представляет ровно один атрибут первичного ключа. Например, простой первичный ключ будет представлен одним KeySchemaElement (для ключевого атрибута разделения). Составной первичный ключ потребует одного KeySchemaElement для ключевого атрибута разделения и другого KeySchemaElement для ключевого атрибута сортировки.
KeySchemaElement должен быть скалярным атрибутом верхнего уровня (не вложенным атрибутом). Тип данных должен быть String, Number или Binary. Атрибут не может быть вложен в список или карту.
AttributeName -> (строка)
KeyType -> (строка)
Роль, которую этот атрибут ключа будет выполнять:
-
HASH- ключевой атрибут разделения -
RANGE- ключевой атрибут сортировки
Примечание
Ключевой атрибут разделения элемента также известен как его атрибут хеширования. Термин «атрибут хеширования» происходит от использования DynamoDB внутренней хеш-функции для равномерного распределения элементов данных по разделам на основе значений их ключевого атрибута разделения.
Ключевой атрибут сортировки элемента также известен как его атрибут диапазона. Термин «атрибут диапазона» происходит от того, как DynamoDB хранит элементы с одинаковым ключевым атрибутом разделения физически близко друг к другу в отсортированном порядке по значениям ключевого атрибута сортировки.
Projection -> (структура)
Представляет атрибуты, которые копируются (проектируются) из таблицы в глобальный вторичный индекс. Они дополняют первичные ключевые атрибуты и ключевые атрибуты индекса, которые автоматически проектируются.
ProjectionType -> (строка)
Набор атрибутов, которые проектируются в индекс:
-
KEYS_ONLY- В индекс проектируются только индекс и первичные ключи. -
INCLUDE- В дополнение к атрибутам, описанным вKEYS_ONLY, вторичный индекс будет включать другие атрибуты, не являющиеся ключами, которые вы укажете. -
ALL- Все атрибуты таблицы проектируются в индекс.
При использовании консоли DynamoDB по умолчанию выбран ALL.
NonKeyAttributes -> (список)
Представляет имена атрибутов, не являющихся ключами, которые будут спроецированы в индекс.
Для глобальных и локальных вторичных индексов общее количество NonKeyAttributes, суммированное по всем вторичным индексам, не должно превышать 100. Если вы проектируете один и тот же атрибут в два разных индекса, это считается двумя отдельными атрибутами при определении общего количества. Это ограничение применяется только при указании ProjectionType INCLUDE. Вы по-прежнему можете указать ProjectionType ALL, чтобы спроецировать все атрибуты из исходной таблицы, даже если в таблице более 100 атрибутов.
(строка)
ProvisionedThroughput -> (структура)
Представляет настройки пропускной способности для указанного глобального вторичного индекса. Вы должны использовать либо OnDemandThroughput, либо ProvisionedThroughput в зависимости от режима пропускной способности вашей таблицы.
Текущие минимальные и максимальные значения пропускной способности см. в разделе «Квоты сервиса, учетной записи и таблицы» в Руководстве разработчика Amazon DynamoDB.
ReadCapacityUnits -> (целое)
Максимальное количество чтений с сильной консистентностью, потребляемых в секунду, прежде чем DynamoDB вернёт ThrottlingException. Дополнительную информацию см. в разделе «Указание требований к чтению и записи» в Руководстве разработчика Amazon DynamoDB.
Если режим пропускной способности чтения/записи - PAY_PER_REQUEST, значение устанавливается в 0.
WriteCapacityUnits -> (целое)
Максимальное количество записей, потребляемых в секунду, прежде чем DynamoDB вернёт ThrottlingException. Дополнительную информацию см. в разделе «Указание требований к чтению и записи» в Руководстве разработчика Amazon DynamoDB.
Если режим пропускной способности чтения/записи - PAY_PER_REQUEST, значение устанавливается в 0.
OnDemandThroughput -> (структура)
Максимальное количество единиц чтения и записи для указанного глобального вторичного индекса. Если вы используете этот параметр, вы должны указать MaxReadRequestUnits, MaxWriteRequestUnits или оба. Вы должны использовать либо OnDemandThroughput, либо ProvisionedThroughput в зависимости от режима пропускной способности вашей таблицы.
MaxReadRequestUnits -> (целое)
Максимальное количество единиц запроса на чтение для указанной таблицы.
Чтобы задать максимальное OnDemandThroughput для вашей таблицы, установите значение MaxReadRequestUnits как больше или равно 1. Чтобы удалить текущее максимальное OnDemandThroughput для вашей таблицы, установите значение MaxReadRequestUnits в -1.
MaxWriteRequestUnits -> (целое)
Максимальное количество единиц запроса на запись для указанной таблицы.
Чтобы задать максимальное OnDemandThroughput для вашей таблицы, установите значение MaxWriteRequestUnits как больше или равно 1. Чтобы удалить текущее максимальное OnDemandThroughput для вашей таблицы, установите значение MaxWriteRequestUnits в -1.
WarmThroughput -> (структура)
Представляет значение тепловой пропускной способности (в единицах чтения и записи в секунду) для указанного вторичного индекса. Если вы используете этот параметр, вы должны указать ReadUnitsPerSecond, WriteUnitsPerSecond или оба.
ReadUnitsPerSecond -> (целое)
WriteUnitsPerSecond -> (целое)
StartTime -> (временная метка)
EndTime -> (временная метка)
ProcessedSizeBytes -> (целое)
ProcessedItemCount -> (целое)
ImportedItemCount -> (целое)
FailureCode -> (строка)
FailureMessage -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.