validate-flow-definition

Описание

Проверяет определение потока.

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

validate-flow-definition использует значения типов документов. Типы документов следуют модели данных JSON, где допустимые значения: строки, числа, булевы значения, null, массивы и объекты. Для входных данных команд, опций и вложенных параметров, помеченных типом document, необходимо указать JSON. Краткая синтаксическая запись не поддерживает типы документов.

Синтаксис

  validate-flow-definition
--definition <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]

Опции

--definition (структура)

Определение потока для проверки.

connections -> (список)

Массив определений соединений в потоке.

(структура)

Содержит информацию о соединении между двумя узлами в потоке.

configuration -> (структура помеченного союза)

Настройка соединения.

Примечание

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

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

Настройка соединения, исходящего из узла Условия.

condition -> (строка)

Условие, которое запускает это соединение. Для получения дополнительной информации о написании условий см. тип узла Condition в разделе Типы узлов в руководстве пользователя Amazon Bedrock.

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

Настройка соединения, исходящего из узла, который не является узлом Условия.

sourceOutput -> (строка)

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

targetInput -> (строка)

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

name -> (строка)

Имя соединения, которое можно использовать для ссылки.

source -> (строка)

Узел, с которого начинается соединение.

target -> (строка)

Узел, в котором заканчивается соединение.

type -> (строка)

Является ли узел источника, с которого начинается соединение, узлом условия (Conditional ) или нет (Data ).

nodes -> (список)

Массив определений узлов в потоке.

(структура)

Содержит настройки узла в потоке.

configuration -> (структура помеченного объединения)

Содержит настройки узла.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан: agent, collector, condition, inlineCode, input, iterator, knowledgeBase, lambdaFunction, lex, loop, loopController, loopInput, output, prompt, retrieval, storage.

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

Содержит настройки узла агента в вашем потоке. Вызывает псевдоним агента и возвращает ответ.

agentAliasArn -> (строка)

Идентификатор ресурса Amazon (ARN) псевдонима агента для вызова.

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

Содержит настройки узла сбора в вашем потоке. Сбор итерации входов и объединение их в массив выходов.

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

Содержит настройки узла условия в вашем потоке. Определяет условия, ведущие к различным ветвям потока.

conditions -> (список)

Массив условий. Каждый элемент содержит имя условия и выражение, определяющее условие.

(структура)

Определяет условие в узле условия.

expression -> (строка)

Определяет условие. Вы должны сделать ссылку хотя бы на один из входов в условии. Для получения дополнительной информации, разверните раздел Узел условия в разделах Типы узлов в потоках запросов.

name -> (строка)

Имя условия, на которое можно сослаться.

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

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

code -> (строка)

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

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

language -> (строка)

Язык программирования, используемый узлом встроенного кода.

Код должен быть валидным на языке программирования language, который вы указали. В настоящее время поддерживается только Python 3 (Python_3).

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

Содержит настройки узла входного потока в вашем потоке. Первый узел в потоке. inputs не может быть указан для этого узла.

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

Содержит настройки узла итератора в вашем потоке. Принимает вход, который является массивом, и итеративно отправляет каждый элемент массива в качестве вывода следующему узлу. Размер массива также возвращается в выводе.

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

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

Содержит настройки узла базы знаний в вашем потоке. Запрашивает базу знаний и возвращает полученные результаты или сгенерированный ответ.

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

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

guardrailIdentifier -> (строка)

Уникальный идентификатор барьера.

guardrailVersion -> (строка)

Версия барьера.

inferenceConfiguration -> (структура помеченного объединения)

Содержит конфигурации вывода для подсказки.

Примечание

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

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

Содержит конфигурации вывода для текстовой подсказки.

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

Максимальное количество токенов для возврата в ответе.

stopSequences -> (список)

Список строк, определяющих последовательности, после которых модель прекратит генерирование.

(строка)

temperature -> (вещественное число)

Управляет случайностью ответа. Выберите меньшее значение для более предсказуемых выходов и большее значение для более неожиданных выходов.

topP -> (вещественное число)

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

knowledgeBaseId -> (строка)

Уникальный идентификатор базы знаний для запроса.

modelId -> (строка)

Уникальный идентификатор модели или профиля вывода для использования для генерации ответа из результатов запроса. Опустите этот параметр, если вы хотите вернуть полученные результаты в виде массива.

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

Количество результатов для извлечения из базы знаний.

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

Конфигурация для организации процесса извлечения и генерации в узле базы знаний.

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

Дополнительные параметры запроса, специфичные для модели, в виде пар ключ-значение, которые должны быть включены в запрос к основной модели.

key -> (строка)

value -> (документ)

inferenceConfig -> (структура помеченного объединения)

Содержит конфигурации вывода для подсказки.

Примечание

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

Содержит конфигурации вывода для текстовой подсказки.

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

Максимальное количество токенов для возврата в ответе.

stopSequences -> (список)

Список строк, определяющих последовательности, после которых модель прекратит генерирование.

(строка)

temperature -> (вещественное число)

topP -> (вещественное число)

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

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

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

latency -> (строка)

Настройка оптимизации задержки.

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

Пользовательская шаблон подсказки для организации процесса извлечения и генерации.

textPromptTemplate -> (строка)

Текст шаблона подсказки.

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

Пользовательский шаблон подсказки для использования с базой знаний для генерации ответов.

textPromptTemplate -> (строка)

Текст шаблона подсказки.

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

Конфигурация для переупорядочения извлеченных результатов из базы знаний для повышения релевантности.

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

Указывает конфигурацию для использования модели переупорядочения Amazon Bedrock для переупорядочения извлеченных результатов.

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

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

selectionMode -> (строка)

Режим выбора полей метаданных для переупорядочения.

selectiveModeConfiguration -> (структура помеченного объединения)

Конфигурация для включения или исключения полей метаданных при переупорядочении.

Примечание

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

fieldsToExclude -> (список)

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

(структура)

Указывает поле метаданных для включения или исключения во время переупорядочения.

fieldName -> (строка)

Имя поля метаданных для включения или исключения во время переупорядочения.

fieldsToInclude -> (список)

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

(структура)

Указывает поле метаданных для включения или исключения во время переупорядочения.

fieldName -> (строка)

Имя поля метаданных для включения или исключения во время переупорядочения.

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

Указывает конфигурацию для модели переупорядочения Amazon Bedrock.

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

Указывает дополнительные параметры запроса, специфичные для модели, в виде пар ключ-значение, которые включаются в запрос к модели переупорядочения Amazon Bedrock.

key -> (строка)

value -> (документ)

modelArn -> (строка)

Идентификатор ресурса Amazon (ARN) модели переупорядочения Amazon Bedrock.

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

Указывает количество результатов, которые нужно вернуть после переупорядочения.

type -> (строка)

Указывает тип модели переупорядочения. В настоящее время единственное поддерживаемое значение - BEDROCK_RERANKING_MODEL.

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

Содержит конфигурации для узла функции Lambda в вашем потоке. Вызывает функцию Lambda.

lambdaArn -> (строка)

Идентификатор ресурса Amazon (ARN) вызываемой функции Lambda.

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

Содержит конфигурации для узла Lex в вашем потоке. Вызывает бота Amazon Lex, чтобы определить намерение ввода и вернуть намерение в качестве вывода.

botAliasArn -> (строка)

Идентификатор ресурса Amazon (ARN) псевдонима бота Amazon Lex для вызова.

localeId -> (строка)

Регион для вызова бота Amazon Lex.

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

Содержит конфигурации для цикла DoWhile в вашем потоке.

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

Определение узлов цикла DoWhile и соединений между узлами в потоке.

connections -> (список)

Массив определений соединений в потоке.

(структура)

Содержит информацию о соединении между двумя узлами в потоке.

configuration -> (структура помеченного объединения)

Конфигурация соединения.

Примечание

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

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

Конфигурация соединения, исходящего из узла Условия.

condition -> (строка)

Условие, которое запускает это соединение. Дополнительную информацию о написании условий см. в разделе тип узла Условие в теме Типы узлов в Руководстве пользователя Amazon Bedrock.

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

Конфигурация соединения, исходящего из узла, который не является узлом Условия.

sourceOutput -> (строка)

Имя выходного параметра в исходном узле, с которого начинается соединение.

targetInput -> (строка)

Имя входного параметра в целевом узле, в котором заканчивается соединение.

name -> (строка)

Имя соединения, которое можно использовать для ссылки.

source -> (строка)

Узел, с которого начинается соединение.

target -> (строка)

Узел, в котором заканчивается соединение.

type -> (строка)

Является ли исходный узел, с которого начинается соединение, узлом условия (Conditional ) или нет (Data ).

nodes -> (список)

Массив определений узлов в потоке.

(структура)

Содержит конфигурации об узле в потоке.

configuration -> (структура помеченного объединения)

Содержит конфигурации для узла.

Примечание

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

Содержит конфигурации для узла агента в вашем потоке. Вызывает псевдоним агента и возвращает ответ.

agentAliasArn -> (строка)

Идентификатор ресурса Amazon (ARN) псевдонима агента, который нужно вызвать.

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

Содержит конфигурации для узла коллектора в вашем потоке. Сбор итераций входов и их консолидация в массив выходов.

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

Содержит конфигурации для узла условия в вашем потоке. Определяет условия, которые приводят к различным ветвям потока.

conditions -> (список)

Массив условий. Каждый элемент содержит имя условия и выражение, определяющее условие.

(структура)

Определяет условие в узле условия.

expression -> (строка)

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

name -> (строка)

Имя условия, которое можно использовать для ссылки.

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

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

code -> (строка)

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

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

language -> (строка)

Язык программирования, используемый узлом встраиваемого кода.

Код должен быть допустимым на языке программирования language, который вы указали. В настоящее время поддерживается только Python 3 (Python_3).

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

Содержит конфигурации для узла входного потока в вашем потоке. Первый узел в потоке. inputs не может быть указан для этого узла.

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

Содержит конфигурации для узла итератора в вашем потоке. Принимает входной массив и итеративно отправляет каждый элемент массива в качестве выходных данных следующему узлу. Размер массива также возвращается в выходных данных.

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

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

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

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

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

guardrailIdentifier -> (строка)

Уникальный идентификатор барьера.

guardrailVersion -> (строка)

Версия барьера.

inferenceConfiguration -> (структура помеченного объединения)

Содержит конфигурации вывода для подсказки.

Примечание

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

Содержит конфигурации вывода для текстовой подсказки.

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

Максимальное количество маркеров для возврата в ответе.

stopSequences -> (список)

Список строк, определяющих последовательности, после которых модель прекратит генерацию.

(строка)

temperature -> (вещественное число)

Управляет случайностью ответа. Выберите меньшее значение для более предсказуемых результатов и большее значение для более неожиданных результатов.

topP -> (вещественное число)

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

knowledgeBaseId -> (строка)

Уникальный идентификатор базы знаний для запроса.

modelId -> (строка)

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

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

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

Конфигурация для организации процесса извлечения и генерации в узле базы знаний.

additionalModelRequestFields -> (карта)

Дополнительные параметры запроса, специфичные для модели, в виде пар «ключ-значение», которые нужно включить в запрос к основной модели.

key -> (строка)

value -> (документ)

inferenceConfig -> (структура помеченного объединения)

Содержит конфигурации вывода для подсказки.

Примечание

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

Содержит конфигурации вывода для текстовой подсказки.

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

Максимальное количество маркеров для возврата в ответе.

stopSequences -> (список)

Список строк, определяющих последовательности, после которых модель прекратит генерацию.

(строка)

temperature -> (вещественное число)

topP -> (вещественное число)

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

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

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

latency -> (строка)

Настройка оптимизации задержки.

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

Пользовательская шаблон подсказки для организации процесса извлечения и генерации.

textPromptTemplate -> (строка)

Текст шаблона подсказки.

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

Пользовательский шаблон подсказки для использования с базой знаний для генерации ответов.

textPromptTemplate -> (строка)

Текст шаблона подсказки.

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

Конфигурация для переупорядочивания полученных результатов из базы знаний для повышения релевантности.

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

Указывает конфигурацию для использования модели переупорядочивания Amazon Bedrock для переупорядочивания полученных результатов.

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

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

selectionMode -> (строка)

Режим выбора полей метаданных для переупорядочивания.

selectiveModeConfiguration -> (структура помеченного объединения)

Конфигурация для включения или исключения полей метаданных во время переупорядочивания.

Примечание

fieldsToExclude -> (список)

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

(структура)

Указывает поле метаданных для включения или исключения во время переупорядочивания.

fieldName -> (строка)

Имя поля метаданных для включения или исключения во время переупорядочивания.

fieldsToInclude -> (список)

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

(структура)

Указывает поле метаданных для включения или исключения во время переупорядочивания.

fieldName -> (строка)

Имя поля метаданных для включения или исключения во время переупорядочивания.

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

Указывает конфигурацию для модели переупорядочивания Amazon Bedrock.

additionalModelRequestFields -> (карта)

Указывает дополнительные параметры запроса, специфичные для модели, в виде пар «ключ-значение», которые включаются в запрос к модели переупорядочивания Amazon Bedrock.

key -> (строка)

value -> (документ)

modelArn -> (строка)

Идентификатор ресурса Amazon (ARN) модели переупорядочивания Amazon Bedrock.

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

Указывает количество результатов, которые нужно вернуть после переупорядочивания.

type -> (строка)

Указывает тип модели переупорядочивания. В настоящее время поддерживается только значение BEDROCK_RERANKING_MODEL.

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

Содержит конфигурации для узла функции Lambda в вашем потоке. Вызывает функцию Lambda.

lambdaArn -> (строка)

Идентификатор ресурса Amazon (ARN) функции Lambda, которую нужно вызвать.

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

Содержит конфигурации для узла Lex в вашем потоке. Вызывает бота Amazon Lex, чтобы определить намерение входных данных и вернуть намерение в качестве выходных данных.

botAliasArn -> (строка)

Идентификатор ресурса Amazon (ARN) псевдонима бота Amazon Lex, который нужно вызвать.

localeId -> (строка)

Регион для вызова бота Amazon Lex.

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

Содержит конфигурации для цикла DoWhile в вашем потоке.

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

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

Содержит конфигурации контроллера узла для цикла DoWhile в вашем потоке.

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

Указывает условие, которое определяет, когда поток выходит из цикла DoWhile. Цикл выполняется до тех пор, пока это условие не примет значение true.

expression -> (строка)

name -> (строка)

Имя условия, которое можно использовать для ссылки.

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

Указывает максимальное количество итераций цикла DoWhile, после которого поток выходит из цикла.

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

Содержит конфигурации узла ввода для цикла DoWhile в вашем потоке.

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

Содержит конфигурации для узла выходного потока в вашем потоке. Последний узел в потоке. outputs не может быть указан для этого узла.

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

Содержит конфигурации для узла запроса в вашем потоке. Выполняет запрос и генерирует ответ модели в качестве выходных данных. Вы можете использовать запрос из управления запросами или настроить его в этом узле.

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

Содержит конфигурации для использования барьеров (guardrail) для применения к запросу в этом узле и ответу, сгенерированному по нему.

guardrailIdentifier -> (строка)

Уникальный идентификатор барьера (guardrail).

guardrailVersion -> (строка)

Версия барьера (guardrail).

sourceConfiguration -> (меченый союз структур)

Указывает, получен ли запрос из управления запросами или определен в строке.

Примечание

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

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

Содержит конфигурации для запроса, определенного в строке.

additionalModelRequestFields -> (документ)

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

inferenceConfiguration -> (меченый союз структур)

Содержит конфигурации вывода для запроса.

Примечание

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

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

Содержит конфигурации вывода для текстового запроса.

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

Максимальное количество токенов для возврата в ответе.

stopSequences -> (список)

Список строк, определяющих последовательности, после которых модель прекратит генерацию.

(строка)

temperature -> (число с плавающей точкой)

topP -> (число с плавающей точкой)

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

modelId -> (строка)

Уникальный идентификатор модели или профиля вывода для выполнения вывода.

templateConfiguration -> (меченый союз структур)

Содержит запрос и переменные в запросе, которые можно заменить значениями во время выполнения.

Примечание

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

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

Содержит конфигурации для использования запроса в диалоговом формате.

inputVariables -> (список)

Массив переменных в шаблоне запроса.

(структура)

Содержит информацию о переменной в запросе.

name -> (строка)

Имя переменной.

messages -> (список)

Содержит сообщения в чате для запроса.

(структура)

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

content -> (список)

Содержание сообщения.

(меченый союз структур)

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

Примечание

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

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

Создает контрольную точку кэша внутри сообщения.

type -> (строка)

Указывает, что CachePointBlock имеет тип по умолчанию

text -> (строка)

Текст в сообщении.

role -> (строка)

Роль, к которой принадлежит сообщение.

system -> (список)

Содержит системные запросы для предоставления контекста модели или описания ее поведения.

(меченый союз структур)

Содержит системный запрос для предоставления контекста модели или описания ее поведения. Дополнительную информацию см. в разделе Создать запрос с помощью управления запросами.

Примечание

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

Создает контрольную точку кэша внутри обозначения инструмента

type -> (строка)

Указывает, что CachePointBlock имеет тип по умолчанию

text -> (строка)

Текст в системном запросе.

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

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

toolChoice -> (меченый союз структур)

Определяет, какие инструменты модель должна запросить при вызове.

Примечание

Это структура помеченного союза. Только один из следующих верхнеуровневых ключей может быть установлен: any, auto, tool.

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

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

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

Определяет инструменты. Модель автоматически решает, вызывать ли инструмент или генерировать текст вместо этого.

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

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

name -> (строка)

Имя инструмента.

tools -> (список)

Массив инструментов, которые необходимо передать модели.

(меченый союз структур)

Содержит конфигурации для инструмента, который модель может использовать при генерации ответа. Дополнительную информацию см. в разделе Использовать инструмент для завершения ответа модели Amazon Bedrock.

Примечание

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

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

Создает контрольную точку кэша внутри обозначения инструмента

type -> (строка)

Указывает, что CachePointBlock имеет тип по умолчанию

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

Спецификация для инструмента.

description -> (строка)

Описание инструмента.

inputSchema -> (меченый союз структур)

Схема ввода для инструмента.

Примечание

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

json -> (документ)

Объект JSON, определяющий схему ввода для инструмента.

name -> (строка)

Имя инструмента.

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

Содержит конфигурации для текста в сообщении для запроса.

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

Контрольная точка кэша в конфигурации шаблона.

type -> (строка)

Указывает, что CachePointBlock имеет тип по умолчанию

inputVariables -> (список)

Массив переменных в шаблоне запроса.

(структура)

Содержит информацию о переменной в запросе.

name -> (строка)

Имя переменной.

text -> (строка)

Сообщение для запроса.

templateType -> (строка)

Тип шаблона запроса.

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

Содержит конфигурации для запроса из управления запросами.

promptArn -> (строка)

Amazon Resource Name (ARN) запроса из управления запросами.

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

Содержит конфигурации для узла извлечения в вашем потоке. Извлекает данные из расположения Amazon S3 и возвращает их в качестве выходных данных.

serviceConfiguration -> (меченый союз структур)

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

Примечание

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

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

Содержит конфигурации для расположения Amazon S3, из которого извлекаются данные для возврата в качестве выходных данных из узла.

bucketName -> (строка)

Имя ведра Amazon S3, из которого извлекаются данные.

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

Содержит конфигурации для узла хранения в вашем потоке. Хранит входные данные в расположении Amazon S3.

serviceConfiguration -> (меченый союз структур)

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

Примечание

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

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

Содержит конфигурации для расположения Amazon S3, в котором хранятся входные данные в узел.

bucketName -> (строка)

Имя ведра Amazon S3, в котором хранятся входные данные в узел.

inputs -> (список)

Массив объектов, каждый из которых содержит информацию об входных данных в узел.

(структура)

Содержит конфигурации для входных данных в узел Amazon Bedrock Flows.

category -> (строка)

Указывает, как входные данные передаются между итерациями в цикле DoWhile.

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

expression -> (строка)

Выражение, которое форматирует входные данные для узла. Объяснение создания выражений см. в разделе Выражения в потоках запросов в Amazon Bedrock.

name -> (строка)

Указывает имя для входных данных, которое можно использовать для ссылки.

type -> (строка)

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

name -> (строка)

Имя узла.

outputs -> (список)

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

(структура)

Содержит конфигурации для выходных данных из узла.

name -> (строка)

Имя выходных данных, которое можно использовать для ссылки.

type -> (строка)

Тип данных выходных данных. Если выходные данные не соответствуют этому типу во время выполнения, будет сгенерирована ошибка проверки.

type -> (строка)

Тип узла. Это значение должно совпадать с именем ключа, который вы предоставляете в конфигурации, указанной в поле FlowNodeConfiguration.

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

Содержит конфигурации узлов-контроллеров для цикла DoWhile в вашем потоке.

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

Указывает условие, определяющее, когда поток завершает цикл DoWhile. Цикл выполняется до тех пор, пока это условие не станет истинным.

expression -> (строка)

Определяет условие. Вы должны сослаться хотя бы на один из входов в условии. Для получения дополнительной информации разверните раздел Узел "Условие" в разделе Типы узлов в потоках запросов.

name -> (строка)

Имя условия, на которое можно сослаться.

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

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

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

Содержит конфигурации узлов ввода для цикла DoWhile в вашем потоке.

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

Содержит конфигурации узла вывода в вашем потоке. Последний узел в потоке. outputs для этого узла указать нельзя.

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

Содержит конфигурации узла запроса в вашем потоке. Выполняет запрос и генерирует ответ модели в качестве вывода. Вы можете использовать запрос из Управление запросами или настроить его в этом узле.

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

Содержит конфигурации для применения барьера к запросу в этом узле и ответу, сгенерированному из него.

guardrailIdentifier -> (строка)

Уникальный идентификатор барьера.

guardrailVersion -> (строка)

Версия барьера.

sourceConfiguration -> (меченый союз структур)

Указывает, получен ли запрос из Управления запросами или определен в строке.

Примечание

Это меченый союз структур. Только один из следующих верхнеуровневых ключей может быть задан: inline, resource.

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

Содержит конфигурации для запроса, определенного в строке

additionalModelRequestFields -> (документ)

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

inferenceConfiguration -> (меченый союз структур)

Содержит конфигурации вывода для запроса.

Примечание

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

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

Содержит конфигурации вывода для текстового запроса.

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

Максимальное количество токенов, возвращаемых в ответе.

stopSequences -> (список)

Список строк, определяющих последовательности, после которых модель прекратит генерацию.

(строка)

temperature -> (вещественное число)

topP -> (вещественное число)

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

modelId -> (строка)

Уникальный идентификатор модели или профиля вывода для выполнения вывода.

templateConfiguration -> (меченый союз структур)

Содержит запрос и переменные в запросе, которые можно заменить значениями во время выполнения.

Примечание

Это меченый союз структур. Только один из следующих верхнеуровневых ключей может быть задан: chat, text.

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

Содержит конфигурации для использования запроса в диалоговом формате.

inputVariables -> (список)

Массив переменных в шаблоне запроса.

(структура)

Содержит информацию о переменной в запросе.

name -> (строка)

Имя переменной.

messages -> (список)

Содержит сообщения в чате для запроса.

(структура)

Ввод сообщения или ответ от модели. Для получения дополнительной информации см. Создание запроса с помощью Управления запросами.

content -> (список)

Содержание сообщения.

(меченый союз структур)

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

Примечание

Это меченый союз структур. Только один из следующих верхнеуровневых ключей может быть задан: cachePoint, text.

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

Создает контрольную точку кэша в сообщении.

type -> (строка)

Указывает, что блок CachePoint имеет стандартный тип

text -> (строка)

Текст в сообщении.

role -> (строка)

Роль, к которой относится сообщение.

system -> (список)

Содержит системные запросы, чтобы предоставить контекст модели или описать, как она должна себя вести.

(меченый союз структур)

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

Примечание

Это меченый союз структур. Только один из следующих верхнеуровневых ключей может быть задан: cachePoint, text.

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

Создает контрольную точку кэша в обозначении инструмента.

type -> (строка)

Указывает, что блок CachePoint имеет стандартный тип

text -> (строка)

Текст в системном запросе.

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

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

toolChoice -> (меченый союз структур)

Определяет, какие инструменты должна запросить модель при вызове.

Примечание

Это меченый союз структур. Только один из следующих верхнеуровневых ключей может быть задан: any, auto, tool.

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

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

Определяет инструменты. Модель автоматически определяет, следует ли вызывать инструмент или сгенерировать текст вместо этого.

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

name -> (строка)

Имя инструмента.

tools -> (список)

Массив инструментов для передачи модели.

(меченый союз структур)

Содержит конфигурации для инструмента, который модель может использовать при генерации ответа. Для получения дополнительной информации см. Использование инструмента для завершения ответа модели Amazon Bedrock.

Примечание

Это меченый союз структур. Только один из следующих верхнеуровневых ключей может быть задан: cachePoint, toolSpec.

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

Создает контрольную точку кэша в обозначении инструмента

type -> (строка)

Указывает, что блок CachePoint имеет стандартный тип

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

Спецификация инструмента.

description -> (строка)

Описание инструмента.

inputSchema -> (меченый союз структур)

Схема ввода для инструмента.

Примечание

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

json -> (документ)

JSON-объект, определяющий схему ввода для инструмента.

name -> (строка)

Имя инструмента.

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

Содержит конфигурации для текста в сообщении запроса.

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

Контрольная точка кэша в конфигурации шаблона.

type -> (строка)

Указывает, что блок CachePoint имеет стандартный тип

inputVariables -> (список)

Массив переменных в шаблоне запроса.

(структура)

Содержит информацию о переменной в запросе.

name -> (строка)

Имя переменной.

text -> (строка)

Сообщение для запроса.

templateType -> (строка)

Тип шаблона запроса.

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

Содержит конфигурации для запроса из Управления запросами.

promptArn -> (строка)

Amazon Resource Name (ARN) запроса из Управления запросами.

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

Содержит конфигурации для узла извлечения в вашем потоке. Извлекает данные из расположения Amazon S3 и возвращает их в качестве вывода.

serviceConfiguration -> (меченый союз структур)

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

Примечание

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

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

Содержит конфигурации для расположения Amazon S3, из которого извлекаются данные для возврата в качестве вывода из узла.

bucketName -> (строка)

Имя ведра Amazon S3, из которого извлекаются данные.

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

Содержит конфигурации для узла хранения в вашем потоке. Хранит вход в расположении Amazon S3.

serviceConfiguration -> (меченый союз структур)

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

Примечание

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

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

Содержит конфигурации для расположения Amazon S3, в котором хранится вход в узел.

bucketName -> (строка)

Имя ведра Amazon S3, в котором хранится вход в узел.

inputs -> (список)

Массив объектов, каждый из которых содержит информацию об входных данных в узел.

(структура)

Содержит конфигурации для входных данных в узле Amazon Bedrock Flows.

category -> (строка)

Определяет, как данные поступают в итерации цикла DoWhile.

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

expression -> (строка)

Выражение, форматирующее входные данные для узла. Объяснение создания выражений см. в разделе Выражения в потоках запросов в Amazon Bedrock.

name -> (строка)

Указывает имя входных данных, которое можно использовать для ссылки.

type -> (строка)

Указывает тип данных входных данных. Если входные данные не соответствуют этому типу во время выполнения, будет выброшено сообщение об ошибке валидации.

name -> (строка)

Имя узла.

outputs -> (список)

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

(структура)

Содержит конфигурации для выхода из узла.

name -> (строка)

Имя выхода, которое можно использовать для ссылки.

type -> (строка)

Тип данных выхода. Если выход не соответствует этому типу во время выполнения, будет выброшено сообщение об ошибке валидации.

type -> (строка)

Тип узла. Это значение должно соответствовать имени ключа, который вы предоставляете в конфигурации, которую вы предоставляете в поле FlowNodeConfiguration.

Синтаксис JSON:

{
  "connections": [
    {
      "configuration": {
        "conditional": {
          "condition": "string"
        },
        "data": {
          "sourceOutput": "string",
          "targetInput": "string"
        }
      },
      "name": "string",
      "source": "string",
      "target": "string",
      "type": "Data"|"Conditional"
    }
    ...
  ],
  "nodes": [
    {
      "configuration": {
        "agent": {
          "agentAliasArn": "string"
        },
        "collector": {

        },
        "condition": {
          "conditions": [
            {
              "expression": "string",
              "name": "string"
            }
            ...
          ]
        },
        "inlineCode": {
          "code": "string",
          "language": "Python_3"
        },
        "input": {

        },
        "iterator": {

        },
        "knowledgeBase": {
          "guardrailConfiguration": {
            "guardrailIdentifier": "string",
            "guardrailVersion": "string"
          },
          "inferenceConfiguration": {
            "text": {
              "maxTokens": integer,
              "stopSequences": ["string", ...],
              "temperature": float,
              "topP": float
            }
          },
          "knowledgeBaseId": "string",
          "modelId": "string",
          "numberOfResults": integer,
          "orchestrationConfiguration": {
            "additionalModelRequestFields": {"string": {...}
              ...},
            "inferenceConfig": {
              "text": {
                "maxTokens": integer,
                "stopSequences": ["string", ...],
                "temperature": float,
                "topP": float
              }
            },
            "performanceConfig": {
              "latency": "standard"|"optimized"
            },
            "promptTemplate": {
              "textPromptTemplate": "string"
            }
          },
          "promptTemplate": {
            "textPromptTemplate": "string"
          },
          "rerankingConfiguration": {
            "bedrockRerankingConfiguration": {
              "metadataConfiguration": {
                "selectionMode": "SELECTIVE"|"ALL",
                "selectiveModeConfiguration": {
                  "fieldsToExclude": [
                    {
                      "fieldName": "string"
                    }
                    ...
                  ],
                  "fieldsToInclude": [
                    {
                      "fieldName": "string"
                    }
                    ...
                  ]
                }
              },
              "modelConfiguration": {
                "additionalModelRequestFields": {"string": {...}
                  ...},
                "modelArn": "string"
              },
              "numberOfRerankedResults": integer
            },
            "type": "BEDROCK_RERANKING_MODEL"
          }
        },
        "lambdaFunction": {
          "lambdaArn": "string"
        },
        "lex": {
          "botAliasArn": "string",
          "localeId": "string"
        },
        "loop": {
          "definition": {
            "connections": [
              {
                "configuration": {
                  "conditional": {
                    "condition": "string"
                  },
                  "data": {
                    "sourceOutput": "string",
                    "targetInput": "string"
                  }
                },
                "name": "string",
                "source": "string",
                "target": "string",
                "type": "Data"|"Conditional"
              }
              ...
            ],
            "nodes": [
              {
                "configuration": {
                  "agent": {
                    "agentAliasArn": "string"
                  },
                  "collector": {

                  },
                  "condition": {
                    "conditions": [
                      {
                        "expression": "string",
                        "name": "string"
                      }
                      ...
                    ]
                  },
                  "inlineCode": {
                    "code": "string",
                    "language": "Python_3"
                  },
                  "input": {

                  },
                  "iterator": {

                  },
                  "knowledgeBase": {
                    "guardrailConfiguration": {
                      "guardrailIdentifier": "string",
                      "guardrailVersion": "string"
                    },
                    "inferenceConfiguration": {
                      "text": {
                        "maxTokens": integer,
                        "stopSequences": ["string", ...],
                        "temperature": float,
                        "topP": float
                      }
                    },
                    "knowledgeBaseId": "string",
                    "modelId": "string",
                    "numberOfResults": integer,
                    "orchestrationConfiguration": {
                      "additionalModelRequestFields": {"string": {...}
                        ...},
                      "inferenceConfig": {
                        "text": {
                          "maxTokens": integer,
                          "stopSequences": ["string", ...],
                          "temperature": float,
                          "topP": float
                        }
                      },
                      "performanceConfig": {
                        "latency": "standard"|"optimized"
                      },
                      "promptTemplate": {
                        "textPromptTemplate": "string"
                      }
                    },
                    "promptTemplate": {
                      "textPromptTemplate": "string"
                    },
                    "rerankingConfiguration": {
                      "bedrockRerankingConfiguration": {
                        "metadataConfiguration": {
                          "selectionMode": "SELECTIVE"|"ALL",
                          "selectiveModeConfiguration": {
                            "fieldsToExclude": [
                              {
                                "fieldName": "string"
                              }
                              ...
                            ],
                            "fieldsToInclude": [
                              {
                                "fieldName": "string"
                              }
                              ...
                            ]
                          }
                        },
                        "modelConfiguration": {
                          "additionalModelRequestFields": {"string": {...}
                            ...},
                          "modelArn": "string"
                        },
                        "numberOfRerankedResults": integer
                      },
                      "type": "BEDROCK_RERANKING_MODEL"
                    }
                  },
                  "lambdaFunction": {
                    "lambdaArn": "string"
                  },
                  "lex": {
                    "botAliasArn": "string",
                    "localeId": "string"
                  },
                  "loop": {
                    "definition": { ... recursive ... }
                  },
                  "loopController": {
                    "continueCondition": {
                      "expression": "string",
                      "name": "string"
                    },
                    "maxIterations": integer
                  },
                  "loopInput": {

                  },
                  "output": {

                  },
                  "prompt": {
                    "guardrailConfiguration": {
                      "guardrailIdentifier": "string",
                      "guardrailVersion": "string"
                    },
                    "sourceConfiguration": {
                      "inline": {
                        "additionalModelRequestFields": {...},
                        "inferenceConfiguration": {
                          "text": {
                            "maxTokens": integer,
                            "stopSequences": ["string", ...],
                            "temperature": float,
                            "topP": float
                          }
                        },
                        "modelId": "string",
                        "templateConfiguration": {
                          "chat": {
                            "inputVariables": [
                              {
                                "name": "string"
                              }
                              ...
                            ],
                            "messages": [
                              {
                                "content": [
                                  {
                                    "cachePoint": {
                                      "type": "default"
                                    },
                                    "text": "string"
                                  }
                                  ...
                                ],
                                "role": "user"|"assistant"
                              }
                              ...
                            ],
                            "system": [
                              {
                                "cachePoint": {
                                  "type": "default"
                                },
                                "text": "string"
                              }
                              ...
                            ],
                            "toolConfiguration": {
                              "toolChoice": {
                                "any": {

                                },
                                "auto": {

                                },
                                "tool": {
                                  "name": "string"
                                }
                              },
                              "tools": [
                                {
                                  "cachePoint": {
                                    "type": "default"
                                  },
                                  "toolSpec": {
                                    "description": "string",
                                    "inputSchema": {
                                      "json": {...}
                                    },
                                    "name": "string"
                                  }
                                }
                                ...
                              ]
                            }
                          },
                          "text": {
                            "cachePoint": {
                              "type": "default"
                            },
                            "inputVariables": [
                              {
                                "name": "string"
                              }
                              ...
                            ],
                            "text": "string"
                          }
                        },
                        "templateType": "TEXT"|"CHAT"
                      },
                      "resource": {
                        "promptArn": "string"
                      }
                    }
                  },
                  "retrieval": {
                    "serviceConfiguration": {
                      "s3": {
                        "bucketName": "string"
                      }
                    }
                  },
                  "storage": {
                    "serviceConfiguration": {
                      "s3": {
                        "bucketName": "string"
                      }
                    }
                  }
                },
                "inputs": [
                  {
                    "category": "LoopCondition"|"ReturnValueToLoopStart"|"ExitLoop",
                    "expression": "string",
                    "name": "string",
                    "type": "String"|"Number"|"Boolean"|"Object"|"Array"
                  }
                  ...
                ],
                "name": "string",
                "outputs": [
                  {
                    "name": "string",
                    "type": "String"|"Number"|"Boolean"|"Object"|"Array"
                  }
                  ...
                ],
                "type": "Input"|"Output"|"KnowledgeBase"|"Condition"|"Lex"|"Prompt"|"LambdaFunction"|"Storage"|"Agent"|"Retrieval"|"Iterator"|"Collector"|"InlineCode"|"Loop"|"LoopInput"|"LoopController"
              }
              ...
            ]
          }
        },
        "loopController": {
          "continueCondition": {
            "expression": "string",
            "name": "string"
          },
          "maxIterations": integer
        },
        "loopInput": {

        },
        "output": {

        },
        "prompt": {
          "guardrailConfiguration": {
            "guardrailIdentifier": "string",
            "guardrailVersion": "string"
          },
          "sourceConfiguration": {
            "inline": {
              "additionalModelRequestFields": {...},
              "inferenceConfiguration": {
                "text": {
                  "maxTokens": integer,
                  "stopSequences": ["string", ...],
                  "temperature": float,
                  "topP": float
                }
              },
              "modelId": "string",
              "templateConfiguration": {
                "chat": {
                  "inputVariables": [
                    {
                      "name": "string"
                    }
                    ...
                  ],
                  "messages": [
                    {
                      "content": [
                        {
                          "cachePoint": {
                            "type": "default"
                          },
                          "text": "string"
                        }
                        ...
                      ],
                      "role": "user"|"assistant"
                    }
                    ...
                  ],
                  "system": [
                    {
                      "cachePoint": {
                        "type": "default"
                      },
                      "text": "string"
                    }
                    ...
                  ],
                  "toolConfiguration": {
                    "toolChoice": {
                      "any": {

                      },
                      "auto": {

                      },
                      "tool": {
                        "name": "string"
                      }
                    },
                    "tools": [
                      {
                        "cachePoint": {
                          "type": "default"
                        },
                        "toolSpec": {
                          "description": "string",
                          "inputSchema": {
                            "json": {...}
                          },
                          "name": "string"
                        }
                      }
                      ...
                    ]
                  }
                },
                "text": {
                  "cachePoint": {
                    "type": "default"
                  },
                  "inputVariables": [
                    {
                      "name": "string"
                    }
                    ...
                  ],
                  "text": "string"
                }
              },
              "templateType": "TEXT"|"CHAT"
            },
            "resource": {
              "promptArn": "string"
            }
          }
        },
        "retrieval": {
          "serviceConfiguration": {
            "s3": {
              "bucketName": "string"
            }
          }
        },
        "storage": {
          "serviceConfiguration": {
            "s3": {
              "bucketName": "string"
            }
          }
        }
      },
      "inputs": [
        {
          "category": "LoopCondition"|"ReturnValueToLoopStart"|"ExitLoop",
          "expression": "string",
          "name": "string",
          "type": "String"|"Number"|"Boolean"|"Object"|"Array"
        }
        ...
      ],
      "name": "string",
      "outputs": [
        {
          "name": "string",
          "type": "String"|"Number"|"Boolean"|"Object"|"Array"
        }
        ...
      ],
      "type": "Input"|"Output"|"KnowledgeBase"|"Condition"|"Lex"|"Prompt"|"LambdaFunction"|"Storage"|"Agent"|"Retrieval"|"Iterator"|"Collector"|"InlineCode"|"Loop"|"LoopInput"|"LoopController"
    }
    ...
  ]
}

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

--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
текст
таблица
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.

Вывод

validations -> (список)

Содержит массив объектов, каждый из которых содержит ошибку, определённую проверкой.

(структура)

Содержит информацию о проверке потока.

Этот тип данных используется в следующих операциях API:

Ответ GetFlow
Ответ GetFlowVersion

details -> (структура помеченного объединения)

Конкретные детали проблемы проверки, возникшей в потоке.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан: cyclicConnection, duplicateConditionExpression, duplicateConnections, incompatibleConnectionDataType, invalidLoopBoundary, loopIncompatibleNodeType, malformedConditionExpression, malformedNodeInputExpression, mismatchedNodeInputType, mismatchedNodeOutputType, missingConnectionConfiguration, missingDefaultCondition, missingEndingNodes, missingLoopControllerNode, missingLoopInputNode, missingNodeConfiguration, missingNodeInput, missingNodeOutput, missingStartingNodes, multipleLoopControllerNodes, multipleLoopInputNodes, multipleNodeInputConnections, unfulfilledNodeInput, unknownConnectionCondition, unknownConnectionSource, unknownConnectionSourceOutput, unknownConnectionTarget, unknownConnectionTargetInput, unknownNodeInput, unknownNodeOutput, unreachableNode, unsatisfiedConnectionConditions, unspecified.

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

Подробности о циклическом соединении в потоке.

connection -> (строка)

Имя соединения, вызывающего цикл в потоке.

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

Подробности о дублируемых выражениях условия в узле.

expression -> (строка)

Дублируемое выражение условия.

node -> (строка)

Имя узла, содержащего дублируемые выражения условия.

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

Подробности о дублируемых соединениях между узлами.

source -> (строка)

Имя исходного узла, где начинается дублируемое соединение.

target -> (строка)

Имя целевого узла, где заканчивается дублируемое соединение.

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

Подробности о несовместимых типах данных в соединении.

connection -> (строка)

Имя соединения с несовместимыми типами данных.

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

Подробности о потоке, содержащем соединения, которые нарушают правила границ цикла.

connection -> (строка)

Имя соединения, нарушающего правила границ цикла.

source -> (строка)

Исходный узел соединения, нарушающего правила границ цикла DoWhile.

target -> (строка)

Целевой узел соединения, нарушающего правила границ цикла DoWhile.

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

Подробности о потоке, содержащем несовместимые типы узлов в цикле DoWhile.

incompatibleNodeName -> (строка)

Узел, несовместимый в цикле DoWhile.

incompatibleNodeType -> (строка)

Тип узла несовместимого узла в цикле DoWhile. Некоторые типы узлов, такие как узел условия, не допускаются в цикле DoWhile.

node -> (строка)

Узел-контейнер Loop, содержащий несовместимый узел.

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

Подробности о некорректном выражении условия в узле.

cause -> (строка)

Сообщение об ошибке, описывающее причину некорректного выражения условия.

condition -> (строка)

Имя некорректного условия.

node -> (строка)

Имя узла, содержащего некорректное выражение условия.

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

Подробности о некорректном выражении ввода в узле.

cause -> (строка)

Сообщение об ошибке, описывающее причину некорректного выражения ввода.

input -> (строка)

Имя ввода с некорректным выражением.

node -> (строка)

Имя узла, содержащего некорректное выражение ввода.

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

Подробности о несовпадающих типах данных ввода в узле.

expectedType -> (строка)

Ожидаемый тип данных для ввода узла.

input -> (строка)

Имя ввода с несовпадающим типом данных.

node -> (строка)

Имя узла, содержащего ввод с несовпадающим типом данных.

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

Подробности о несовпадающих типах данных вывода в узле.

expectedType -> (строка)

Ожидаемый тип данных для вывода узла.

node -> (строка)

Имя узла, содержащего вывод с несовпадающим типом данных.

output -> (строка)

Имя вывода с несовпадающим типом данных.

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

Подробности о недостающей конфигурации для соединения.

connection -> (строка)

Имя соединения, которому не хватает конфигурации.

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

Подробности о недостающем условии по умолчанию в условном узле.

node -> (строка)

Имя узла, которому не хватает условия по умолчанию.

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

Подробности о недостающих узлах завершения в потоке.

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

Подробности о потоке, которому не хватает требуемого узла LoopController в цикле DoWhile.

loopNode -> (строка)

Цикл DoWhile в потоке, которому не хватает требуемого узла LoopController.

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

Подробности о потоке, которому не хватает требуемого узла LoopInput в цикле DoWhile.

loopNode -> (строка)

Цикл DoWhile в потоке, которому не хватает требуемого узла LoopInput.

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

Подробности о недостающей конфигурации для узла.

node -> (строка)

Имя узла, которому не хватает необходимой конфигурации.

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

Подробности о недостающем обязательном вводе в узле.

input -> (строка)

Имя отсутствующего ввода.

node -> (строка)

Имя узла, которому не хватает обязательного ввода.

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

Подробности о недостающем обязательном выводе в узле.

node -> (строка)

Имя узла, которому не хватает обязательного вывода.

output -> (строка)

Имя отсутствующего вывода.

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

Подробности о недостающих начальных узлах в потоке.

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

Подробности о потоке, содержащем несколько узлов LoopController в цикле DoWhile.

loopNode -> (строка)

Цикл DoWhile в потоке, содержащий несколько узлов LoopController.

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

Подробности о потоке, содержащем несколько узлов LoopInput в цикле DoWhile.

loopNode -> (строка)

Цикл DoWhile в потоке, содержащий несколько узлов LoopInput.

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

Подробности о нескольких соединениях с одним вводом узла.

input -> (строка)

Имя ввода с несколькими соединениями к нему.

node -> (строка)

Имя узла, содержащего ввод с несколькими соединениями.

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

Подробности об неудовлетворённом вводе узла без допустимых соединений.

input -> (строка)

Имя неудовлетворённого ввода. Ввод считается неудовлетворённым, если к нему нет подключений данных.

node -> (строка)

Имя узла, содержащего неудовлетворённый ввод.

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

Подробности об неизвестном условии для соединения.

connection -> (строка)

Имя соединения с неизвестным условием.

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

Подробности об неизвестном исходном узле для соединения.

connection -> (строка)

Имя соединения с неизвестным источником.

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

Подробности об неизвестном выводе источника для соединения.

connection -> (строка)

Имя соединения с неизвестным выводом источника.

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

Подробности об неизвестном целевом узле для соединения.

connection -> (строка)

Имя соединения с неизвестной целью.

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

Подробности об неизвестном целевом вводе для соединения.

connection -> (строка)

Имя соединения с неизвестным целевым вводом.

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

Подробности об неизвестном вводе для узла.

input -> (строка)

Имя узла с неизвестным вводом.

node -> (строка)

Имя неизвестного ввода.

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

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

node -> (строка)

Имя узла с неизвестным выводом.

output -> (строка)

Имя неизвестного вывода.

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

Подробности об недоступном узле в потоке.

node -> (строка)

Имя недоступного узла.

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

Подробности о невыполненных условиях для соединения.

connection -> (строка)

Имя соединения с невыполненными условиями.

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

Подробности о неопределённой проверке.

message -> (строка)

Сообщение, описывающее ошибку проверки.

severity -> (строка)

Серьёзность проблемы, описанной в сообщении.

type -> (строка)

Тип проблемы проверки, возникшей в потоке.

END_OF_DOCUMENT_MARKER