Spec-Zone.ru › AWS CLI v2

[ aws . kinesisanalytics ]

describe-application

Описание

Примечание

Данная документация предназначена для версии 1 API Amazon Kinesis Data Analytics, которая поддерживает только SQL-приложения. Версия 2 API поддерживает SQL и Java-приложения. Для получения дополнительной информации о версии 2 см. Документацию API Amazon Kinesis Data Analytics V2 .

Возвращает информацию об определённом приложении Amazon Kinesis Analytics.

Если вам нужно получить список всех приложений в вашей учётной записи, используйте операцию ListApplications.

Для этой операции требуются разрешения на выполнение действия kinesisanalytics:DescribeApplication. Вы можете использовать DescribeApplication для получения текущей версии приложения versionId, которая необходима для вызова других операций, таких как Update .

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

Синтаксис

  describe-application
--application-name <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 (строка)

Имя приложения.

--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
  • таблица
  • 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) приложения, состояние, последнюю версию и сведения о конфигурации входных и выходных данных.

ApplicationName -> (строка)

Имя приложения.

ApplicationDescription -> (строка)

Описание приложения.

ApplicationARN -> (строка)

ARN приложения.

ApplicationStatus -> (строка)

Состояние приложения.

CreateTimestamp -> (отметка времени)

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

LastUpdateTimestamp -> (отметка времени)

Отметка времени последнего обновления приложения.

InputDescriptions -> (список)

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

(структура)

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

InputId -> (строка)

Идентификатор входных данных, связанных с входными данными приложения. Это ID, который Amazon Kinesis Analytics назначает каждой конфигурации входных данных, которую вы добавляете в свое приложение.

NamePrefix -> (строка)

Префикс имени внутри приложения.

InAppStreamNames -> (список)

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

(строка)

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

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

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

Предоставляет сведения о конфигурации связанного InputLambdaProcessorDescription .

ResourceARN -> (строка)

ARN функции AWS Lambda, используемой для предварительной обработки записей в потоке.

RoleARN -> (строка)

ARN роли IAM, используемой для доступа к функции AWS Lambda.

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

Если поток Amazon Kinesis настроен в качестве источника потоковой передачи, предоставляет Amazon Resource Name (ARN) потока Amazon Kinesis и роль IAM, которая позволяет Amazon Kinesis Analytics получать доступ к потоку от вашего имени.

ResourceARN -> (строка)

Amazon Resource Name (ARN) потока Amazon Kinesis.

RoleARN -> (строка)

ARN роли IAM, которую Amazon Kinesis Analytics может принять, чтобы получить доступ к потоку.

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

Если поток доставки Amazon Kinesis Firehose настроен в качестве источника потоковой передачи, предоставляет ARN потока доставки и роль IAM, которая позволяет Amazon Kinesis Analytics получить доступ к потоку от вашего имени.

ResourceARN -> (строка)

Amazon Resource Name (ARN) потока доставки Amazon Kinesis Firehose.

RoleARN -> (строка)

ARN роли IAM, которую Amazon Kinesis Analytics принимает для доступа к потоку.

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

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

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

Указывает формат записей в источнике потоковой передачи.

RecordFormatType -> (строка)

Тип формата записи.

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

При настройке входных данных приложения во время создания или обновления приложения предоставляет дополнительную информацию о сопоставлении, специфичную для формата записи (например, JSON, CSV или поля записей, разделяемые каким-либо разделителем), в источнике потоковой передачи.

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

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

RecordRowPath -> (строка)

Путь к родительскому элементу верхнего уровня, содержащему записи.

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

Предоставляет дополнительную информацию о сопоставлении, когда формат записи использует разделители (например, CSV).

RecordRowDelimiter -> (строка)

Разделитель строк. Например, в формате CSV ‘n’ является типичным разделителем строк.

RecordColumnDelimiter -> (строка)

Разделитель столбцов. Например, в формате CSV запятая («,») является типичным разделителем столбцов.

RecordEncoding -> (строка)

Указывает кодировку записей в источнике потоковой передачи. Например, UTF-8.

RecordColumns -> (список)

Список объектов RecordColumn.

(структура)

Описывает сопоставление каждого элемента данных в источнике потоковой передачи с соответствующим столбцом в потоке внутри приложения.

Также используется для описания формата источника справочных данных.

Name -> (строка)

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

Mapping -> (строка)

Ссылка на элемент данных в входных данных потоковой передачи или источнике справочных данных. Этот элемент требуется, если RecordFormatType имеет значение JSON.

SqlType -> (строка)

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

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

Описывает настроенную параллельность (количество потоков внутри приложения, сопоставленных с источником потоковой передачи).

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

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

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

Точка, с которой приложение настраивается для чтения из потока входных данных.

InputStartingPosition -> (строка)

Начальная позиция в потоке.

  • NOW - Начать чтение сразу после последней записи в потоке, начать с метки времени запроса, выданного клиентом.
  • TRIM_HORIZON - Начать чтение с последней не обрезаемой записи в потоке, которая является самой старой записью, доступной в потоке. Этот параметр недоступен для потока доставки Amazon Kinesis Firehose.
  • LAST_STOPPED_POINT - Возобновить чтение с места, где приложение последний раз остановилось при чтении.

OutputDescriptions -> (список)

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

(структура)

Описывает конфигурацию выходных данных приложения, которая включает имя потока внутри приложения и место назначения, куда записываются данные потока. Место назначения может быть потоком Amazon Kinesis или потоком доставки Amazon Kinesis Firehose.

OutputId -> (строка)

Уникальный идентификатор конфигурации выходных данных.

Name -> (строка)

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

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

Описывает поток Amazon Kinesis, настроенный в качестве места назначения для записи выходных данных.

ResourceARN -> (строка)

Amazon Resource Name (ARN) потока Amazon Kinesis.

RoleARN -> (строка)

ARN роли IAM, которую Amazon Kinesis Analytics может принять для доступа к потоку.

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

Описывает поток доставки Amazon Kinesis Firehose, настроенный в качестве места назначения для записи выходных данных.

ResourceARN -> (строка)

Amazon Resource Name (ARN) потока доставки Amazon Kinesis Firehose.

RoleARN -> (строка)

ARN роли IAM, которую Amazon Kinesis Analytics может принять для доступа к потоку.

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

Описывает функцию AWS Lambda, настроенную в качестве места назначения для записи выходных данных.

ResourceARN -> (строка)

Amazon Resource Name (ARN) целевой функции Lambda.

RoleARN -> (строка)

ARN роли IAM, которую Amazon Kinesis Analytics может принять для записи в целевую функцию.

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

Формат данных, используемый для записи данных в место назначения.

RecordFormatType -> (строка)

Указывает формат записей в выходном потоке.

ReferenceDataSourceDescriptions -> (список)

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

(структура)

Описывает источник данных справочника, настроенный для приложения.

ReferenceId -> (строка)

Идентификатор источника данных справочника. Это идентификатор, который Amazon Kinesis Analytics назначает при добавлении источника данных справочника к вашему приложению с помощью операции AddApplicationReferenceDataSource.

TableName -> (строка)

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

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

Предоставляет имя ведра S3, имя ключа объекта, содержащего данные справочника. Также предоставляет Amazon Resource Name (ARN) роли IAM, которую Amazon Kinesis Analytics может использовать для чтения объекта Amazon S3 и заполнения таблицы справочника в приложении.

BucketARN -> (строка)

Amazon Resource Name (ARN) ведра S3.

FileKey -> (строка)

Имя ключа объекта Amazon S3.

ReferenceRoleARN -> (строка)

ARN роли IAM, которую Amazon Kinesis Analytics может использовать для чтения объекта Amazon S3 от вашего имени для заполнения таблицы справочника в приложении.

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

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

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

Указывает формат записей в источнике потока.

RecordFormatType -> (строка)

Тип формата записи.

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

При настройке входных данных приложения во время создания или обновления приложения предоставляет дополнительную информацию для сопоставления, специфичную для формата записи (например, JSON, CSV или полей записи, разделенных разделителем) в источнике потока.

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

Предоставляет дополнительную информацию для сопоставления, когда формат записи в источнике потока — JSON.

RecordRowPath -> (строка)

Путь к родительскому элементу верхнего уровня, содержащему записи.

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

Предоставляет дополнительную информацию для сопоставления, когда формат записи использует разделители (например, CSV).

RecordRowDelimiter -> (строка)

Разделитель строк. Например, в формате CSV типичным разделителем строк является ‘n’.

RecordColumnDelimiter -> (строка)

Разделитель столбцов. Например, в формате CSV типичным разделителем столбцов является запятая (“,”).

RecordEncoding -> (строка)

Указывает кодировку записей в источнике потока. Например, UTF-8.

RecordColumns -> (список)

Список RecordColumn объектов.

(структура)

Описывает сопоставление каждого элемента данных в источнике потока с соответствующим столбцом в потоке приложения.

Также используется для описания формата источника данных справочника.

Name -> (строка)

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

Mapping -> (строка)

Ссылка на элемент данных в входном потоке или источнике данных справочника. Этот элемент обязателен, если RecordFormatType равен JSON.

SqlType -> (строка)

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

CloudWatchLoggingOptionDescriptions -> (список)

Описывает потоки журналов CloudWatch, настроенные для получения сообщений приложения. Дополнительную информацию об использовании потоков журналов CloudWatch с приложениями Amazon Kinesis Analytics см. в разделе Работа с Amazon CloudWatch Logs.

(структура)

Описание параметра ведения журнала CloudWatch.

CloudWatchLoggingOptionId -> (строка)

Идентификатор описания параметра ведения журнала CloudWatch.

LogStreamARN -> (строка)

ARN потока журнала CloudWatch для получения сообщений приложения.

RoleARN -> (строка)

IAM ARN роли, используемой для отправки сообщений приложения. Примечание: для записи сообщений приложения в CloudWatch роль IAM должна иметь включенное действие политики PutLogEvents.

ApplicationCode -> (строка)

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

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

Предоставляет текущую версию приложения.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API