Spec-Zone.ru › AWS CLI v2

[ aws . timestream-query ]

describe-scheduled-query

Описание

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

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

Синтаксис

  describe-scheduled-query
--scheduled-query-arn <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]

Параметры

--scheduled-query-arn (строка)

ARN запланированного запроса.

--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.

--cli-auto-prompt (логическое значение)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

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

Расписание запроса.

Arn -> (строка)

ARN расписанного запроса.

Name -> (строка)

Имя расписанного запроса.

QueryString -> (строка)

Запрос, который будет выполнен.

CreationTime -> (временная метка)

Время создания расписанного запроса.

State -> (строка)

Состояние расписанного запроса.

PreviousInvocationTime -> (временная метка)

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

NextInvocationTime -> (временная метка)

Следующее время выполнения расписанного запроса.

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

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

ScheduleExpression -> (строка)

Выражение, обозначающее время запуска расписанного выполнения запроса. Это может быть выражение cron или выражение скорости.

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

Настройка уведомлений.

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

Подробности о настройке Amazon Simple Notification Service (SNS). Это поле отображается только при предоставлении темы SNS при обновлении настроек учетной записи.

TopicArn -> (строка)

ARN темы SNS, в которую будут отправляться уведомления о состоянии расписанного запроса.

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

Настройка назначения хранилища для расписанного запроса.

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

Настройки для записи данных в базу данных Timestream и таблицу.

DatabaseName -> (строка)

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

TableName -> (строка)

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

TimeColumn -> (строка)

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

DimensionMappings -> (список)

Это позволяет сопоставить столбцы из результата запроса с измерениями в целевой таблице.

(структура)

Этот тип используется для сопоставления столбцов из результата запроса с измерением в целевой таблице.

Name -> (строка)

Имя столбца из результата запроса.

DimensionValueType -> (строка)

Тип измерения.

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

Сопоставления для нескольких измерений.

TargetMultiMeasureName -> (строка)

Имя целевого имени для нескольких измерений в выведенной таблице. Этот параметр требуется, если столбец measureName не указан. Если столбец MeasureNameColumn указан, то значение из этого столбца будет использоваться как имя нескольких измерений.

MultiMeasureAttributeMappings -> (список)

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

(структура)

Сопоставление атрибутов для значений измерений MULTI.

SourceColumn -> (строка)

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

TargetMultiMeasureAttributeName -> (строка)

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

MeasureValueType -> (строка)

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

MixedMeasureMappings -> (список)

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

(структура)

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

MeasureName -> (строка)

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

SourceColumn -> (строка)

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

TargetMeasureName -> (строка)

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

MeasureValueType -> (строка)

Тип значения, который будет считан из SourceColumn. Если сопоставление для MULTI, используйте MeasureValueType.MULTI.

MultiMeasureAttributeMappings -> (список)

Требуется, когда measureValueType равен MULTI. Сопоставления атрибутов для значений измерений MULTI.

(структура)

Сопоставление атрибутов для значений измерений MULTI.

SourceColumn -> (строка)

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

TargetMultiMeasureAttributeName -> (строка)

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

MeasureValueType -> (строка)

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

MeasureNameColumn -> (строка)

Имя столбца измерения.

ScheduledQueryExecutionRoleArn -> (строка)

Роль IAM, которую Timestream использует для выполнения расписанного запроса.

KmsKeyId -> (строка)

Ключ KMS, предоставленный пользователем, используемый для шифрования ресурса расписанного запроса.

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

Настройка отчетов об ошибках для расписанного запроса.

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

Настройка S3 для отчетов об ошибках.

BucketName -> (строка)

Имя ведра S3, в котором будут создаваться отчеты об ошибках.

ObjectKeyPrefix -> (строка)

Префикс для ключа отчета об ошибках. Timestream по умолчанию добавляет следующий префикс к пути отчета об ошибках.

EncryptionOption -> (строка)

Параметры шифрования в состоянии покоя для отчетов об ошибках. Если не указан ни один параметр шифрования, Timestream выберет SSE_S3 по умолчанию.

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

Резюме выполнения последнего запуска расписанного запроса.

InvocationTime -> (временная метка)

InvocationTime для этого запуска. Это время, в которое запланирован запуск запроса. Параметр @scheduled_runtime может быть использован в запросе для получения значения.

TriggerTime -> (временная метка)

Фактическое время выполнения запроса.

RunStatus -> (строка)

Состояние выполнения расписанного запроса.

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

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

ExecutionTimeInMillis -> (длинное целое число)

Общее время в миллисекундах, необходимое для завершения расписанного запроса.

DataWrites -> (длинное целое число)

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

BytesMetered -> (длинное целое число)

Измеренные байты для одного выполнения расписанного запроса.

CumulativeBytesScanned -> (длинное целое число)

Измеренные байты для одного выполнения расписанного запроса.

RecordsIngested -> (длинное целое число)

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

QueryResultRows -> (длинное целое число)

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

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

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

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

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

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

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

  • Value – Максимальное соотношение пространственного охвата.
  • TableArn – Amazon Resource Name (ARN) таблицы с неэффективным пространственным прореживанием.
  • PartitionKey – Ключ разбиения, используемый для разбиения, который может быть по умолчанию measure_name или CDPK.

Value -> (двойное число)

Максимальное соотношение пространственного охвата.

TableArn -> (строка)

Amazon Resource Name (ARN) таблицы с наименее эффективным пространственным прореживанием.

PartitionKey -> (список)

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

(строка)

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

Предоставляет сведения о временном диапазоне запроса, включая таблицу с наибольшим (максимальным) временным диапазоном. Вот некоторые потенциальные варианты оптимизации временного прореживания:

  • Добавить недостающие временные предикаты.
  • Удалить функции вокруг временных предикатов.
  • Добавить временные предикаты ко всем подзапросам.

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

Содержит следующие свойства, предоставляющие сведения о таблице с наихудшей производительностью по временной оси:

  • Value – Максимальная продолжительность в наносекундах между началом и концом запроса.
  • TableArn – Amazon Resource Name (ARN) таблицы, которая запрашивается с наибольшим временным диапазоном.

Value -> (длинное целое число)

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

TableArn -> (строка)

Amazon Resource Name (ARN) таблицы, которая запрашивается с наибольшим временным диапазоном.

QueryTableCount -> (длинное целое число)

Указывает количество таблиц в запросе.

OutputRows -> (длинное целое число)

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

OutputBytes -> (длинное целое число)

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

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

Местоположение в S3 для отчета об ошибках.

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

Местоположение в S3, где записываются отчеты об ошибках.

BucketName -> (строка)

Имя ведра S3.

ObjectKey -> (строка)

Ключ S3.

FailureReason -> (строка)

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

RecentlyFailedRuns -> (список)

Краткое описание последнего запуска запланированного запроса, завершившегося ошибкой (за последние пять запусков).

(структура)

Описание запуска запланированного запроса

InvocationTime -> (временная метка)

Время вызова для данного запуска. Это время, в которое запланирован запуск запроса. Параметр @scheduled_runtime может быть использован в запросе для получения этого значения.

TriggerTime -> (временная метка)

Фактическое время запуска запроса.

RunStatus -> (строка)

Статус запуска запланированного запроса.

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

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

ExecutionTimeInMillis -> (длинное целое)

Общее время, измеренное в миллисекундах, необходимое для завершения запланированного запуска запроса.

DataWrites -> (длинное целое)

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

BytesMetered -> (длинное целое)

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

CumulativeBytesScanned -> (длинное целое)

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

RecordsIngested -> (длинное целое)

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

QueryResultRows -> (длинное целое)

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

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

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

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

Предоставляет сведения о пространственном охвате запроса, включая таблицу с неэффективными (максимальными) пространственными сокращениями. Эта информация может помочь вам определить области для улучшения стратегии разбиения, чтобы повысить эффективность пространственного сокращения.

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

Предоставляет сведения о пространственном охвате выполненного запроса и таблице с наименее эффективным пространственным сокращением.

  • Value – Максимальное соотношение пространственного охвата.
  • TableArn – Amazon Resource Name (ARN) таблицы с неэффективным пространственным сокращением.
  • PartitionKey – Ключ разбиения, используемый для разбиения, который может быть стандартным measure_name или CDPK.

Value -> (двойное число)

Максимальное соотношение пространственного охвата.

TableArn -> (строка)

Amazon Resource Name (ARN) таблицы с наиболее неэффективным пространственным сокращением.

PartitionKey -> (список)

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

(строка)

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

Предоставляет сведения о временном диапазоне запроса, включая таблицу с наибольшим (максимальным) временным диапазоном. Ниже приведены некоторые потенциальные варианты оптимизации временного сокращения:

  • Добавить недостающие временные предикаты.
  • Удалить функции вокруг временных предикатов.
  • Добавить временные предикаты ко всем подзапросам.

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

Содержит следующие свойства, которые предоставляют информацию о наиболее неэффективной таблице на временной оси:

  • Value – Максимальная продолжительность в наносекундах между началом и концом запроса.
  • TableArn – Amazon Resource Name (ARN) таблицы, которая запрашивается с наибольшим временным диапазоном.

Value -> (длинное целое)

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

TableArn -> (строка)

Amazon Resource Name (ARN) таблицы, которая запрашивается с наибольшим временным диапазоном.

QueryTableCount -> (длинное целое)

Указывает количество таблиц в запросе.

OutputRows -> (длинное целое)

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

OutputBytes -> (длинное целое)

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

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

Местоположение в S3 для отчета об ошибках.

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

Местоположение в S3, где записываются отчеты об ошибках.

BucketName -> (строка)

Имя ведра S3.

ObjectKey -> (строка)

Ключ S3.

FailureReason -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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