Spec-Zone.ru › AWS CLI v2

[ aws . datasync ]

list-locations

Описание

Возвращает список источников и целевых расположений.

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

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

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

Синтаксис

  list-locations
[--filters <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]

Параметры

--filters (список)

Вы можете использовать фильтры API для сужения списка ресурсов, возвращаемых ListLocations . Например, для получения всех задач в определённом источнике расположения, вы можете использовать ListLocations с именем фильтра LocationType S3 и Operator Equals .

(структура)

Сузить список ресурсов, возвращаемых ListLocations . Например, чтобы увидеть все ваши расположения Amazon S3, создайте фильтр, используя "Name": "LocationType" , "Operator": "Equals" и "Values": "S3" .

Дополнительную информацию см. в разделе фильтрации ресурсов.

Имя -> (строка)

Имя используемого фильтра. Каждый вызов API поддерживает список фильтров, доступных для него (например, LocationType для ListLocations ).

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

Значения, для которых вы хотите отфильтровать. Например, вы можете отобразить только расположения Amazon S3.

(строка)

Оператор -> (строка)

Оператор, используемый для сравнения значений фильтров (например, Equals или Contains ).

Сокращённый синтаксис:

Name=string,Values=string,string,Operator=string ...

Синтаксис JSON:

[
  {
    "Name": "LocationUri"|"LocationType"|"CreationTime",
    "Values": ["string", ...],
    "Operator": "Equals"|"NotEquals"|"In"|"LessThanOrEqual"|"LessThan"|"GreaterThanOrEqual"|"GreaterThan"|"Contains"|"NotContains"|"BeginsWith"
  }
  ...
]

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

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

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

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

Вывод

Расположения -> (список)

Массив, содержащий список расположений.

(структура)

Представляет одну запись в списке расположений. LocationListEntry возвращает массив, содержащий список расположений, когда вызывается операция ListLocations.

LocationArn -> (строка)

Amazon Resource Name (ARN) расположения. Для Network File System (NFS) или Amazon EFS расположением является путь к экспорту. Для Amazon S3 расположением является префиксный путь, который вы хотите смонтировать и использовать в качестве корня расположения.

LocationUri -> (строка)

Представляет список URI расположения. LocationUri возвращает массив, содержащий список расположений, когда вызывается операция ListLocations.

Формат: TYPE://GLOBAL_ID/SUBDIR.

TYPE указывает тип расположения (например, nfs или s3).

GLOBAL_ID — глобально уникальный идентификатор ресурса, на котором основано расположение. Например, для EFS это us-east-2.fs-abcd1234. Например, для Amazon S3 — имя ведра, такое как myBucket. Например, для NFS — допустимый IPv4-адрес или имя хоста, соответствующее службе доменных имён (DNS).

SUBDIR — допустимый путь к файловой системе, разделяемый слэшами, как и в соглашении *nix. Для NFS и Amazon EFS это путь к экспорту для монтирования расположения. Для Amazon S3 это префиксный путь, который вы монтируете и рассматриваете как корень расположения.

NextToken -> (строка)

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

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

Spec-Zone.ru

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