[ aws . kinesisanalyticsv2 ]
описание-приложения
Описание
Возвращает информацию о конкретном управляемом приложении Apache Flink.
Если вы хотите получить список всех приложений в вашей учётной записи, используйте операцию ListApplications.
См. также: Документацию API AWS
Синтаксис
describe-application
--application-name <value>
[--include-additional-details | --no-include-additional-details]
[--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]
Параметры
--application-name (строка)
--include-additional-details | --no-include-additional-details (логическое значение)
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, указанному в --generate-cli-skeleton. Если другие аргументы предоставляются в командной строке, эти значения переопределяют значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--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.
Вывод
ApplicationDetail -> (структура)
Предоставляет описание приложения, например, Amazon Resource Name (ARN) приложения, состояние и последнюю версию.
ApplicationARN -> (строка)
ApplicationDescription -> (строка)
ApplicationName -> (строка)
RuntimeEnvironment -> (строка)
ServiceExecutionRole -> (строка)
ApplicationStatus -> (строка)
ApplicationVersionId -> (целое число)
ApplicationVersionId каждый раз при обновлении приложения.CreateTimestamp -> (временная метка)
LastUpdateTimestamp -> (временная метка)
ApplicationConfigurationDescription -> (структура)
Описывает подробности кода приложения и параметров запуска для приложения управляемой службы Apache Flink.
SqlApplicationConfigurationDescription -> (структура)
Подробности о входных данных, выходных данных и источниках справочных данных для приложения Kinesis Data Analytics на основе SQL.
InputDescriptions -> (список)
Массив объектов InputDescription, описывающих входные потоки, используемые приложением.
(структура)
Описывает конфигурацию входных данных приложения для приложения Kinesis Data Analytics на основе SQL.
InputId -> (строка)
NamePrefix -> (строка)
InAppStreamNames -> (список)
Возвращает имена потоков внутри приложения, сопоставленные с источником потока.
(строка)
InputProcessingConfigurationDescription -> (структура)
Описание препроцессора, который выполняется над записями в этом входе перед запуском кода приложения.
InputLambdaProcessorDescription -> (структура)
Предоставляет конфигурационную информацию об ассоциированном InputLambdaProcessorDescription
ResourceARN -> (строка)
ARN функции Amazon Lambda, которая используется для предварительной обработки записей в потоке.
Примечание
Чтобы указать предыдущую версию функции Lambda, отличную от последней, включите версию функции Lambda в ARN функции Lambda. Дополнительную информацию о Lambda ARN см. в Примеры ARN: Amazon LambdaRoleARN -> (строка)
ARN роли IAM, которая используется для доступа к функции Amazon Lambda.
Примечание
Предоставляется для обратной совместимости. Приложения, созданные с текущей версией API, имеют роль выполнения сервиса на уровне приложения, а не на уровне ресурса.KinesisStreamsInputDescription -> (структура)
Если поток данных Kinesis настроен как источник потока, предоставляет Amazon Resource Name (ARN) потока данных Kinesis.
ResourceARN -> (строка)
RoleARN -> (строка)
ARN роли IAM, которую Kinesis Data Analytics может принять для доступа к потоку.
Примечание
Предоставляется для обратной совместимости. Приложения, созданные с текущей версией API, имеют роль выполнения сервиса на уровне приложения, а не на уровне ресурса.KinesisFirehoseInputDescription -> (структура)
Если поток доставки Kinesis Data Firehose настроен как источник потока, предоставляет ARN потока доставки.
ResourceARN -> (строка)
RoleARN -> (строка)
ARN роли IAM, которую Kinesis Data Analytics принимает для доступа к потоку.
Примечание
Предоставляется для обратной совместимости. Приложения, созданные с текущей версией API, имеют роль выполнения сервиса на уровне приложения, а не на уровне ресурса.InputSchema -> (структура)
Описывает формат данных в источнике потока и то, как каждый элемент данных отображается на соответствующие столбцы в потоке внутри приложения, который создается.
RecordFormat -> (структура)
Определяет формат записей в источнике потока.
RecordFormatType -> (строка)
MappingParameters -> (структура)
При настройке входных данных приложения во время создания или обновления приложения предоставляет дополнительную информацию о сопоставлении, специфичную для формата записей (например, JSON, CSV или полей записей, разделяемых разделителем) в источнике потока.
JSONMappingParameters -> (структура)
Предоставляет дополнительную информацию о сопоставлении, когда JSON является форматом записей в источнике потока.
RecordRowPath -> (строка)
CSVMappingParameters -> (структура)
Предоставляет дополнительную информацию о сопоставлении, когда формат записей использует разделители (например, CSV).
RecordRowDelimiter -> (строка)
RecordColumnDelimiter -> (строка)
RecordEncoding -> (строка)
RecordColumns -> (список)
Список RecordColumn объектов.
(структура)
Для приложения Kinesis Data Analytics на основе SQL описывает сопоставление каждого элемента данных в источнике потока с соответствующим столбцом в потоке внутри приложения.
Также используется для описания формата источника справочных данных.
Name -> (строка)
Mapping -> (строка)
SqlType -> (строка)
InputParallelism -> (структура)
Описывает настроенный параллелизм (количество потоков внутри приложения, сопоставленных с источником потока).
Count -> (целое число)
InputStartingPositionConfiguration -> (структура)
Точка, с которой приложение настроено для чтения из входного потока.
InputStartingPosition -> (строка)
Начальная позиция в потоке.
-
NOW- Начать чтение сразу после последней записи в потоке и начать с запрошенной временной метки, выданной клиентом. -
TRIM_HORIZON- Начать чтение с последней не обрезанной записи в потоке, которая является самой старой записью, доступной в потоке. Этот параметр недоступен для потока доставки Amazon Kinesis Data Firehose. -
LAST_STOPPED_POINT- Возобновить чтение с места, где приложение остановилось в последнюю очередь.
OutputDescriptions -> (список)
Массив объектов OutputDescription, описывающих потоки назначения, используемые приложением.
(структура)
Для приложения Kinesis Data Analytics на основе SQL описывает конфигурацию выходных данных приложения, включая имя потока внутри приложения и место назначения, куда записываются данные потока. Местом назначения может быть поток данных Kinesis или поток доставки Kinesis Data Firehose.
OutputId -> (строка)
Name -> (строка)
KinesisStreamsOutputDescription -> (структура)
Описывает поток данных Kinesis, настроенный как место назначения для записи выходных данных.
ResourceARN -> (строка)
RoleARN -> (строка)
ARN роли IAM, которую Kinesis Data Analytics может принять для доступа к потоку.
Примечание
Предоставляется для обратной совместимости. Приложения, созданные с текущей версией API, имеют роль выполнения сервиса на уровне приложения, а не на уровне ресурса.KinesisFirehoseOutputDescription -> (структура)
Описывает поток доставки Kinesis Data Firehose, настроенный как место назначения для записи выходных данных.
ResourceARN -> (строка)
RoleARN -> (строка)
ARN роли IAM, которую Kinesis Data Analytics может принять для доступа к потоку.
Примечание
Предоставляется для обратной совместимости. Приложения, созданные с текущей версией API, имеют роль выполнения сервиса на уровне приложения, а не на уровне ресурса.LambdaOutputDescription -> (структура)
Описывает функцию Lambda, настроенную как место назначения для записи выходных данных.
ResourceARN -> (строка)
RoleARN -> (строка)
ARN роли IAM, которую Kinesis Data Analytics может принять для записи в целевую функцию.
Примечание
Предоставляется для обратной совместимости. Приложения, созданные с текущей версией API, имеют роль выполнения сервиса на уровне приложения, а не на уровне ресурса.DestinationSchema -> (структура)
Формат данных, используемый для записи данных в место назначения.
RecordFormatType -> (строка)
ReferenceDataSourceDescriptions -> (список)
Массив объектов ReferenceDataSourceDescription, описывающих источники справочных данных, используемые приложением.
(структура)
Для приложения Kinesis Data Analytics на базе SQL описывает источник справочных данных, настроенный для приложения.
ReferenceId -> (строка)
TableName -> (строка)
S3ReferenceDataSourceDescription -> (структура)
Предоставляет имя ведра Amazon S3 и имя ключа объекта, содержащего справочные данные.
BucketARN -> (строка)
FileKey -> (строка)
ReferenceRoleARN -> (строка)
ARN роли IAM, которую Kinesis Data Analytics может принять для чтения объекта Amazon S3 от вашего имени для заполнения таблицы справочных данных в приложении.
Примечание
Предоставляется для обратной совместимости. Приложения, созданные с текущей версией API, имеют роль выполнения службы на уровне приложения, а не роль на уровне ресурса.ReferenceSchema -> (структура)
Описывает формат данных в источнике потоковой передачи и то, как каждый элемент данных отображается на соответствующие столбцы, созданные в потоке приложения.
RecordFormat -> (структура)
Указывает формат записей в источнике потоковой передачи.
RecordFormatType -> (строка)
MappingParameters -> (структура)
При настройке входных данных приложения при создании или обновлении приложения предоставляются дополнительные сведения об отображении, специфичные для формата записи (например, JSON, CSV или полей записи, разделенных каким-либо разделителем) в источнике потоковой передачи.
JSONMappingParameters -> (структура)
Предоставляет дополнительные сведения об отображении, когда формат записи — JSON в источнике потоковой передачи.
RecordRowPath -> (строка)
CSVMappingParameters -> (структура)
Предоставляет дополнительные сведения об отображении, когда формат записи использует разделители (например, CSV).
RecordRowDelimiter -> (строка)
RecordColumnDelimiter -> (строка)
RecordEncoding -> (строка)
RecordColumns -> (список)
Список объектов RecordColumn.
(структура)
Для приложения Kinesis Data Analytics на базе SQL описывает отображение каждого элемента данных в источнике потоковой передачи на соответствующий столбец в потоке приложения.
Также используется для описания формата источника справочных данных.
Name -> (строка)
Mapping -> (строка)
SqlType -> (строка)
ApplicationCodeConfigurationDescription -> (структура)
Подробности о коде приложения для приложения Managed Service для Apache Flink.
CodeContentType -> (строка)
CodeContentDescription -> (структура)
Описывает подробности о расположении и формате кода приложения.
TextContent -> (строка)
CodeMD5 -> (строка)
CodeSize -> (целое число)
S3ApplicationCodeLocationDescription -> (структура)
Идентификатор ресурса Amazon S3 (ARN) ведра S3, ключ файла и версия объекта кода приложения, хранящегося в Amazon S3.
BucketARN -> (строка)
FileKey -> (строка)
ObjectVersion -> (строка)
RunConfigurationDescription -> (структура)
Подробности о начальных свойствах приложения Managed Service для Apache Flink.
ApplicationRestoreConfigurationDescription -> (структура)
Описание поведения восстановления перезапускающегося приложения.
ApplicationRestoreType -> (строка)
SnapshotName -> (строка)
ApplicationRestoreType указано RESTORE_FROM_CUSTOM_SNAPSHOT.FlinkRunConfigurationDescription -> (структура)
Описывает начальные параметры приложения Managed Service для Apache Flink.
AllowNonRestoredState -> (булево)
При восстановлении из снимка указывает, разрешено ли временному выполнению пропустить состояние, которое не может быть отображено в новой программе. Это произойдет, если программа обновлена между снимками, чтобы удалить состоятельные параметры, и данные состояния в снимке больше не соответствуют допустимым данным приложения. Дополнительные сведения см. в документации Apache Flink по разрешению состояния, которое не было восстановлено.
Примечание
Это значение по умолчаниюfalse. Если вы обновите приложение, не указав этот параметр, AllowNonRestoredState будет установлено на false, даже если ранее оно было установлено на true.FlinkApplicationConfigurationDescription -> (структура)
Подробности о приложении Managed Service для Apache Flink.
CheckpointConfigurationDescription -> (структура)
Описание конфигурации чекпоинтов приложения. Чекпоинты — это процесс сохранения состояния приложения для обеспечения отказоустойчивости.
ConfigurationType -> (строка)
Описание того, использует ли приложение поведение по умолчанию для чекпоинтов в Managed Service для Apache Flink.
Примечание
Если это значение установлено в DEFAULT, приложение будет использовать следующие значения, даже если они установлены другими значениями через API или код приложения:
- CheckpointingEnabled: true
- CheckpointInterval: 60000
- MinPauseBetweenCheckpoints: 5000
CheckpointingEnabled -> (булево)
Описание того, включены ли чекпоинты для приложения Managed Service для Apache Flink.
Примечание
ЕслиCheckpointConfiguration.ConfigurationType равно DEFAULT, приложение будет использовать значение CheckpointingEnabled равное true, даже если это значение установлено иным образом с помощью данного API или в коде приложения.CheckpointInterval -> (длинное целое)
Описание интервала в миллисекундах между операциями чекпоинта.
Примечание
ЕслиCheckpointConfiguration.ConfigurationType равно DEFAULT, приложение будет использовать значение CheckpointInterval равное 60000, даже если это значение установлено иным образом с помощью данного API или в коде приложения.MinPauseBetweenCheckpoints -> (длинное целое)
Описание минимального времени в миллисекундах после завершения операции чекпоинта, через которое может начаться новая операция чекпоинта.
Примечание
ЕслиCheckpointConfiguration.ConfigurationType равно DEFAULT, приложение будет использовать значение MinPauseBetweenCheckpoints равное 5000, даже если это значение установлено с помощью данного API или в коде приложения.MonitoringConfigurationDescription -> (структура)
Описание параметров конфигурации для ведения журнала Amazon CloudWatch для приложения.
ConfigurationType -> (строка)
MetricsLevel -> (строка)
LogLevel -> (строка)
ParallelismConfigurationDescription -> (структура)
Описание параметров для выполнения приложения несколькими задачами одновременно.
ConfigurationType -> (строка)
Parallelism -> (целое число)
AutoScalingEnabled установлено в True, то Managed Service для Apache Flink может увеличить значение CurrentParallelism в ответ на нагрузку приложения. Сервис может увеличить CurrentParallelism до максимального параллелизма, который равен ParalellismPerKPU умноженному на максимальное количество KPUs для приложения. Максимальное количество KPUs для приложения по умолчанию составляет 32 и может быть увеличено по запросу. Если нагрузка приложения снижается, сервис может уменьшить значение CurrentParallelism до значения по умолчанию Parallelism.ParallelismPerKPU -> (целое число)
CurrentParallelism -> (целое число)
AutoScalingEnabled установлено в True, Managed Service для Apache Flink может увеличить это значение в ответ на нагрузку приложения. Сервис может увеличить это значение до максимального параллелизма, который равен ParalellismPerKPU умноженному на максимальное количество KPUs для приложения. Максимальное количество KPUs для приложения по умолчанию составляет 32 и может быть увеличено по запросу. Если нагрузка приложения снижается, сервис может уменьшить значение CurrentParallelism до значения по умолчанию Parallelism.AutoScalingEnabled -> (булево)
JobPlanDescription -> (строка)
EnvironmentPropertyDescriptions -> (структура)
Описание свойств выполнения для приложения Managed Service для Apache Flink.
PropertyGroupDescriptions -> (список)
Описание групп свойств выполнения.
(структура)
Ключевые пары свойств, передаваемые в приложение.
PropertyGroupId -> (строка)
PropertyMap -> (карта)
Описание значения пары свойств выполнения приложения.
key -> (строка)
value -> (строка)
ApplicationSnapshotConfigurationDescription -> (структура)
Описание того, включены ли снимки для приложения Managed Service для Apache Flink.
SnapshotsEnabled -> (булево)
ApplicationSystemRollbackConfigurationDescription -> (структура)
Описание конфигурации отката системы для приложения Managed Service для Apache Flink.
RollbackEnabled -> (булево)
VpcConfigurationDescriptions -> (список)
Массив описаний конфигураций VPC, доступных для приложения.
(структура)
Описание параметров VPC, используемого приложением.
VpcConfigurationId -> (строка)
VpcId -> (строка)
SubnetIds -> (список)
Массив идентификаторов подсетей, используемых конфигурацией VPC.
(строка)
SecurityGroupIds -> (список)
Массив идентификаторов групп безопасности, используемых конфигурацией VPC.
(строка)
ZeppelinApplicationConfigurationDescription -> (структура)
Параметры конфигурации для блокнота Managed Service для Apache Flink Studio.
MonitoringConfigurationDescription -> (структура)
Конфигурация мониторинга блокнота Managed Service для Apache Flink Studio.
LogLevel -> (строка)
CatalogConfigurationDescription -> (структура)
Каталог данных Amazon Glue, связанный с блокнотом Managed Service для Apache Flink Studio.
GlueDataCatalogConfigurationDescription -> (структура)
Параметры конфигурации для базы данных Amazon Glue по умолчанию. Вы используете эту базу данных для SQL-запросов, которые вы пишете в блокноте Managed Service для Apache Flink Studio.
DatabaseARN -> (строка)
DeployAsApplicationConfigurationDescription -> (структура)
Параметры, необходимые для развертывания блокнота Managed Service для Apache Flink Studio в качестве приложения с устойчивым состоянием.
S3ContentLocationDescription -> (структура)
Расположение, содержащее данные, необходимые для задания приложения Amazon Data Analytics.
BucketARN -> (строка)
BasePath -> (строка)
CustomArtifactsConfigurationDescription -> (список)
Пользовательские артефакты — это JAR-файлы зависимостей и пользовательские функции (UDF).
(структура)
Определяет JAR-файл зависимостей или JAR-файл пользовательских функций.
ArtifactType -> (строка)
UDF означает пользовательские функции. Этот тип артефакта должен находиться в корзине S3. DEPENDENCY_JAR может находиться как в Maven, так и в корзине S3.S3ContentLocationDescription -> (структура)
Для приложения Managed Service для Apache Flink предоставляет описание объекта Amazon S3, включая Amazon Resource Name (ARN) корзины S3, имя объекта Amazon S3, содержащего данные, и номер версии объекта Amazon S3, содержащего данные.
BucketARN -> (строка)
FileKey -> (строка)
ObjectVersion -> (строка)
MavenReferenceDescription -> (структура)
Параметры, необходимые для задания Maven-зависимости.
GroupId -> (строка)
ArtifactId -> (строка)
Version -> (строка)
CloudWatchLoggingOptionDescriptions -> (список)
Описание параметров ведения журнала Amazon CloudWatch для приложения.
(структура)
Описание параметра ведения журнала Amazon CloudWatch.
CloudWatchLoggingOptionId -> (строка)
LogStreamARN -> (строка)
RoleARN -> (строка)
IAM ARN роли, которая будет использоваться для отправки сообщений приложения.
Примечание
Предоставлено для обратной совместимости. Приложения, созданные с текущей версией API, имеют роль выполнения службы на уровне приложения, а не на уровне ресурса.ApplicationMaintenanceConfigurationDescription -> (структура)
Подробности конфигурации технического обслуживания для приложения.
ApplicationMaintenanceWindowStartTime -> (строка)
ApplicationMaintenanceWindowEndTime -> (строка)
ApplicationVersionUpdatedFrom -> (длинное целое)
ApplicationVersionRolledBackFrom -> (длинное целое)
RollbackApplication был вызван.ApplicationVersionCreateTimestamp -> (временная метка)
ConditionalToken -> (строка)
ApplicationVersionRolledBackTo -> (длинное целое)
ApplicationMode -> (строка)
INTERACTIVE. Однако для управляемой службы для приложения Apache Flink режим является необязательным.
© Copyright 2025, Amazon Web Services. Created using Sphinx.