Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

cancel-export-task

Описание

Отменяет выполнение задачи экспорта, которая экспортирует моментальный снимок или кластер в Amazon S3. Любые данные, которые уже были записаны в ведро S3, не удаляются.

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

Синтаксис

  cancel-export-task
--export-task-identifier <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]

Параметры

--export-task-identifier (строка)

Идентификатор задачи экспорта моментального снимка или кластера для отмены.

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, 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.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. руководство «Начало работы» в Руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. Подробнее см. раздел «Использование кавычек со строками» в Руководстве пользователя AWS CLI.

Отмена экспорта моментального снимка в Amazon S3

В следующем cancel-export-task примере отменяется задача экспорта, которая экспортирует моментальный снимок в Amazon S3.

aws rds cancel-export-task \
    --export-task-identifier my-s3-export-1

Вывод:

{
    "ExportTaskIdentifier": "my-s3-export-1",
    "SourceArn": "arn:aws:rds:us-east-1:123456789012:snapshot:publisher-final-snapshot",
    "SnapshotTime": "2019-03-24T20:01:09.815Z",
    "S3Bucket": "amzn-s3-demo-bucket",
    "S3Prefix": "",
    "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/export-snap-S3-role",
    "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/abcd0000-7bfd-4594-af38-aabbccddeeff",
    "Status": "CANCELING",
    "PercentProgress": 0,
    "TotalExtractedDataInGB": 0
}

Дополнительную информацию см. в разделе «Отмена задачи экспорта моментального снимка» в Руководстве пользователя Amazon RDS или «Отмена задачи экспорта моментального снимка» в Руководстве пользователя Amazon Aurora.

Вывод

ExportTaskIdentifier -> (строка)

Уникальный идентификатор задачи экспорта моментального снимка или кластера. Этот ID не является идентификатором ведра Amazon S3, в которое экспортируются данные.

SourceArn -> (строка)

Amazon Resource Name (ARN) моментального снимка или кластера, экспортированного в Amazon S3.

ExportOnly -> (список)

Данные, экспортированные из моментального снимка или кластера.

Допустимые значения:

  • database - Экспорт всех данных из указанной базы данных.
  • database.table имя_таблицы - Экспорт таблицы из моментального снимка или кластера. Этот формат допустим только для RDS for MySQL, RDS for MariaDB и Aurora MySQL.
  • database.schema имя_схемы - Экспорт схемы базы данных из моментального снимка или кластера. Этот формат допустим только для RDS for PostgreSQL и Aurora PostgreSQL.
  • database.schema.table имя_таблицы - Экспорт таблицы из схемы базы данных. Этот формат допустим только для RDS for PostgreSQL и Aurora PostgreSQL.

(строка)

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

Время создания моментального снимка.

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

Время начала задачи экспорта моментального снимка или кластера.

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

Время завершения задачи экспорта моментального снимка или кластера.

S3Bucket -> (строка)

Ведро Amazon S3, в которое экспортируется моментальный снимок или кластер.

S3Prefix -> (строка)

Префикс ведра Amazon S3, представляющий имя файла и путь к экспортированным данным.

IamRoleArn -> (строка)

Имя роли IAM, используемой для записи в Amazon S3 при экспорте моментального снимка или кластера.

KmsKeyId -> (строка)

Идентификатор ключа Amazon Web Services KMS, используемого для шифрования данных при экспорте в Amazon S3. Идентификатор ключа KMS — это его ARN ключа, ID ключа, ARN псевдонима или имя псевдонима. Роль IAM, используемая для экспорта, должна иметь разрешения на шифрование и расшифрование для использования этого ключа KMS.

Status -> (строка)

Статус выполнения задачи экспорта. Статус может быть одним из следующих:

  • CANCELED
  • CANCELING
  • COMPLETE
  • FAILED
  • IN_PROGRESS
  • STARTING

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

Прогресс задачи экспорта моментального снимка или кластера в процентах.

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

Общий объем экспортированных данных в гигабайтах.

FailureCause -> (строка)

Причина ошибки экспорта, если экспорт завершился с ошибкой.

WarningMessage -> (строка)

Предупреждение о задаче экспорта моментального снимка или кластера.

SourceType -> (строка)

Тип источника для экспорта.

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

Spec-Zone.ru

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