Spec-Zone.ru › AWS CLI v2

[ aws . dynamodb ]

batch-get-item

Описание

Операция BatchGetItem возвращает атрибуты одного или нескольких элементов из одной или нескольких таблиц. Запрашиваемые элементы идентифицируются по первичному ключу.

В рамках одной операции можно получить до 16 МБ данных, которые могут содержать до 100 элементов. BatchGetItem возвращает частичный результат, если превышен лимит размера ответа, превышен пропускная способность таблицы, запрошено более 1 МБ на раздел или произошла внутренняя ошибка обработки. Если возвращается частичный результат, операция возвращает значение для UnprocessedKeys . Вы можете использовать это значение для повторного выполнения операции, начиная с следующего элемента для получения.

Предупреждение

Если вы запрашиваете более 100 элементов, BatchGetItem возвращает ValidationException с сообщением «Запрошено слишком много элементов для вызова BatchGetItem».

Например, если вы запрашиваете 100 элементов, но каждый отдельный элемент имеет размер 300 КБ, система возвращает 52 элемента (чтобы не превысить лимит 16 МБ). Она также возвращает соответствующее значение UnprocessedKeys, чтобы вы могли получить следующую страницу результатов. При необходимости ваше приложение может включить собственную логику для объединения страниц результатов в один набор данных.

Если ни один из элементов не может быть обработан из-за недостаточной пропускной способности на всех таблицах в запросе, то BatchGetItem возвращает ProvisionedThroughputExceededException . Если хотя бы один из элементов успешно обработан, то BatchGetItem завершается успешно, возвращая ключи непрочитанных элементов в UnprocessedKeys .

Предупреждение

Если DynamoDB возвращает какие-либо необработанные элементы, вы должны повторить операцию пакетной обработки для этих элементов. Однако мы настоятельно рекомендуем использовать алгоритм экспоненциального замедления . Если вы повторите операцию пакетной обработки немедленно, базовые запросы чтения или записи все равно могут завершиться неудачей из-за ограничения по отдельным таблицам. Если вы задерживаете операцию пакетной обработки, используя экспоненциальное замедление, отдельные запросы в пакете гораздо чаще будут успешны.

Дополнительную информацию см. в разделе «Операции пакетной обработки и обработка ошибок» в Руководстве разработчика Amazon DynamoDB.

По умолчанию, BatchGetItem выполняет чтение с eventual consistency для каждой таблицы в запросе. Если вы хотите использовать strong consistency вместо этого, вы можете установить ConsistentRead на true для любой или всех таблиц.

Для минимизации задержки ответа, BatchGetItem может извлекать элементы параллельно.

При разработке своего приложения имейте в виду, что DynamoDB не возвращает элементы в определенном порядке. Чтобы помочь в анализе ответа по элементу, включите значения первичного ключа для элементов в ваш запрос в параметре ProjectionExpression.

Если запрашиваемый элемент не существует, он не возвращается в результате. Запросы для несуществующих элементов потребляют минимальное количество единиц пропускной способности чтения в соответствии с типом чтения. Дополнительную информацию см. в разделе Работа с таблицами в Руководстве разработчика Amazon DynamoDB.

Примечание

BatchGetItem приведет к ValidationException, если один и тот же ключ указан несколько раз.

См. также: Документацию API AWS

Синопсис

  batch-get-item
--request-items <value>
[--return-consumed-capacity <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]

Параметры

--request-items (map)

Карта одного или нескольких имен таблиц или ARNs таблиц и, для каждой таблицы, карта, описывающая один или несколько элементов для извлечения из этой таблицы. Каждое имя таблицы или ARN может использоваться только один раз в запросе BatchGetItem.

Каждый элемент в карте элементов для извлечения состоит из следующего:

  • ConsistentRead - Если true , используется strong consistency; если false (по умолчанию), используется eventual consistency.
  • ExpressionAttributeNames - Один или несколько токенов подстановки для имён атрибутов в параметре ProjectionExpression. Вот некоторые случаи использования ExpressionAttributeNames :
    • Для доступа к атрибуту, имя которого конфликтует с зарезервированным словом DynamoDB.
    • Для создания заполнительных токенов для повторяющихся появлений имени атрибута в выражении.
    • Для предотвращения неправильной интерпретации специальных символов в имени атрибута в выражении.

Используйте символ # в выражении для ссылки на имя атрибута. Например, рассмотрите следующее имя атрибута:

  • Percentile

Имя этого атрибута конфликтует с зарезервированным словом, поэтому его нельзя использовать напрямую в выражении. (Полный список зарезервированных слов см. в Руководстве разработчика Amazon DynamoDB). Чтобы обойти это, вы могли бы указать следующее для ExpressionAttributeNames :

  • {"#P":"Percentile"}

Затем вы могли бы использовать эту подстановку в выражении, как в этом примере:

  • #P = :val

Примечание

Токены, начинающиеся с символа :, являются значениями атрибутов выражения, которые являются заполнительными значениями для фактического значения во время выполнения.

Дополнительную информацию об именах атрибутов выражения см. в разделе Доступ к атрибутам элементов в Руководстве разработчика Amazon DynamoDB.

  • Keys - Массив значений атрибутов первичного ключа, которые определяют конкретные элементы в таблице. Для каждого первичного ключа вы должны предоставить все атрибуты ключа. Например, с простым первичным ключом вам нужно только предоставить значение ключа раздела. Для составного ключа вы должны предоставить и значение ключа раздела, и значение ключа сортировки.
  • ProjectionExpression - Строка, которая идентифицирует один или несколько атрибутов для извлечения из таблицы. Эти атрибуты могут включать скаляры, наборы или элементы JSON-документа. Атрибуты в выражении должны быть разделены запятыми. Если имена атрибутов не указаны, возвращаются все атрибуты. Если какой-либо из запрашиваемых атрибутов не найден, он не отображается в результате. Дополнительную информацию см. в разделе Доступ к атрибутам элементов в Руководстве разработчика Amazon DynamoDB.
  • AttributesToGet - Этот параметр является устаревшим. Используйте ProjectionExpression вместо него. Дополнительную информацию см. в разделе AttributesToGet в Руководстве разработчика Amazon DynamoDB.

key -> (строка)

value -> (структура)

Представляет набор первичных ключей и, для каждого ключа, атрибутов, которые нужно извлечь из таблицы.

Для каждого первичного ключа вы должны указать все атрибуты ключа. Например, с простым первичным ключом, вам нужно указать только ключ разбиения. Для составного первичного ключа вы должны указать оба ключа разбиения и сортировки.

Ключи -> (список)

Значения атрибутов первичного ключа, которые определяют элементы и атрибуты, связанные с этими элементами.

(карта)

ключ -> (строка)

значение -> (структура)

Представляет данные для атрибута.

Каждое значение атрибута описывается как пара имя-значение. Имя — это тип данных, а значение — само значение.

Дополнительную информацию см. в разделе Типы данных в руководстве разработчика Amazon DynamoDB.

S -> (строка)

Атрибут типа Строка. Например:

"S": "Hello"

N -> (строка)

Атрибут типа Число. Например:

"N": "123.45"

Числа отправляются в DynamoDB по сети как строки для максимальной совместимости между языками и библиотеками. Однако DynamoDB обрабатывает их как атрибуты типа число для математических операций.

B -> (бинарный массив)

Атрибут типа Бинарный. Например:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

SS -> (список)

Атрибут типа Набор строк. Например:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

(строка)

NS -> (список)

Атрибут типа Набор чисел. Например:

"NS": ["42.2", "-19", "7.5", "3.14"]

Числа отправляются в DynamoDB по сети как строки для максимальной совместимости между языками и библиотеками. Однако DynamoDB обрабатывает их как атрибуты типа число для математических операций.

(строка)

BS -> (список)

Атрибут типа Набор двоичных данных. Например:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

(бинарный массив)

M -> (карта)

Атрибут типа Карта. Например:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

ключ -> (строка)

значение -> (структура)

Представляет данные для атрибута.

Каждое значение атрибута описывается как пара имя-значение. Имя — это тип данных, а значение — само значение.

Дополнительную информацию см. в разделе Типы данных в руководстве разработчика Amazon DynamoDB.

S -> (строка)

Атрибут типа Строка. Например:

"S": "Hello"

N -> (строка)

Атрибут типа Число. Например:

"N": "123.45"

Числа отправляются в DynamoDB по сети как строки для максимальной совместимости между языками и библиотеками. Однако DynamoDB обрабатывает их как атрибуты типа число для математических операций.

B -> (бинарный массив)

Атрибут типа Бинарный. Например:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

SS -> (список)

Атрибут типа Набор строк. Например:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

(строка)

NS -> (список)

Атрибут типа Набор чисел. Например:

"NS": ["42.2", "-19", "7.5", "3.14"]

Числа отправляются в DynamoDB по сети как строки для максимальной совместимости между языками и библиотеками. Однако DynamoDB обрабатывает их как атрибуты типа число для математических операций.

(строка)

BS -> (список)

Атрибут типа Набор двоичных данных. Например:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

(бинарный массив)

M -> (карта)

Атрибут типа Карта. Например:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

ключ -> (строка)

(… рекурсивно …)

L -> (список)

Атрибут типа Список. Например:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

(… рекурсивно …)

NULL -> (логическое значение)

Атрибут типа Null. Например:

"NULL": true

BOOL -> (логическое значение)

Атрибут типа Логическое значение. Например:

"BOOL": true

L -> (список)

Атрибут типа Список. Например:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

(структура)

Представляет данные для атрибута.

Каждое значение атрибута описывается как пара имя-значение. Имя — это тип данных, а значение — само значение.

Дополнительную информацию см. в разделе Типы данных в руководстве разработчика Amazon DynamoDB.

S -> (строка)

Атрибут типа Строка. Например:

"S": "Hello"

N -> (строка)

Атрибут типа Число. Например:

"N": "123.45"

Числа отправляются в DynamoDB по сети как строки для максимальной совместимости между языками и библиотеками. Однако DynamoDB обрабатывает их как атрибуты типа число для математических операций.

B -> (бинарный массив)

Атрибут типа Бинарный. Например:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

SS -> (список)

Атрибут типа Набор строк. Например:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

(строка)

NS -> (список)

Атрибут типа Набор чисел. Например:

"NS": ["42.2", "-19", "7.5", "3.14"]

Числа отправляются в DynamoDB по сети как строки для максимальной совместимости между языками и библиотеками. Однако DynamoDB обрабатывает их как атрибуты типа число для математических операций.

(строка)

BS -> (список)

Атрибут типа Набор двоичных данных. Например:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

(бинарный массив)

M -> (карта)

Атрибут типа Карта. Например:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

ключ -> (строка)

(… рекурсивно …)

L -> (список)

Атрибут типа Список. Например:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

(… рекурсивно …)

NULL -> (логическое значение)

Атрибут типа Null. Например:

"NULL": true

BOOL -> (логическое значение)

Атрибут типа Логическое значение. Например:

"BOOL": true

NULL -> (логическое значение)

Атрибут типа Null. Например:

"NULL": true

BOOL -> (логическое значение)

Атрибут типа Логическое значение. Например:

"BOOL": true

AttributesToGet -> (список)

Это устаревший параметр. Используйте ProjectionExpression вместо него. Дополнительную информацию см. в разделе Устаревшие условные параметры в руководстве разработчика Amazon DynamoDB.

(строка)

ConsistentRead -> (логическое значение)

Согласованность операции чтения. Если установлено значение true, используется строго согласованное чтение; в противном случае используется согласованное чтение.

ProjectionExpression -> (строка)

Строка, которая идентифицирует один или несколько атрибутов для извлечения из таблицы. Эти атрибуты могут включать скаляры, наборы или элементы JSON-документа. Атрибуты в ProjectionExpression должны быть разделены запятыми.

Если имена атрибутов не указаны, будут возвращены все атрибуты. Если какой-либо из запрошенных атрибутов не найден, он не будет отображаться в результате.

Дополнительную информацию см. в разделе Доступ к атрибутам элементов в руководстве разработчика Amazon DynamoDB.

ExpressionAttributeNames -> (карта)

Один или несколько замещающих маркеров для имен атрибутов в выражении. Ниже приведены некоторые варианты использования ExpressionAttributeNames:

  • Для доступа к атрибуту, имя которого конфликтует с зарезервированным словом DynamoDB.
  • Для создания заполнительных маркеров для повторяющихся вхождений имени атрибута в выражении.
  • Для предотвращения неправильной интерпретации специальных символов в имени атрибута в выражении.

В выражении используйте символ # для ссылки на имя атрибута. Например, рассмотрим следующее имя атрибута:

  • Percentile

Имя этого атрибута конфликтует с зарезервированным словом, поэтому его нельзя использовать напрямую в выражении. (Полный список зарезервированных слов см. в руководстве разработчика Amazon DynamoDB). Чтобы обойти эту проблему, вы можете указать следующее для ExpressionAttributeNames:

  • {"#P":"Percentile"}

Затем вы можете использовать эту подстановку в выражении, как в этом примере:

  • #P = :val

Примечание

Маркеры, начинающиеся с символа :, являются значениями атрибутов выражения, которые представляют собой плейсхолдеры для фактического значения во время выполнения.

Дополнительную информацию об именах атрибутов выражения см. в разделе Доступ к атрибутам элементов в руководстве разработчика Amazon DynamoDB.

ключ -> (строка)

значение -> (строка)

Синтаксис JSON:

{"string": {
      "Keys": [
        {"string": {
              "S": "string",
              "N": "string",
              "B": blob,
              "SS": ["string", ...],
              "NS": ["string", ...],
              "BS": [blob, ...],
              "M": {"string": {
                    "S": "string",
                    "N": "string",
                    "B": blob,
                    "SS": ["string", ...],
                    "NS": ["string", ...],
                    "BS": [blob, ...],
                    "M": {"string": { ... recursive ... }
                      ...},
                    "L": [
                      { ... recursive ... }
                      ...
                    ],
                    "NULL": true|false,
                    "BOOL": true|false
                  }
                ...},
              "L": [
                {
                  "S": "string",
                  "N": "string",
                  "B": blob,
                  "SS": ["string", ...],
                  "NS": ["string", ...],
                  "BS": [blob, ...],
                  "M": {"string": { ... recursive ... }
                    ...},
                  "L": [
                    { ... recursive ... }
                    ...
                  ],
                  "NULL": true|false,
                  "BOOL": true|false
                }
                ...
              ],
              "NULL": true|false,
              "BOOL": true|false
            }
          ...}
        ...
      ],
      "AttributesToGet": ["string", ...],
      "ConsistentRead": true|false,
      "ProjectionExpression": "string",
      "ExpressionAttributeNames": {"string": "string"
        ...}
    }
  ...}

--return-consumed-capacity (строка)

Определяет уровень детализации потребления пропускной способности (предопределенной или по требованию), который возвращается в ответе:

  • INDEXES — Ответ включает в себя агрегированное значение ConsumedCapacity для операции, а также значения ConsumedCapacity для каждой таблицы и вторичного индекса, к которым был произведен доступ. Обратите внимание, что некоторые операции, такие как GetItem и BatchGetItem, вообще не обращаются к индексам. В этих случаях указание INDEXES вернет только информацию о ConsumedCapacity таблицы(а).
  • TOTAL — Ответ включает только агрегированное значение ConsumedCapacity для операции.
  • NONE — Подробности о ConsumedCapacity не включены в ответ.

Возможные значения:

  • INDEXES
  • TOTAL
  • NONE

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

Включить отладку протоколирования.

--endpoint-url (string)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один запрос для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определённый профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл с пакетом сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат 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 (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическую запрос параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Получение нескольких элементов из таблицы

Следующий пример читает несколько элементов из таблицы MusicCollection, используя пакет из трех GetItem запросов, и запрашивает количество единиц прочитанной пропускной способности, потреблённых операцией. Команда возвращает только атрибут AlbumTitle.

aws dynamodb batch-get-item \
    --request-items file://request-items.json \
    --return-consumed-capacity TOTAL

Содержимое request-items.json:

{
    "MusicCollection": {
        "Keys": [
            {
                "Artist": {"S": "No One You Know"},
                "SongTitle": {"S": "Call Me Today"}
            },
            {
                "Artist": {"S": "Acme Band"},
                "SongTitle": {"S": "Happy Day"}
            },
            {
                "Artist": {"S": "No One You Know"},
                "SongTitle": {"S": "Scared of My Shadow"}
            }
        ],
        "ProjectionExpression":"AlbumTitle"
    }
}

Вывод:

{
    "Responses": {
        "MusicCollection": [
            {
                "AlbumTitle": {
                    "S": "Somewhat Famous"
                }
            },
            {
                "AlbumTitle": {
                    "S": "Blue Sky Blues"
                }
            },
            {
                "AlbumTitle": {
                    "S": "Louder Than Ever"
                }
            }
        ]
    },
    "UnprocessedKeys": {},
    "ConsumedCapacity": [
        {
            "TableName": "MusicCollection",
            "CapacityUnits": 1.5
        }
    ]
}

Дополнительную информацию см. в разделе "Операции пакетной обработки" в Руководстве разработчика Amazon DynamoDB.

Вывод

Responses -> (map)

Словарь имени таблицы или ARN таблицы к списку элементов. Каждый объект в Responses состоит из имени или ARN таблицы, а также словаря данных атрибутов, состоящего из типа данных и значения атрибута.

ключ -> (строка)

значение -> (список)

(словарь)

ключ -> (строка)

значение -> (структура)

Представляет данные для атрибута.

Каждое значение атрибута описывается как пара имя-значение. Имя — это тип данных, а значение — само данные.

Дополнительную информацию см. в разделе "Типы данных" в Руководстве разработчика Amazon DynamoDB.

S -> (строка)

Атрибут типа Строка. Например:

"S": "Hello"

N -> (строка)

Атрибут типа Число. Например:

"N": "123.45"

Числа передаются по сети в DynamoDB в виде строк для максимальной совместимости между языками и библиотеками. Однако DynamoDB обрабатывает их как числовые атрибуты для математических операций.

B -> (бинарные данные)

Атрибут типа Двоичные данные. Например:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

SS -> (список)

Атрибут типа Множество строк. Например:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

(строка)

NS -> (список)

Атрибут типа Множество чисел. Например:

"NS": ["42.2", "-19", "7.5", "3.14"]

Числа передаются по сети в DynamoDB в виде строк для максимальной совместимости между языками и библиотеками. Однако DynamoDB обрабатывает их как числовые атрибуты для математических операций.

(строка)

BS -> (список)

Атрибут типа Множество двоичных данных. Например:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

(бинарные данные)

M -> (словарь)

Атрибут типа Словарь. Например:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

ключ -> (строка)

значение -> (структура)

Представляет данные для атрибута.

Каждое значение атрибута описывается как пара имя-значение. Имя — это тип данных, а значение — само данные.

Дополнительную информацию см. в разделе "Типы данных" в Руководстве разработчика Amazon DynamoDB.

S -> (строка)

Атрибут типа Строка. Например:

"S": "Hello"

N -> (строка)

Атрибут типа Число. Например:

"N": "123.45"

Числа передаются по сети в DynamoDB в виде строк для максимальной совместимости между языками и библиотеками. Однако DynamoDB обрабатывает их как числовые атрибуты для математических операций.

B -> (бинарные данные)

Атрибут типа Двоичные данные. Например:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

SS -> (список)

Атрибут типа Множество строк. Например:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

(строка)

NS -> (список)

Атрибут типа Множество чисел. Например:

"NS": ["42.2", "-19", "7.5", "3.14"]

Числа передаются по сети в DynamoDB в виде строк для максимальной совместимости между языками и библиотеками. Однако DynamoDB обрабатывает их как числовые атрибуты для математических операций.

(строка)

BS -> (список)

Атрибут типа Множество двоичных данных. Например:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

(бинарные данные)

M -> (словарь)

Атрибут типа Словарь. Например:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

ключ -> (строка)

(… рекурсивно …)

L -> (список)

Атрибут типа Список. Например:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

(… рекурсивно …)

NULL -> (boolean)

Атрибут типа Null. Например:

"NULL": true

BOOL -> (boolean)

Атрибут типа Boolean. Например:

"BOOL": true

L -> (список)

Атрибут типа Список. Например:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

(структура)

Представляет данные для атрибута.

Каждое значение атрибута описывается как пара имя-значение. Имя — это тип данных, а значение — само данные.

Дополнительную информацию см. в разделе "Типы данных" в Руководстве разработчика Amazon DynamoDB.

S -> (строка)

Атрибут типа Строка. Например:

"S": "Hello"

N -> (строка)

Атрибут типа Число. Например:

"N": "123.45"

Числа передаются по сети в DynamoDB в виде строк для максимальной совместимости между языками и библиотеками. Однако DynamoDB обрабатывает их как числовые атрибуты для математических операций.

B -> (бинарные данные)

Атрибут типа Двоичные данные. Например:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

SS -> (список)

Атрибут типа Множество строк. Например:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

(строка)

NS -> (список)

Атрибут типа Множество чисел. Например:

"NS": ["42.2", "-19", "7.5", "3.14"]

Числа передаются по сети в DynamoDB в виде строк для максимальной совместимости между языками и библиотеками. Однако DynamoDB обрабатывает их как числовые атрибуты для математических операций.

(строка)

BS -> (список)

Атрибут типа Множество двоичных данных. Например:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

(бинарные данные)

M -> (словарь)

Атрибут типа Словарь. Например:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

ключ -> (строка)

(… рекурсивно …)

L -> (список)

Атрибут типа Список. Например:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

(… рекурсивно …)

NULL -> (boolean)

Атрибут типа Null. Например:

"NULL": true

BOOL -> (boolean)

Атрибут типа Boolean. Например:

"BOOL": true

NULL -> (boolean)

Атрибут типа Null. Например:

"NULL": true

BOOL -> (boolean)

Атрибут типа Boolean. Например:

"BOOL": true

UnprocessedKeys -> (map)

Карта таблиц и их соответствующих ключей, которые не были обработаны текущим ответом. Значение UnprocessedKeys имеет тот же формат, что и RequestItems, поэтому значение можно напрямую предоставить последующей операции BatchGetItem. Для получения дополнительной информации см. RequestItems в разделе Параметры запроса.

Каждый элемент состоит из:

  • Keys — массив значений атрибутов первичного ключа, определяющих конкретные элементы в таблице.
  • ProjectionExpression — один или несколько атрибутов, которые необходимо извлечь из таблицы или индекса. По умолчанию возвращаются все атрибуты. Если запрашиваемый атрибут не найден, он не отображается в результате.
  • ConsistentRead — согласованность операции чтения. Если установлено значение true, используется чтение со строгой согласованностью; в противном случае используется чтение с конечной согласованностью.

Если оставшихся необработанных ключей нет, ответ содержит пустую карту UnprocessedKeys.

ключ -> (строка)

значение -> (структура)

Представляет набор первичных ключей и, для каждого ключа, атрибутов, которые необходимо извлечь из таблицы.

Для каждого первичного ключа вы должны предоставить все атрибуты ключа. Например, при простом первичном ключе вам нужно предоставить только ключ раздела. Для составного первичного ключа вы должны предоставить оба ключа раздела и ключ сортировки.

Ключи -> (список)

Значения атрибутов первичного ключа, определяющие элементы и атрибуты, связанные с элементами.

(карта)

ключ -> (строка)

значение -> (структура)

Представляет данные для атрибута.

Каждое значение атрибута описывается как пара «имя-значение». Имя — это тип данных, а значение — это само данные.

Для получения дополнительной информации см. Типы данных в Руководстве разработчика Amazon DynamoDB.

S -> (строка)

Атрибут типа Строка. Например:

"S": "Hello"

N -> (строка)

Атрибут типа Число. Например:

"N": "123.45"

Числа передаются в DynamoDB по сети в виде строк для максимальной совместимости между языками и библиотеками. Однако DynamoDB обрабатывает их как атрибуты типа число для математических операций.

B -> (байтовый массив)

Атрибут типа Бинарный. Например:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

SS -> (список)

Атрибут типа Набор строк. Например:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

(строка)

NS -> (список)

Атрибут типа Набор чисел. Например:

"NS": ["42.2", "-19", "7.5", "3.14"]

Числа передаются в DynamoDB по сети в виде строк для максимальной совместимости между языками и библиотеками. Однако DynamoDB обрабатывает их как атрибуты типа число для математических операций.

(строка)

BS -> (список)

Атрибут типа Набор двоичных данных. Например:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

(байтовый массив)

M -> (карта)

Атрибут типа Карта. Например:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

ключ -> (строка)

значение -> (структура)

Представляет данные для атрибута.

Каждое значение атрибута описывается как пара «имя-значение». Имя — это тип данных, а значение — это само данные.

Для получения дополнительной информации см. Типы данных в Руководстве разработчика Amazon DynamoDB.

S -> (строка)

Атрибут типа Строка. Например:

"S": "Hello"

N -> (строка)

Атрибут типа Число. Например:

"N": "123.45"

Числа передаются в DynamoDB по сети в виде строк для максимальной совместимости между языками и библиотеками. Однако DynamoDB обрабатывает их как атрибуты типа число для математических операций.

B -> (байтовый массив)

Атрибут типа Бинарный. Например:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

SS -> (список)

Атрибут типа Набор строк. Например:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

(строка)

NS -> (список)

Атрибут типа Набор чисел. Например:

"NS": ["42.2", "-19", "7.5", "3.14"]

Числа передаются в DynamoDB по сети в виде строк для максимальной совместимости между языками и библиотеками. Однако DynamoDB обрабатывает их как атрибуты типа число для математических операций.

(строка)

BS -> (список)

Атрибут типа Набор двоичных данных. Например:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

(байтовый массив)

M -> (карта)

Атрибут типа Карта. Например:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

ключ -> (строка)

(… рекурсивно …)

L -> (список)

Атрибут типа Список. Например:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

(… рекурсивно …)

NULL -> (логическое значение)

Атрибут типа NULL. Например:

"NULL": true

BOOL -> (логическое значение)

Атрибут типа Булево. Например:

"BOOL": true

L -> (список)

Атрибут типа Список. Например:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

(структура)

Представляет данные для атрибута.

Каждое значение атрибута описывается как пара «имя-значение». Имя — это тип данных, а значение — это само данные.

Для получения дополнительной информации см. Типы данных в Руководстве разработчика Amazon DynamoDB.

S -> (строка)

Атрибут типа Строка. Например:

"S": "Hello"

N -> (строка)

Атрибут типа Число. Например:

"N": "123.45"

Числа передаются в DynamoDB по сети в виде строк для максимальной совместимости между языками и библиотеками. Однако DynamoDB обрабатывает их как атрибуты типа число для математических операций.

B -> (байтовый массив)

Атрибут типа Бинарный. Например:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

SS -> (список)

Атрибут типа Набор строк. Например:

"SS": ["Giraffe", "Hippo" ,"Zebra"]

(строка)

NS -> (список)

Атрибут типа Набор чисел. Например:

"NS": ["42.2", "-19", "7.5", "3.14"]

Числа передаются в DynamoDB по сети в виде строк для максимальной совместимости между языками и библиотеками. Однако DynamoDB обрабатывает их как атрибуты типа число для математических операций.

(строка)

BS -> (список)

Атрибут типа Набор двоичных данных. Например:

"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

(байтовый массив)

M -> (карта)

Атрибут типа Карта. Например:

"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

ключ -> (строка)

(… рекурсивно …)

L -> (список)

Атрибут типа Список. Например:

"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

(… рекурсивно …)

NULL -> (логическое значение)

Атрибут типа NULL. Например:

"NULL": true

BOOL -> (логическое значение)

Атрибут типа Булево. Например:

"BOOL": true

NULL -> (логическое значение)

Атрибут типа NULL. Например:

"NULL": true

BOOL -> (логическое значение)

Атрибут типа Булево. Например:

"BOOL": true

AttributesToGet -> (список)

Это устаревший параметр. Используйте ProjectionExpression вместо него. Для получения дополнительной информации см. Устаревшие условные параметры в Руководстве разработчика Amazon DynamoDB.

(строка)

ConsistentRead -> (логическое значение)

Согласованность операции чтения. Если установлено значение true, используется чтение со строгой согласованностью; в противном случае используется чтение с конечной согласованностью.

ProjectionExpression -> (строка)

Строка, определяющая один или несколько атрибутов для извлечения из таблицы. Эти атрибуты могут включать скаляры, наборы или элементы JSON-документа. Атрибуты в ProjectionExpression должны быть разделены запятыми.

Если имена атрибутов не указаны, будут возвращены все атрибуты. Если какие-либо из запрашиваемых атрибутов не найдены, они не будут отображаться в результате.

Для получения дополнительной информации см. Доступ к атрибутам элементов в Руководстве разработчика Amazon DynamoDB.

ExpressionAttributeNames -> (карта)

Один или несколько маркеров подстановки для имён атрибутов в выражении. Вот несколько примеров использования ExpressionAttributeNames:

  • Для доступа к атрибуту, имя которого совпадает с зарезервированным словом DynamoDB.
  • Для создания маркера для повторяющихся случаев имени атрибута в выражении.
  • Для предотвращения неправильной интерпретации специальных символов в имени атрибута в выражении.

Используйте символ # в выражении для привязки имени атрибута. Например, рассмотрим следующее имя атрибута:

  • Percentile

Имя этого атрибута совпадает с зарезервированным словом, поэтому его нельзя использовать напрямую в выражении. (Полный список зарезервированных слов см. в Руководстве разработчика Amazon DynamoDB). Чтобы обойти это, вы можете указать следующее для ExpressionAttributeNames:

  • {"#P":"Percentile"}

Затем вы можете использовать эту подстановку в выражении, как в этом примере:

  • #P = :val

Примечание

Маркеры, начинающиеся с символа :, являются значениями атрибутов выражения, которые представляют собой заглушки для фактического значения во время выполнения.

Для получения дополнительной информации об именах атрибутов выражения см. Доступ к атрибутам элементов в Руководстве разработчика Amazon DynamoDB.

ключ -> (строка)

значение -> (строка)

ConsumedCapacity -> (список)

Единицы пропускной способности чтения, потребленные во время всей операции BatchGetItem.

Каждый элемент состоит из:

  • TableName - Таблица, которая потребляла выделенную пропускную способность.
  • CapacityUnits - Общее количество потребленных единиц пропускной способности.

(структура)

Единицы пропускной способности, потребленные операцией. Возвращаемые данные включают в себя общее количество потребленной выделенной пропускной способности, а также статистику для таблицы и всех индексов, участвовавших в операции. ConsumedCapacity возвращается только в том случае, если запрос об этом попросил. Для получения дополнительной информации см. Режим выделенной пропускной способности в Руководстве разработчика Amazon DynamoDB.

TableName -> (строка)

Имя таблицы, затронутой операцией. Если в качестве входных данных вы указали Amazon Resource Name (ARN) таблицы, в ответе вы увидите ARN таблицы.

CapacityUnits -> (двойное)

Общее количество единиц пропускной способности, потребленных операцией.

ReadCapacityUnits -> (двойное)

Общее количество единиц пропускной способности чтения, потребленных операцией.

WriteCapacityUnits -> (двойное)

Общее количество единиц пропускной способности записи, потребленных операцией.

Table -> (структура)

Количество пропускной способности, потребленной таблицей, затронутой операцией.

ReadCapacityUnits -> (двойное)

Общее количество единиц пропускной способности чтения, потребленных в таблице или индексе.

WriteCapacityUnits -> (двойное)

Общее количество единиц пропускной способности записи, потребленных в таблице или индексе.

CapacityUnits -> (двойное)

Общее количество единиц пропускной способности, потребленных в таблице или индексе.

LocalSecondaryIndexes -> (карта)

Количество пропускной способности, потребленной каждым локальным индексом, затронутым операцией.

key -> (строка)

value -> (структура)

Представляет собой количество выделенной пропускной способности, потребленной таблицей или индексом.

ReadCapacityUnits -> (двойное)

Общее количество единиц пропускной способности чтения, потребленных в таблице или индексе.

WriteCapacityUnits -> (двойное)

Общее количество единиц пропускной способности записи, потребленных в таблице или индексе.

CapacityUnits -> (двойное)

Общее количество единиц пропускной способности, потребленных в таблице или индексе.

GlobalSecondaryIndexes -> (карта)

Количество пропускной способности, потребленной каждым глобальным индексом, затронутым операцией.

key -> (строка)

value -> (структура)

Представляет собой количество выделенной пропускной способности, потребленной таблицей или индексом.

ReadCapacityUnits -> (двойное)

Общее количество единиц пропускной способности чтения, потребленных в таблице или индексе.

WriteCapacityUnits -> (двойное)

Общее количество единиц пропускной способности записи, потребленных в таблице или индексе.

CapacityUnits -> (двойное)

Общее количество единиц пропускной способности, потребленных в таблице или индексе.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API