Spec-Zone.ru › AWS CLI v2

[ aws . machinelearning ]

describe-data-sources

Описание

Возвращает список DataSource, соответствующих критериям поиска в запросе.

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

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

Синтаксис

  describe-data-sources
[--filter-variable <value>]
[--eq <value>]
[--gt <value>]
[--lt <value>]
[--ge <value>]
[--le <value>]
[--ne <value>]
[--prefix <value>]
[--sort-order <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]

Параметры

--filter-variable (строка)

Используйте одну из следующих переменных для фильтрации списка DataSource :

  • CreatedAt — Устанавливает критерии поиска на даты создания DataSource.
  • Status — Устанавливает критерии поиска на статусы DataSource.
  • Name — Устанавливает критерии поиска на содержимое DataSource Name.
  • DataUri — Устанавливает критерии поиска на URI файлов данных, используемых для создания DataSource. URI может указывать на файл или на Amazon Simple Storage Service (Amazon S3) ведро или директорию.
  • IAMUser — Устанавливает критерии поиска на учетную запись пользователя, которая инициировала создание DataSource.

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

  • CreatedAt
  • LastUpdatedAt
  • Status
  • Name
  • DataLocationS3
  • IAMUser

--eq (строка)

Оператор равенства. Результаты DataSource будут иметь значения FilterVariable, которые точно соответствуют значению, указанному с помощью EQ.

--gt (строка)

Оператор больше. Результаты DataSource будут иметь значения FilterVariable, которые больше значения, указанного с помощью GT.

--lt (строка)

Оператор меньше. Результаты DataSource будут иметь значения FilterVariable, которые меньше значения, указанного с помощью LT.

--ge (строка)

Оператор больше или равно. Результаты DataSource будут иметь значения FilterVariable, которые больше или равны значению, указанному с помощью GE.

--le (строка)

Оператор меньше или равно. Результаты DataSource будут иметь значения FilterVariable, которые меньше или равны значению, указанному с помощью LE.

--ne (строка)

Оператор не равно. Результаты DataSource будут иметь значения FilterVariable, не равные значению, указанному с помощью NE.

--prefix (строка)

Строка, которая находится в начале переменной, например, Name или Id.

Например, у DataSource может быть Name 2014-09-09-HolidayGiftMailer. Для поиска этого DataSource выберите Name для FilterVariable и любые из следующих строк для Prefix:

  • 2014-09
  • 2014-09-09
  • 2014-09-09-Holiday

--sort-order (строка)

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

  • asc — Упорядочивает список по возрастанию (А-Я, 0-9).
  • dsc — Упорядочивает список по убыванию (Я-А, 9-0).

Результаты сортируются по FilterVariable.

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

  • asc
  • dsc

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

Результаты -> (список)

Список DataSource, удовлетворяющих критериям поиска.

(структура)

Представляет результат операции GetDataSource.

Содержит подробные метаданные и информацию о файлах данных, а также текущий статус DataSource.

DataSourceId -> (строка)

Идентификатор, присвоенный DataSource во время создания.

DataLocationS3 -> (строка)

Расположение и имя данных в Amazon Simple Storage Service (Amazon S3), используемых DataSource.

DataRearrangement -> (строка)

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

CreatedByIamUser -> (строка)

AWS учётная запись пользователя, из которой был создан DataSource. Тип учётной записи может быть либо корневой учётной записью AWS, либо учётной записью пользователя AWS Identity and Access Management (IAM).

CreatedAt -> (метка времени)

Время создания DataSource. Время выражено в формате эпохи.

LastUpdatedAt -> (метка времени)

Время последнего изменения BatchPrediction. Время выражено в формате эпохи.

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

Общее количество наблюдений, содержащихся в файлах данных, на которые ссылается DataSource.

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

Количество файлов данных, на которые ссылается DataSource.

Name -> (строка)

Указанное пользователем имя или описание DataSource.

Status -> (строка)

Текущий статус DataSource. Элемент может принимать одно из следующих значений:

  • PENDING - Amazon Machine Learning (Amazon ML) отправил запрос на создание DataSource.
  • INPROGRESS - Процесс создания выполняется.
  • FAILED - Запрос на создание DataSource не был завершён. Он непригоден для использования.
  • COMPLETED - Процесс создания завершён успешно.
  • DELETED - DataSource помечен как удалённый. Он непригоден для использования.

Message -> (строка)

Описание последних подробностей о создании DataSource.

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

Описание деталей DataSource, специфичных для Amazon Redshift.

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

Описание деталей базы данных, необходимых для подключения к базе данных Amazon Redshift.

DatabaseName -> (строка)

Имя базы данных, размещённой в кластере Amazon Redshift.

ClusterIdentifier -> (строка)

Идентификатор кластера Amazon Redshift.

DatabaseUserName -> (строка)

Имя пользователя, которое будет использоваться Amazon Machine Learning (Amazon ML) для подключения к базе данных в кластере Amazon Redshift. Имя пользователя должно иметь достаточные разрешения для выполнения запроса RedshiftSelectSqlQuery. Имя пользователя должно быть валидным для пользователя Amazon Redshift.

SelectSqlQuery -> (строка)

SQL запрос, указанный при CreateDataSourceFromRedshift. Возвращается только если Verbose имеет значение true в GetDataSourceInput.

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

Подробности источника данных, специфичные для Amazon RDS.

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

Подробности базы данных, необходимые для подключения к Amazon RDS.

InstanceIdentifier -> (строка)

Идентификатор экземпляра базы данных RDS.

DatabaseName -> (строка)

Имя базы данных, размещённой в экземпляре базы данных RDS.

DatabaseUserName -> (строка)

Имя пользователя, которое будет использоваться Amazon ML для подключения к базе данных в экземпляре Amazon RDS. Имя пользователя должно иметь достаточные разрешения для выполнения запроса RDSSelectSqlQuery.

SelectSqlQuery -> (строка)

SQL запрос, предоставленный при CreateDataSourceFromRDS. Возвращается только если Verbose имеет значение true в GetDataSourceInput.

ResourceRole -> (строка)

Роль (DataPipelineDefaultResourceRole), принимаемая экземпляром Amazon EC2 для выполнения задачи копирования данных из Amazon RDS в Amazon S3. Дополнительную информацию можно найти в разделе Шаблоны ролей для конвейеров данных.

ServiceRole -> (строка)

Роль (DataPipelineDefaultRole), принимаемая службой Data Pipeline для мониторинга выполнения задачи копирования данных из Amazon RDS в Amazon S3. Дополнительную информацию можно найти в разделе Шаблоны ролей для конвейеров данных.

DataPipelineId -> (строка)

Идентификатор экземпляра Data Pipeline, используемого для копирования данных из Amazon RDS в Amazon S3. Идентификатор можно использовать для получения подробностей об экземпляре в консоли Data Pipeline.

RoleARN -> (строка)

Amazon Resource Name (ARN) роли AWS IAM, например: arn:aws:iam::account:role/rolename.

ComputeStatistics -> (булево)

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

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

Целое число типа long — 64-битное знаковое число.

FinishedAt -> (метка времени)

Метка времени, представленная в формате эпохи.

StartedAt -> (метка времени)

Метка времени, представленная в формате эпохи.

NextToken -> (строка)

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

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

Spec-Zone.ru

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