list-domains

Описание

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

Вы можете использовать политики IAM для управления доступом к ресурсам Amazon SWF следующим образом:

• Используйте элемент Resource с именем домена, чтобы ограничить действие только указанными доменами. Элемент должен быть установлен на arn:aws:swf::AccountID:domain/* , где AccountID — идентификатор аккаунта без дефисов.
• Используйте элемент Action, чтобы разрешить или запретить разрешение на вызов этой операции.
• Вы не можете использовать политику IAM для ограничения параметров этой операции.

Если у вызывающего субъекта недостаточно разрешений для вызова операции или значения параметров не соответствуют указанным ограничениям, операция завершается с ошибкой. Соответствующий атрибут события имеет параметр cause, установленный на значение OPERATION_NOT_PERMITTED. Подробности и примеры политик IAM см. в руководстве Amazon SWF Developer Guide, раздел Использование IAM для управления доступом к Amazon SWF Workflows.

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

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

Синтаксис

  list-domains
--registration-status <value>
[--reverse-order | --no-reverse-order]
[--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]

Параметры

--registration-status (строка)

--reverse-order | --no-reverse-order (булево)

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

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

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

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

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение null или 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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Пример 1: Перечисление зарегистрированных доменов

Следующий list-domains пример команды перечисляет REGISTERED домены SWF, зарегистрированные для вашего аккаунта.

aws swf list-domains \
    --registration-status REGISTERED

Вывод:

{
  "domainInfos": [
    {
      "status": "REGISTERED",
      "name": "DataFrobotz"
    },
    {
      "status": "REGISTERED",
      "name": "erontest"
    }
  ]
}

Дополнительную информацию см. в разделе ListDomains в Справочнике по API Amazon Simple Workflow Service

Пример 2: Перечисление устаревших доменов

Следующий list-domains пример команды перечисляет DEPRECATED домены SWF, зарегистрированные для вашего аккаунта. Устаревшие домены — это домены, которые не могут регистрировать новые рабочие процессы или задачи, но которые по-прежнему могут быть запрошены.

aws swf list-domains \
    --registration-status DEPRECATED

Вывод:

{
  "domainInfos": [
    {
      "status": "DEPRECATED",
      "name": "MyNeatNewDomain"
    }
  ]
}

Дополнительную информацию см. в разделе ListDomains в Справочнике по API Amazon Simple Workflow Service

Пример 3: Перечисление первой страницы зарегистрированных доменов

Следующий list-domains пример команды перечисляет первую страницу REGISTERED доменов SWF, зарегистрированных для вашего аккаунта, используя параметр --maximum-page-size.

aws swf list-domains \
    --registration-status REGISTERED \
    --maximum-page-size 1

Вывод:

{
    "domainInfos": [
        {
            "status": "REGISTERED",
            "name": "DataFrobotz"
        }
    ],
"nextPageToken": "AAAAKgAAAAEAAAAAAAAAA2QJKNtidVgd49TTeNwYcpD+QKT2ynuEbibcQWe2QKrslMGe63gpS0MgZGpcpoKttL4OCXRFn98Xif557it+wSZUsvUDtImjDLvguyuyyFdIZtvIxIKEOPm3k2r4OjAGaFsGOuVbrKljvla7wdU7FYH3OlkNCP8b7PBj9SBkUyGoiAghET74P93AuVIIkdKGtQ=="
}

Дополнительную информацию см. в разделе ListDomains в Справочнике по API Amazon Simple Workflow Service

Пример 4: Перечисление определенной страницы зарегистрированных доменов

Следующий list-domains пример команды перечисляет первую страницу REGISTERED доменов SWF, зарегистрированных для вашего аккаунта, используя параметр --maximum-page-size.

При повторном вызове, но в этот раз передав значение nextPageToken в аргументе --next-page-token, вы получите другую страницу результатов.

aws swf list-domains \
    --registration-status REGISTERED \
    --maximum-page-size 1 \
    --next-page-token "AAAAKgAAAAEAAAAAAAAAA2QJKNtidVgd49TTeNwYcpD+QKT2ynuEbibcQWe2QKrslMGe63gpS0MgZGpcpoKttL4OCXRFn98Xif557it+wSZUsvUDtImjDLvguyuyyFdIZtvIxIKEOPm3k2r4OjAGaFsGOuVbrKljvla7wdU7FYH3OlkNCP8b7PBj9SBkUyGoiAghET74P93AuVIIkdKGtQ=="

Вывод:

{
    "domainInfos": [
        {
            "status": "REGISTERED",
            "name": "erontest"
        }
    ]
}

Когда больше страниц результатов для извлечения нет, nextPageToken не будет возвращено в результатах.

Дополнительную информацию см. в разделе ListDomains в Справочнике по API Amazon Simple Workflow Service

Вывод

domainInfos -> (список)

nextPageToken -> (строка)