[ aws . kinesisanalyticsv2 ]
описание-версии-приложения
Описание
Предоставляет подробное описание указанной версии приложения. Чтобы увидеть список всех версий приложения, вызовите операцию ListApplicationVersions.
Примечание
Данная операция поддерживается только для Managed Service for Apache Flink.См. также: Документацию API AWS
Синтаксис
describe-application-version
--application-name <value>
--application-version-id <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]
Параметры
--application-name (строка)
--application-version-id (целое число)
--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.
Вывод
ApplicationVersionDetail -> (структура)
Описывает приложение, включая имя приложения Amazon Resource Name (ARN), состояние, последнюю версию и конфигурации ввода и вывода.
ApplicationARN -> (строка)
ApplicationDescription -> (строка)
ApplicationName -> (строка)
RuntimeEnvironment -> (строка)
ServiceExecutionRole -> (строка)
ApplicationStatus -> (строка)
ApplicationVersionId -> (целое число)
ApplicationVersionId каждый раз, когда вы обновляете приложение.CreateTimestamp -> (метка времени)
LastUpdateTimestamp -> (метка времени)
ApplicationConfigurationDescription -> (структура)
Описывает подробности о коде приложения и параметрах запуска для приложения Managed Service for 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) ведра, ключ файла и версия объекта кода приложения, хранящегося в Amazon S3.
BucketARN -> (строка)
FileKey -> (строка)
ObjectVersion -> (строка)
RunConfigurationDescription -> (структура)
Подробности о начальных свойствах приложения Managed Service для Apache Flink.
ApplicationRestoreConfigurationDescription -> (структура)
Описывает поведение восстановления перезапускаемого приложения.
ApplicationRestoreType -> (строка)
SnapshotName -> (строка)
RESTORE_FROM_CUSTOM_SNAPSHOT указано для ApplicationRestoreType.FlinkRunConfigurationDescription -> (структура)
Описывает начальные параметры приложения Managed Service для Apache Flink.
AllowNonRestoredState -> (логическое значение)
При восстановлении из снимка указывает, разрешено ли времени выполнения пропускать состояние, которое не может быть отображено в новой программе. Это произойдет, если программа обновляется между снимками, чтобы удалить параметр состояния, а данные состояния в снимке больше не соответствуют допустимым данным приложения. Дополнительную информацию см. в документации Apache Flink в разделе «Разрешение невосстановленного состояния».
Примечание
Это значение по умолчанию —false. Если вы обновите приложение, не указав этот параметр, AllowNonRestoredState будет установлено в false, даже если ранее оно было установлено в true.FlinkApplicationConfigurationDescription -> (структура)
Подробности о приложении Managed Service for Apache Flink.
CheckpointConfigurationDescription -> (структура)
Описывает конфигурацию контрольных точек приложения. Контрольные точки — это процесс сохранения состояния приложения для обеспечения отказоустойчивости.
ConfigurationType -> (строка)
Описывает, использует ли приложение поведение по умолчанию для контрольных точек в Managed Service for Apache Flink.
Примечание
Если это значение установлено в DEFAULT, приложение будет использовать следующие значения, даже если они установлены другими значениями через API или код приложения:
- CheckpointingEnabled: true
- CheckpointInterval: 60000
- MinPauseBetweenCheckpoints: 5000
CheckpointingEnabled -> (логическое)
Описывает, включено ли создание контрольных точек для приложения Managed Service for 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 for Apache Flink может увеличить значение CurrentParallelism в ответ на нагрузку приложения. Сервис может увеличить CurrentParallelism до максимального параллелизма, который составляет ParalellismPerKPU раз максимальное количество KPUs для приложения. Максимальное количество KPUs для приложения по умолчанию составляет 32 и может быть увеличено путем запроса увеличения лимита. Если нагрузка приложения уменьшится, сервис может уменьшить значение CurrentParallelism до значения Parallelism.ParallelismPerKPU -> (целое число)
CurrentParallelism -> (целое число)
AutoScalingEnabled установлено в True, Managed Service for Apache Flink может увеличить это значение в ответ на нагрузку приложения. Сервис может увеличить это значение до максимального параллелизма, который равен ParalellismPerKPU умноженному на максимальное количество KPUs для приложения. Максимальное количество KPUs для приложения по умолчанию равно 32 и может быть увеличено путем запроса увеличения лимита. Если нагрузка приложения уменьшится, сервис может уменьшить значение CurrentParallelism до значения Parallelism.AutoScalingEnabled -> (логическое)
JobPlanDescription -> (строка)
EnvironmentPropertyDescriptions -> (структура)
Описывает свойства выполнения для приложения Managed Service for Apache Flink.
PropertyGroupDescriptions -> (список)
Описывает группы свойств выполнения.
(структура)
Ключевые пары свойств, передаваемые приложению.
PropertyGroupId -> (строка)
PropertyMap -> (карта)
Описывает значение пары "ключ-значение" свойства выполнения приложения.
key -> (строка)
value -> (строка)
ApplicationSnapshotConfigurationDescription -> (структура)
Описывает, включены ли снимки состояния для приложения Managed Service for Apache Flink.
SnapshotsEnabled -> (логическое)
ApplicationSystemRollbackConfigurationDescription -> (структура)
Описывает конфигурацию отката системы для приложения Managed Service for Apache Flink.
RollbackEnabled -> (логическое)
VpcConfigurationDescriptions -> (список)
Массив описаний конфигураций VPC, доступных для приложения.
(структура)
Описывает параметры VPC, используемого приложением.
VpcConfigurationId -> (строка)
VpcId -> (строка)
SubnetIds -> (список)
Массив идентификаторов подсетей, используемых конфигурацией VPC.
(строка)
SecurityGroupIds -> (список)
Массив идентификаторов групп безопасности, используемых конфигурацией VPC.
(строка)
ZeppelinApplicationConfigurationDescription -> (структура)
Параметры конфигурации для блокнота Managed Service for Apache Flink Studio.
MonitoringConfigurationDescription -> (структура)
Конфигурация мониторинга блокнота Managed Service for Apache Flink Studio.
LogLevel -> (строка)
CatalogConfigurationDescription -> (структура)
Amazon Glue Data Catalog, связанный с блокнотом Managed Service for Apache Flink Studio.
GlueDataCatalogConfigurationDescription -> (структура)
Параметры конфигурации по умолчанию для базы данных Amazon Glue. Вы используете эту базу данных для SQL-запросов, которые вы пишете в блокноте Managed Service for Apache Flink Studio.
DatabaseARN -> (строка)
DeployAsApplicationConfigurationDescription -> (структура)
Параметры, необходимые для развертывания блокнота Managed Service for Apache Flink Studio в качестве приложения с долговременным состоянием.
S3ContentLocationDescription -> (структура)
Расположение, содержащее данные, необходимые для указания приложения Amazon Data Analytics.
BucketARN -> (строка)
BasePath -> (строка)
CustomArtifactsConfigurationDescription -> (список)
Пользовательские артефакты — это зависимые JAR-файлы и пользовательские функции (UDF).
(структура)
Указывает зависимый JAR-файл или JAR-файл пользовательских функций.
ArtifactType -> (строка)
UDF означает пользовательские функции. Этот тип артефакта должен находиться в корзине S3. DEPENDENCY_JAR может находиться как в Maven, так и в корзине S3.S3ContentLocationDescription -> (структура)
Для приложения Managed Service for 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 -> (string)
ApplicationVersionRolledBackTo -> (long)
ApplicationMode -> (string)
INTERACTIVE. Однако для Управляемой службы для приложения Apache Flink этот режим является необязательным.
© Copyright 2025, Amazon Web Services. Created using Sphinx.