[ aws . kinesisanalyticsv2 ]
update-application
Описание
Обновляет существующее приложение Managed Service для Apache Flink. С помощью этой операции можно обновить код приложения, конфигурацию входных данных и конфигурацию выходных данных.
Managed Service для Apache Flink обновляет ApplicationVersionId каждый раз, когда вы обновляете свое приложение.
См. также: Документацию API AWS
Синтаксис
update-application
--application-name <value>
[--current-application-version-id <value>]
[--application-configuration-update <value>]
[--service-execution-role-update <value>]
[--run-configuration-update <value>]
[--cloud-watch-logging-option-updates <value>]
[--conditional-token <value>]
[--runtime-environment-update <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 (строка)
--current-application-version-id (целое число)
CurrentApplicationVersionId или ConditionalToken . Вы можете получить идентификатор версии приложения, используя DescribeApplication . Для лучшей поддержки одновременных операций используйте параметр ConditionalToken вместо CurrentApplicationVersionId .--application-configuration-update (структура)
Описание обновлений конфигурации приложения.
SqlApplicationConfigurationUpdate -> (структура)
Описание обновлений конфигурации приложения Kinesis Data Analytics на основе SQL.
InputUpdates -> (список)
Массив объектов InputUpdate, описывающих новые входные потоки, используемые приложением.
(структура)
Для приложения Kinesis Data Analytics на основе SQL описывает обновления определенной конфигурации ввода (определенной по InputId приложения).
InputId -> (строка)
NamePrefixUpdate -> (строка)
InputProcessingConfigurationUpdate -> (структура)
Описание обновлений InputProcessingConfiguration.
InputLambdaProcessorUpdate -> (структура)
Предоставляет информацию об обновлении InputLambdaProcessor.
ResourceARNUpdate -> (строка)
Amazon Resource Name (ARN) новой функции Amazon Lambda, используемой для предварительной обработки записей в потоке.
Примечание
Чтобы указать предыдущую версию функции Lambda, чем последняя, включите версию функции Lambda в ARN функции Lambda. Дополнительную информацию об ARN Lambda см. в примере ARN: Amazon LambdaKinesisStreamsInputUpdate -> (структура)
Если источником потока является поток Kinesis, предоставляет обновлённый Amazon Resource Name (ARN) потока.
ResourceARNUpdate -> (строка)
KinesisFirehoseInputUpdate -> (структура)
Если источником потока является поток Kinesis Data Firehose, предоставляет обновлённый ARN потока.
ResourceARNUpdate -> (строка)
InputSchemaUpdate -> (структура)
Описывает формат данных в источнике потока и как элементы записей в источнике потока сопоставляются с столбцами потока внутри приложения.
RecordFormatUpdate -> (структура)
Определяет формат записей в источнике потока.
RecordFormatType -> (строка)
MappingParameters -> (структура)
При настройке входных данных приложения при создании или обновлении приложения предоставляет дополнительную информацию о сопоставлении, специфичную для формата записей (например, JSON, CSV или поля записей, разделяемые разделителем) в источнике потока.
JSONMappingParameters -> (структура)
Предоставляет дополнительную информацию о сопоставлении, когда формат записей в источнике потока — JSON.
RecordRowPath -> (строка)
CSVMappingParameters -> (структура)
Предоставляет дополнительную информацию о сопоставлении, когда формат записей использует разделители (например, CSV).
RecordRowDelimiter -> (строка)
RecordColumnDelimiter -> (строка)
RecordEncodingUpdate -> (строка)
RecordColumnUpdates -> (список)
Список объектов RecordColumn. Каждый объект описывает сопоставление элемента источника потока с соответствующим столбцом в потоке внутри приложения.
(структура)
Для приложения Kinesis Data Analytics на основе SQL описывает сопоставление каждого элемента данных в источнике потока с соответствующим столбцом в потоке внутри приложения. Также используется для описания формата источника справочных данных.
Name -> (строка)
Mapping -> (строка)
SqlType -> (строка)
InputParallelismUpdate -> (структура)
Описание обновлений параллелизма (количество потоков внутри приложения, которые Kinesis Data Analytics создаёт для указанного источника потоков).
CountUpdate -> (целое число)
OutputUpdates -> (список)
Массив объектов OutputUpdate, описывающих новые выходные потоки, используемые приложением.
(структура)
Для приложения Kinesis Data Analytics на основе SQL описывает обновления конфигурации вывода, идентифицированные по OutputId.
OutputId -> (строка)
NameUpdate -> (строка)
KinesisStreamsOutputUpdate -> (структура)
Описывает поток Kinesis в качестве назначения для вывода.
ResourceARNUpdate -> (строка)
KinesisFirehoseOutputUpdate -> (структура)
Описывает поток Kinesis Data Firehose в качестве назначения для вывода.
ResourceARNUpdate -> (строка)
LambdaOutputUpdate -> (структура)
Описывает функцию Amazon Lambda в качестве назначения для вывода.
ResourceARNUpdate -> (строка)
Amazon Resource Name (ARN) целевой функции Amazon Lambda.
Примечание
Чтобы указать предыдущую версию функции Lambda, чем последнюю, включите версию функции Lambda в ARN функции Lambda. Дополнительную информацию об ARN Lambda см. в примере ARN: Amazon LambdaDestinationSchemaUpdate -> (структура)
Описывает формат данных при записи записей в назначение.
RecordFormatType -> (строка)
ReferenceDataSourceUpdates -> (список)
Массив объектов ReferenceDataSourceUpdate, описывающих новые источники справочных данных, используемые приложением.
(структура)
При обновлении конфигурации источника справочных данных для приложения Kinesis Data Analytics на основе SQL этот объект предоставляет все обновлённые значения (такие как имя ведра S3 и имя ключа объекта), имя таблицы внутри приложения, которое создаётся, и обновлённую информацию о сопоставлении, которая сопоставляет данные в объекте Amazon S3 с справочной таблицей внутри приложения, которая создаётся.
ReferenceId -> (строка)
TableNameUpdate -> (строка)
S3ReferenceDataSourceUpdate -> (структура)
Описывает имя ведра S3, имя ключа объекта и роль IAM, которую Kinesis Data Analytics может принять для чтения объекта Amazon S3 от вашего имени и заполнения справочной таблицы внутри приложения.
BucketARNUpdate -> (строка)
FileKeyUpdate -> (строка)
ReferenceSchemaUpdate -> (структура)
Описывает формат данных в источнике потока и как каждый элемент данных сопоставляется с соответствующими столбцами, созданными в потоке внутри приложения.
RecordFormat -> (структура)
Определяет формат записей в источнике потока.
RecordFormatType -> (строка)
MappingParameters -> (структура)
При настройке входных данных приложения при создании или обновлении приложения предоставляет дополнительную информацию о сопоставлении, специфичную для формата записей (например, JSON, CSV или поля записей, разделяемые разделителем) в источнике потока.
JSONMappingParameters -> (структура)
Предоставляет дополнительную информацию о сопоставлении, когда формат записей в источнике потока — JSON.
RecordRowPath -> (строка)
CSVMappingParameters -> (структура)
Предоставляет дополнительную информацию о сопоставлении, когда формат записей использует разделители (например, CSV).
RecordRowDelimiter -> (строка)
RecordColumnDelimiter -> (строка)
RecordEncoding -> (строка)
RecordColumns -> (список)
Список объектов RecordColumn.
(структура)
Для приложения Kinesis Data Analytics на основе SQL описывает сопоставление каждого элемента данных в источнике потока с соответствующим столбцом в потоке внутри приложения. Также используется для описания формата источника справочных данных.
Name -> (строка)
Mapping -> (строка)
SqlType -> (строка)
ApplicationCodeConfigurationUpdate -> (структура)
Описание обновлений конфигурации кода приложения.
CodeContentTypeUpdate -> (строка)
CodeContentUpdate -> (структура)
Описание обновлений содержимого кода приложения.
TextContentUpdate -> (строка)
ZipFileContentUpdate -> (бинарный)
S3ContentLocationUpdate -> (структура)
Описание обновления расположения кода приложения.
BucketARNUpdate -> (строка)
FileKeyUpdate -> (строка)
ObjectVersionUpdate -> (строка)
FlinkApplicationConfigurationUpdate -> (структура)
Описывает обновления конфигурации приложения Managed Service for Apache Flink.
CheckpointConfigurationUpdate -> (структура)
Описывает обновления конфигурации создания контрольных точек приложения. Создание контрольных точек — это процесс сохранения состояния приложения для обеспечения отказоустойчивости.
ConfigurationTypeUpdate -> (строка)
Описывает обновления о том, использует ли приложение поведение по умолчанию для создания контрольных точек Managed Service for Apache Flink. Необходимо установить это свойство в CUSTOM, чтобы задать параметры CheckpointingEnabled, CheckpointInterval или MinPauseBetweenCheckpoints.
Примечание
Если это значение установлено в DEFAULT, приложение будет использовать следующие значения, даже если они установлены другими значениями с помощью API или кода приложения:
- CheckpointingEnabled: true
- CheckpointInterval: 60000
- MinPauseBetweenCheckpoints: 5000
CheckpointingEnabledUpdate -> (булево)
Описывает обновления о том, включено ли создание контрольных точек для приложения.
Примечание
ЕслиCheckpointConfiguration.ConfigurationType равно DEFAULT, приложение будет использовать значение CheckpointingEnabled равное true, даже если это значение установлено другим значением с помощью этого API или в коде приложения.CheckpointIntervalUpdate -> (длинное целое число)
Описывает обновления интервала в миллисекундах между операциями создания контрольных точек.
Примечание
ЕслиCheckpointConfiguration.ConfigurationType равно DEFAULT, приложение будет использовать значение CheckpointInterval равное 60000, даже если это значение установлено другим значением с помощью этого API или в коде приложения.MinPauseBetweenCheckpointsUpdate -> (длинное целое число)
Описывает обновления минимального времени в миллисекундах после завершения операции создания контрольной точки, через которое может начаться новая операция создания контрольной точки.
Примечание
ЕслиCheckpointConfiguration.ConfigurationType равно DEFAULT, приложение будет использовать значение MinPauseBetweenCheckpoints равное 5000, даже если это значение установлено с помощью этого API или в коде приложения.MonitoringConfigurationUpdate -> (структура)
Описывает обновления параметров конфигурации ведения журнала Amazon CloudWatch для приложения.
ConfigurationTypeUpdate -> (строка)
CUSTOM, чтобы задать параметры LogLevel или MetricsLevel.MetricsLevelUpdate -> (строка)
Parallelism не рекомендуется для приложений с параллелизмом более 64 из-за чрезмерных затрат.LogLevelUpdate -> (строка)
ParallelismConfigurationUpdate -> (структура)
Описывает обновления параметров для того, как приложение выполняет несколько задач одновременно.
ConfigurationTypeUpdate -> (строка)
CUSTOM, чтобы изменить свойства приложения AutoScalingEnabled, Parallelism или ParallelismPerKPU.ParallelismUpdate -> (целое число)
AutoScalingEnabled установлено в True, Managed Service for Apache Flink может увеличить значение CurrentParallelism в ответ на нагрузку приложения. Сервис может увеличить CurrentParallelism до максимального параллелизма, который составляет ParalellismPerKPU раз максимальное количество KPUs для приложения. Максимальное количество KPUs для приложения по умолчанию равно 32 и может быть увеличено по запросу. Если нагрузка приложения уменьшается, сервис уменьшит CurrentParallelism до значения Parallelism.ParallelismPerKPUUpdate -> (целое число)
AutoScalingEnabledUpdate -> (булево)
EnvironmentPropertyUpdates -> (структура)
Описывает обновления свойств среды для приложения Managed Service for Apache Flink.
PropertyGroups -> (список)
Описывает обновления групп свойств выполнения.
(структура)
Пара ключ-значение свойств, передаваемых в приложение.
PropertyGroupId -> (строка)
PropertyMap -> (отображение)
Описывает значение пары ключ-значение свойства выполнения приложения.
key -> (строка)
value -> (строка)
ApplicationSnapshotConfigurationUpdate -> (структура)
Описывает, включены ли снимки для приложения Managed Service for Apache Flink.
SnapshotsEnabledUpdate -> (булево)
ApplicationSystemRollbackConfigurationUpdate -> (структура)
Описывает конфигурацию отката системы для приложения Managed Service for Apache Flink.
RollbackEnabledUpdate -> (булево)
VpcConfigurationUpdates -> (список)
Обновления массива описаний конфигураций VPC, доступных для приложения.
(структура)
Описывает обновления конфигурации VPC, используемой приложением.
VpcConfigurationId -> (строка)
SubnetIdUpdates -> (список)
Описывает обновления массива идентификаторов подсетей, используемых конфигурацией VPC.
(строка)
SecurityGroupIdUpdates -> (список)
Описывает обновления массива идентификаторов SecurityGroup, используемых конфигурацией VPC.
(строка)
ZeppelinApplicationConfigurationUpdate -> (структура)
Обновления конфигурации блокнота Managed Service for Apache Flink Studio.
MonitoringConfigurationUpdate -> (структура)
Обновления конфигурации мониторинга блокнота Managed Service for Apache Flink Studio.
LogLevelUpdate -> (строка)
CatalogConfigurationUpdate -> (структура)
Обновления конфигурации каталога данных Amazon Glue, связанного с блокнотом Managed Service for Apache Flink Studio.
GlueDataCatalogConfigurationUpdate -> (структура)
Обновления параметров конфигурации для базы данных Amazon Glue по умолчанию. Вы используете эту базу данных для SQL-запросов, которые вы пишете в блокноте Managed Service for Apache Flink Studio.
DatabaseARNUpdate -> (строка)
DeployAsApplicationConfigurationUpdate -> (структура)
Обновления конфигурации, необходимой для развертывания блокнота Amazon Data Analytics Studio в качестве приложения с долговременным состоянием.
S3ContentLocationUpdate -> (структура)
Обновления расположения, в котором хранятся данные, необходимые для указания приложения Amazon Data Analytics.
BucketARNUpdate -> (строка)
BasePathUpdate -> (строка)
CustomArtifactsConfigurationUpdate -> (список)
Обновления пользовательских артефактов. Пользовательские артефакты — это файлы JAR зависимостей и пользовательские функции (UDF).
(структура)
Указывает JAR-файлы зависимостей, а также JAR-файлы, содержащие пользовательские функции (UDF).
ArtifactType -> (строка)
UDF обозначает пользовательские функции. Этот тип артефакта должен находиться в корзине S3. DEPENDENCY_JAR может находиться как в Maven, так и в корзине S3.S3ContentLocation -> (структура)
Для приложения Managed Service for Apache Flink предоставляет описание объекта Amazon S3, включая Amazon Resource Name (ARN) корзины S3, имя объекта Amazon S3, содержащего данные, и номер версии объекта Amazon S3, содержащего данные.
BucketARN -> (строка)
FileKey -> (строка)
ObjectVersion -> (строка)
MavenReference -> (структура)
Параметры, необходимые для полного указания ссылки Maven.
GroupId -> (строка)
ArtifactId -> (строка)
Version -> (строка)
Синтаксис JSON:
{
"SqlApplicationConfigurationUpdate": {
"InputUpdates": [
{
"InputId": "string",
"NamePrefixUpdate": "string",
"InputProcessingConfigurationUpdate": {
"InputLambdaProcessorUpdate": {
"ResourceARNUpdate": "string"
}
},
"KinesisStreamsInputUpdate": {
"ResourceARNUpdate": "string"
},
"KinesisFirehoseInputUpdate": {
"ResourceARNUpdate": "string"
},
"InputSchemaUpdate": {
"RecordFormatUpdate": {
"RecordFormatType": "JSON"|"CSV",
"MappingParameters": {
"JSONMappingParameters": {
"RecordRowPath": "string"
},
"CSVMappingParameters": {
"RecordRowDelimiter": "string",
"RecordColumnDelimiter": "string"
}
}
},
"RecordEncodingUpdate": "string",
"RecordColumnUpdates": [
{
"Name": "string",
"Mapping": "string",
"SqlType": "string"
}
...
]
},
"InputParallelismUpdate": {
"CountUpdate": integer
}
}
...
],
"OutputUpdates": [
{
"OutputId": "string",
"NameUpdate": "string",
"KinesisStreamsOutputUpdate": {
"ResourceARNUpdate": "string"
},
"KinesisFirehoseOutputUpdate": {
"ResourceARNUpdate": "string"
},
"LambdaOutputUpdate": {
"ResourceARNUpdate": "string"
},
"DestinationSchemaUpdate": {
"RecordFormatType": "JSON"|"CSV"
}
}
...
],
"ReferenceDataSourceUpdates": [
{
"ReferenceId": "string",
"TableNameUpdate": "string",
"S3ReferenceDataSourceUpdate": {
"BucketARNUpdate": "string",
"FileKeyUpdate": "string"
},
"ReferenceSchemaUpdate": {
"RecordFormat": {
"RecordFormatType": "JSON"|"CSV",
"MappingParameters": {
"JSONMappingParameters": {
"RecordRowPath": "string"
},
"CSVMappingParameters": {
"RecordRowDelimiter": "string",
"RecordColumnDelimiter": "string"
}
}
},
"RecordEncoding": "string",
"RecordColumns": [
{
"Name": "string",
"Mapping": "string",
"SqlType": "string"
}
...
]
}
}
...
]
},
"ApplicationCodeConfigurationUpdate": {
"CodeContentTypeUpdate": "PLAINTEXT"|"ZIPFILE",
"CodeContentUpdate": {
"TextContentUpdate": "string",
"ZipFileContentUpdate": blob,
"S3ContentLocationUpdate": {
"BucketARNUpdate": "string",
"FileKeyUpdate": "string",
"ObjectVersionUpdate": "string"
}
}
},
"FlinkApplicationConfigurationUpdate": {
"CheckpointConfigurationUpdate": {
"ConfigurationTypeUpdate": "DEFAULT"|"CUSTOM",
"CheckpointingEnabledUpdate": true|false,
"CheckpointIntervalUpdate": long,
"MinPauseBetweenCheckpointsUpdate": long
},
"MonitoringConfigurationUpdate": {
"ConfigurationTypeUpdate": "DEFAULT"|"CUSTOM",
"MetricsLevelUpdate": "APPLICATION"|"TASK"|"OPERATOR"|"PARALLELISM",
"LogLevelUpdate": "INFO"|"WARN"|"ERROR"|"DEBUG"
},
"ParallelismConfigurationUpdate": {
"ConfigurationTypeUpdate": "DEFAULT"|"CUSTOM",
"ParallelismUpdate": integer,
"ParallelismPerKPUUpdate": integer,
"AutoScalingEnabledUpdate": true|false
}
},
"EnvironmentPropertyUpdates": {
"PropertyGroups": [
{
"PropertyGroupId": "string",
"PropertyMap": {"string": "string"
...}
}
...
]
},
"ApplicationSnapshotConfigurationUpdate": {
"SnapshotsEnabledUpdate": true|false
},
"ApplicationSystemRollbackConfigurationUpdate": {
"RollbackEnabledUpdate": true|false
},
"VpcConfigurationUpdates": [
{
"VpcConfigurationId": "string",
"SubnetIdUpdates": ["string", ...],
"SecurityGroupIdUpdates": ["string", ...]
}
...
],
"ZeppelinApplicationConfigurationUpdate": {
"MonitoringConfigurationUpdate": {
"LogLevelUpdate": "INFO"|"WARN"|"ERROR"|"DEBUG"
},
"CatalogConfigurationUpdate": {
"GlueDataCatalogConfigurationUpdate": {
"DatabaseARNUpdate": "string"
}
},
"DeployAsApplicationConfigurationUpdate": {
"S3ContentLocationUpdate": {
"BucketARNUpdate": "string",
"BasePathUpdate": "string"
}
},
"CustomArtifactsConfigurationUpdate": [
{
"ArtifactType": "UDF"|"DEPENDENCY_JAR",
"S3ContentLocation": {
"BucketARN": "string",
"FileKey": "string",
"ObjectVersion": "string"
},
"MavenReference": {
"GroupId": "string",
"ArtifactId": "string",
"Version": "string"
}
}
...
]
}
}
--service-execution-role-update (строка)
--run-configuration-update (структура)
Описывает обновления параметров запуска приложения.
FlinkRunConfiguration -> (структура)
Описывает параметры запуска приложения Managed Service для Apache Flink.
AllowNonRestoredState -> (логическое)
При восстановлении из моментального снимка указывает, разрешено ли времени выполнения пропустить состояние, которое не может быть сопоставлено с новой программой. Это произойдет, если программа обновлена между моментальными снимками для удаления состояний параметров и данные состояния в снимке больше не соответствуют допустимым данным приложения. Для получения дополнительной информации см. Раздел «Разрешение невосстановленного состояния» в документации Apache Flink.
Примечание
Это значение по умолчанию равноfalse. Если вы обновите приложение, не указав этот параметр, AllowNonRestoredState будет установлено в false, даже если ранее оно было установлено в true.ApplicationRestoreConfiguration -> (структура)
Описывает обновления поведения восстановления перезапускаемого приложения.
ApplicationRestoreType -> (строка)
SnapshotName -> (строка)
RESTORE_FROM_CUSTOM_SNAPSHOT указано для ApplicationRestoreType.Сокращенная синтаксическая запись:
FlinkRunConfiguration={AllowNonRestoredState=boolean},ApplicationRestoreConfiguration={ApplicationRestoreType=string,SnapshotName=string}
Синтаксис JSON:
{
"FlinkRunConfiguration": {
"AllowNonRestoredState": true|false
},
"ApplicationRestoreConfiguration": {
"ApplicationRestoreType": "SKIP_RESTORE_FROM_SNAPSHOT"|"RESTORE_FROM_LATEST_SNAPSHOT"|"RESTORE_FROM_CUSTOM_SNAPSHOT",
"SnapshotName": "string"
}
}
--cloud-watch-logging-option-updates (список)
Описывает обновления параметров ведения журнала приложения в Amazon CloudWatch. Вы можете обновлять только существующие параметры ведения журнала CloudWatch с помощью этого действия. Чтобы добавить новый параметр ведения журнала CloudWatch, используйте AddApplicationCloudWatchLoggingOption.
(структура)
Описывает обновления параметров ведения журнала Amazon CloudWatch.
CloudWatchLoggingOptionId -> (строка)
LogStreamARNUpdate -> (строка)
Сокращенная синтаксическая запись:
CloudWatchLoggingOptionId=string,LogStreamARNUpdate=string ...
Синтаксис JSON:
[
{
"CloudWatchLoggingOptionId": "string",
"LogStreamARNUpdate": "string"
}
...
]
--conditional-token (строка)
CurrentApplicationVersionId или ConditionalToken. Текущее ConditionalToken приложения можно получить с помощью DescribeApplication. Для лучшей поддержки конкурентности используйте параметр ConditionalToken вместо CurrentApplicationVersionId.--runtime-environment-update (строка)
Обновляет среду выполнения Managed Service для Apache Flink, используемую для выполнения вашего кода. Чтобы избежать проблем, необходимо:
- Убедиться, что ваш новый JAR и зависимости совместимы с выбранной новой средой выполнения.
- Убедиться, что состояние вашего нового кода совместимо со снимком, с которого начнёт работу ваше приложение.
Возможные значения:
SQL-1_0FLINK-1_6FLINK-1_8ZEPPELIN-FLINK-1_0FLINK-1_11FLINK-1_13ZEPPELIN-FLINK-2_0FLINK-1_15ZEPPELIN-FLINK-3_0FLINK-1_18FLINK-1_19FLINK-1_20
--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
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для использования при фильтрации данных ответа.
--profile (строка)
Использовать определённый профиль из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет параметры конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/отключить цветной вывод.
- on
- off
- auto
--no-sign-request (логическое)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл сертификатов CA для использования при проверке сертификатов SSL. Переопределяет параметры конфигурации/среды.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, который будет использоваться для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде base64-кодированной строки. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичное и будет использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (логическое)
Отключить вывод страницы cli.
--cli-auto-prompt (логическое)
Автоматически запросить параметры входных данных CLI.
--no-cli-auto-prompt (логическое)
Отключить автоматическое запроса параметров входных данных CLI.
Вывод
ApplicationDetail -> (структура)
Описание обновлений приложения.
ApplicationARN -> (строка)
ApplicationDescription -> (строка)
ApplicationName -> (строка)
RuntimeEnvironment -> (строка)
ServiceExecutionRole -> (строка)
ApplicationStatus -> (строка)
ApplicationVersionId -> (целое число)
ApplicationVersionId каждый раз при обновлении приложения.CreateTimestamp -> (метка времени)
LastUpdateTimestamp -> (метка времени)
ApplicationConfigurationDescription -> (структура)
Описание кода приложения и параметров запуска для приложения Managed Service для 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 for Apache Flink.
CodeContentType -> (строка)
CodeContentDescription -> (структура)
Описывает информацию о расположении и формате кода приложения.
TextContent -> (строка)
CodeMD5 -> (строка)
CodeSize -> (целое)
S3ApplicationCodeLocationDescription -> (структура)
Идентификатор ресурса Amazon (ARN) ведра S3, ключ файла и версия объекта кода приложения, хранящегося в Amazon S3.
BucketARN -> (строка)
FileKey -> (строка)
ObjectVersion -> (строка)
RunConfigurationDescription -> (структура)
Подробности о начальных свойствах приложения Managed Service for Apache Flink.
ApplicationRestoreConfigurationDescription -> (структура)
Описывает поведение восстановления перезапускающегося приложения.
ApplicationRestoreType -> (строка)
SnapshotName -> (строка)
RESTORE_FROM_CUSTOM_SNAPSHOT указано для ApplicationRestoreType .FlinkRunConfigurationDescription -> (структура)
Описывает начальные параметры приложения Managed Service for 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 -> (список)
Массив идентификаторов SecurityGroup, используемых конфигурацией 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 -> (timestamp)
ConditionalToken -> (string)
ApplicationVersionRolledBackTo -> (long)
ApplicationMode -> (string)
INTERACTIVE. Однако для Управляемой службы для приложения Apache Flink этот режим необязателен.OperationId -> (string)
© Copyright 2025, Amazon Web Services. Created using Sphinx.