Spec-Zone.ru › AWS CLI v2

[ aws . appsync ]

list-data-sources

Описание

Перечисляет источники данных для заданного API.

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

list-data-sources — это операция с постраничной загрузкой. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничную загрузку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной загрузкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: dataSources

Синтаксис

  list-data-sources
--api-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--api-id (строка)

Идентификатор API.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения перепишут значения, предоставленные через JSON. Невозможно передать произвольные двоичные значения, используя значение, предоставленное через JSON, так как строка будет интерпретироваться буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Маркер для указания точки начала постраничной загрузки. Это NextToken из ранее обрезаного ответа.

Примеры использования см. в разделе «Постраничная загрузка» в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

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

Примеры использования см. в разделе «Постраничная загрузка» в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной загрузки предоставьте значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе «Постраничная загрузка» в Руководстве пользователя AWS Command Line Interface.

--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 (строка)

Переопределить URL по умолчанию команды заданным 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.

Вывод

dataSources -> (список)

Объекты DataSource.

(структура)

Описывает источник данных.

dataSourceArn -> (строка)

Amazon Resource Name (ARN) источника данных.

name -> (строка)

Имя источника данных.

description -> (строка)

Описание источника данных.

type -> (строка)

Тип источника данных.

  • AWS_LAMBDA : Источник данных — функция Lambda.
  • AMAZON_DYNAMODB : Источник данных — таблица Amazon DynamoDB.
  • AMAZON_ELASTICSEARCH : Источник данных — домен Amazon OpenSearch Service.
  • AMAZON_OPENSEARCH_SERVICE : Источник данных — домен Amazon OpenSearch Service.
  • AMAZON_EVENTBRIDGE : Источник данных — конфигурация Amazon EventBridge.
  • AMAZON_BEDROCK_RUNTIME : Источник данных — Amazon Bedrock runtime.
  • NONE : Источника данных нет. Используйте этот тип, когда вы хотите вызвать операцию GraphQL без подключения к источнику данных, например, когда выполняете преобразование данных с помощью решателей или вызываете подписку из мутации.
  • HTTP : Источник данных — HTTP-точка входа.
  • RELATIONAL_DATABASE : Источник данных — реляционная база данных.

serviceRoleArn -> (строка)

Amazon Resource Name (ARN) роли службы управления доступом и идентификацией (IAM) для источника данных. Система принимает на себя эту роль при доступе к источнику данных.

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

Настройки DynamoDB.

tableName -> (строка)

Имя таблицы.

awsRegion -> (строка)

Регион Amazon Web Services.

useCallerCredentials -> (булево)

Установите в значение TRUE, чтобы использовать учетные данные Amazon Cognito с этим источником данных.

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

DeltaSyncConfig для версиированного источника данных.

baseTableTTL -> (целое число)

Количество минут, в течение которых элемент хранится в источнике данных.

deltaSyncTableName -> (строка)

Имя таблицы Delta Sync.

deltaSyncTableTTL -> (целое число)

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

versioned -> (булево)

Установите в значение TRUE, чтобы использовать обнаружение и разрешение конфликтов с этим источником данных.

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

Настройки Lambda.

lambdaFunctionArn -> (строка)

Amazon Resource Name (ARN) функции Lambda.

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

Настройки Amazon OpenSearch Service.

endpoint -> (строка)

Точка входа.

awsRegion -> (строка)

Регион Amazon Web Services.

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

Настройки Amazon OpenSearch Service.

endpoint -> (строка)

Точка входа.

awsRegion -> (строка)

Регион Amazon Web Services.

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

Настройки HTTP-точки входа.

endpoint -> (строка)

HTTP-URL-адрес точки входа. Вы можете указать либо доменное имя, либо комбинацию IP-адреса и порта. Схема URL должна быть HTTP или HTTPS. Если порт не указан, AppSync использует порт 80 для HTTP-точки входа и порт 443 для HTTPS-точек входа.

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

Настройка авторизации, если HTTP-точка входа требует авторизации.

authorizationType -> (строка)

Тип авторизации, необходимый для HTTP-точки входа.

  • AWS_IAM : Тип авторизации — Signature Version 4 (SigV4).

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

Настройки управления доступом и идентификацией (IAM).

signingRegion -> (строка)

Регион Amazon Web Services для подписи авторизации IAM.

signingServiceName -> (строка)

Имя службы подписи для авторизации IAM.

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

Настройки реляционной базы данных.

relationalDatabaseSourceType -> (строка)

Тип источника для реляционной базы данных.

  • RDS_HTTP_ENDPOINT : Тип источника реляционной базы данных — HTTP-точка входа Amazon Relational Database Service (Amazon RDS).

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

Настройки HTTP-точки входа Amazon RDS.

awsRegion -> (строка)

Регион Amazon Web Services для HTTP-точки входа Amazon RDS.

dbClusterIdentifier -> (строка)

Amazon Resource Name (ARN) кластера Amazon RDS.

databaseName -> (строка)

Имя логической базы данных.

schema -> (строка)

Имя логической схемы.

awsSecretStoreArn -> (строка)

Amazon Resource Name (ARN) хранилища секретов Amazon Web Services для учетных данных базы данных.

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

Настройки Amazon EventBridge.

eventBusArn -> (строка)

ARN шины событий. Дополнительная информация о шинах событий находится в разделе Amazon EventBridge event buses.

metricsConfig -> (строка)

Включает или выключает расширенные метрики источника данных для указанных источников данных. Обратите внимание, что metricsConfig не будет использоваться, если значение dataSourceLevelMetricsBehavior установлено в PER_DATA_SOURCE_METRICS. Если значение dataSourceLevelMetricsBehavior установлено в FULL_REQUEST_DATA_SOURCE_METRICS, то metricsConfig будет проигнорировано. Однако вы всё равно можете установить его значение.

metricsConfig может быть ENABLED или DISABLED .

nextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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