Spec-Zone.ru › AWS CLI v2

[ aws . datazone ]

Обновить источник данных

Описание

Обновляет указанный источник данных в Amazon DataZone.

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

Синтаксис

  update-data-source
[--asset-forms-input <value>]
[--configuration <value>]
[--description <value>]
--domain-identifier <value>
[--enable-setting <value>]
--identifier <value>
[--name <value>]
[--publish-on-import| --no-publish-on-import]
[--recommendation <value>]
[--retain-permissions-on-revoke-failure | --no-retain-permissions-on-revoke-failure]
[--schedule <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]

Параметры

--asset-forms-input (список)

Формы активов, которые будут обновлены в рамках действия UpdateDataSource.

(структура)

Подробности формы метаданных.

content -> (строка)

Содержание формы метаданных.

formName -> (строка)

Имя формы метаданных.

typeIdentifier -> (строка)

Идентификатор типа формы метаданных.

typeRevision -> (строка)

Ревизия типа формы метаданных.

Сокращенный синтаксис:

content=string,formName=string,typeIdentifier=string,typeRevision=string ...

Синтаксис JSON:

[
  {
    "content": "string",
    "formName": "string",
    "typeIdentifier": "string",
    "typeRevision": "string"
  }
  ...
]

--configuration (структура помеченного объединения)

Настройка, которая будет обновлена в рамках действия UpdateDataSource.

Примечание

Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть задан: glueRunConfiguration, redshiftRunConfiguration, sageMakerRunConfiguration.

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

Настройка источника данных Amazon Web Services Glue.

autoImportDataQualityResult -> (булево)

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

catalogName -> (строка)

Имя каталога в конфигурации выполнения Amazon Web Services Glue.

dataAccessRole -> (строка)

Роль доступа к данным, включенная в подробности конфигурации источника данных Amazon Web Services Glue.

relationalFilterConfigurations -> (список)

Конфигурации реляционных фильтров, включенные в подробности конфигурации источника данных Amazon Web Services Glue.

(структура)

Конфигурация реляционного фильтра для источника данных.

databaseName -> (строка)

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

filterExpressions -> (список)

Выражения фильтров, указанные в конфигурации реляционного фильтра для источника данных.

(структура)

Выражение фильтра в Amazon DataZone.

expression -> (строка)

Выражение поиска фильтра.

type -> (строка)

Тип выражения поиска фильтра.

schemaName -> (строка)

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

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

Конфигурация источника данных Amazon Redshift.

dataAccessRole -> (строка)

Роль доступа к данным, включенная в подробности конфигурации источника данных Amazon Redshift.

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

Подробности данных, необходимые для доступа к кластеру Amazon Redshift.

secretManagerArn -> (строка)

ARN секретного менеджера для кластера Amazon Redshift.

redshiftStorage -> (структура помеченного объединения)

Подробности хранения Amazon Redshift в рамках выполнения конфигурации источника данных Amazon Redshift.

Примечание

Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть задан: redshiftClusterSource, redshiftServerlessSource.

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

Подробности источника кластера Amazon Redshift.

clusterName -> (строка)

Имя кластера Amazon Redshift.

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

Подробности источника рабочей группы Amazon Redshift Serverless.

workgroupName -> (строка)

Имя рабочей группы Amazon Redshift Serverless.

relationalFilterConfigurations -> (список)

Конфигурации реляционных фильтров, включенные в подробности конфигурации источника данных Amazon Redshift.

(структура)

Конфигурация реляционного фильтра для источника данных.

databaseName -> (строка)

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

filterExpressions -> (список)

Выражения фильтров, указанные в конфигурации реляционного фильтра для источника данных.

(структура)

Выражение фильтра в Amazon DataZone.

expression -> (строка)

Выражение поиска фильтра.

type -> (строка)

Тип выражения поиска фильтра.

schemaName -> (строка)

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

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

Конфигурация выполнения Amazon SageMaker.

trackingAssets -> (карта)

Актив отслеживания выполнения Amazon SageMaker.

key -> (строка)

value -> (список)

(строка)

Синтаксис JSON:

{
  "glueRunConfiguration": {
    "autoImportDataQualityResult": true|false,
    "catalogName": "string",
    "dataAccessRole": "string",
    "relationalFilterConfigurations": [
      {
        "databaseName": "string",
        "filterExpressions": [
          {
            "expression": "string",
            "type": "INCLUDE"|"EXCLUDE"
          }
          ...
        ],
        "schemaName": "string"
      }
      ...
    ]
  },
  "redshiftRunConfiguration": {
    "dataAccessRole": "string",
    "redshiftCredentialConfiguration": {
      "secretManagerArn": "string"
    },
    "redshiftStorage": {
      "redshiftClusterSource": {
        "clusterName": "string"
      },
      "redshiftServerlessSource": {
        "workgroupName": "string"
      }
    },
    "relationalFilterConfigurations": [
      {
        "databaseName": "string",
        "filterExpressions": [
          {
            "expression": "string",
            "type": "INCLUDE"|"EXCLUDE"
          }
          ...
        ],
        "schemaName": "string"
      }
      ...
    ]
  },
  "sageMakerRunConfiguration": {
    "trackingAssets": {"string": ["string", ...]
      ...}
  }
}

--description (строка)

Описание, которое необходимо обновить в рамках действия UpdateDataSource.

--domain-identifier (строка)

Идентификатор домена, в котором необходимо обновить источник данных.

--enable-setting (строка)

Настройка включения, которая должна быть обновлена в рамках действия UpdateDataSource.

Возможные значения:

  • ENABLED
  • DISABLED

--identifier (строка)

Идентификатор источника данных, который необходимо обновить.

--name (строка)

Имя, которое необходимо обновить в рамках действия UpdateDataSource.

--publish-on-import | --no-publish-on-import (булево)

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

--recommendation (структура)

Рекомендация, которая должна быть обновлена в рамках действия UpdateDataSource.

enableBusinessNameGeneration -> (булево)

Указывает, следует ли включать автоматическое создание имени бизнес-объекта в конфигурации рекомендации.

Сокращенный синтаксис:

enableBusinessNameGeneration=boolean

Синтаксис JSON:

{
  "enableBusinessNameGeneration": true|false
}

--retain-permissions-on-revoke-failure | --no-retain-permissions-on-revoke-failure (булево)

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

--schedule (структура)

Расписание, которое должно быть обновлено в рамках действия UpdateDataSource.

schedule -> (строка)

Расписание выполнения источника данных.

timezone -> (строка)

Часовой пояс выполнения источника данных.

Сокращенный синтаксис:

schedule=string,timezone=string

Синтаксис JSON:

{
  "schedule": "string",
  "timezone": "UTC"|"AFRICA_JOHANNESBURG"|"AMERICA_MONTREAL"|"AMERICA_SAO_PAULO"|"ASIA_BAHRAIN"|"ASIA_BANGKOK"|"ASIA_CALCUTTA"|"ASIA_DUBAI"|"ASIA_HONG_KONG"|"ASIA_JAKARTA"|"ASIA_KUALA_LUMPUR"|"ASIA_SEOUL"|"ASIA_SHANGHAI"|"ASIA_SINGAPORE"|"ASIA_TAIPEI"|"ASIA_TOKYO"|"AUSTRALIA_MELBOURNE"|"AUSTRALIA_SYDNEY"|"CANADA_CENTRAL"|"CET"|"CST6CDT"|"ETC_GMT"|"ETC_GMT0"|"ETC_GMT_ADD_0"|"ETC_GMT_ADD_1"|"ETC_GMT_ADD_10"|"ETC_GMT_ADD_11"|"ETC_GMT_ADD_12"|"ETC_GMT_ADD_2"|"ETC_GMT_ADD_3"|"ETC_GMT_ADD_4"|"ETC_GMT_ADD_5"|"ETC_GMT_ADD_6"|"ETC_GMT_ADD_7"|"ETC_GMT_ADD_8"|"ETC_GMT_ADD_9"|"ETC_GMT_NEG_0"|"ETC_GMT_NEG_1"|"ETC_GMT_NEG_10"|"ETC_GMT_NEG_11"|"ETC_GMT_NEG_12"|"ETC_GMT_NEG_13"|"ETC_GMT_NEG_14"|"ETC_GMT_NEG_2"|"ETC_GMT_NEG_3"|"ETC_GMT_NEG_4"|"ETC_GMT_NEG_5"|"ETC_GMT_NEG_6"|"ETC_GMT_NEG_7"|"ETC_GMT_NEG_8"|"ETC_GMT_NEG_9"|"EUROPE_DUBLIN"|"EUROPE_LONDON"|"EUROPE_PARIS"|"EUROPE_STOCKHOLM"|"EUROPE_ZURICH"|"ISRAEL"|"MEXICO_GENERAL"|"MST7MDT"|"PACIFIC_AUCKLAND"|"US_CENTRAL"|"US_EASTERN"|"US_MOUNTAIN"|"US_PACIFIC"
}

--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-адресу команды на указанную.

--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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

assetFormsOutput -> (список)

Формы активов, которые должны быть обновлены в рамках действия UpdateDataSource.

(структура)

Подробная информация о форме метаданных.

content -> (строка)

Содержимое формы метаданных.

formName -> (строка)

Имя формы метаданных.

typeName -> (строка)

Имя типа формы метаданных.

typeRevision -> (строка)

Ревизия типа формы метаданных.

configuration -> (структура помеченных объединений)

Конфигурация, которая должна быть обновлена в рамках действия UpdateDataSource.

Примечание

Это структура помеченных объединений. Только один из следующих ключевых элементов верхнего уровня может быть задан: glueRunConfiguration, redshiftRunConfiguration, sageMakerRunConfiguration.

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

Конфигурация источника данных Amazon Web Services Glue.

accountId -> (строка)

Идентификатор учетной записи Amazon Web Services, включенный в сведения о конфигурации источника данных Amazon Web Services Glue.

autoImportDataQualityResult -> (логическое значение)

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

catalogName -> (строка)

Имя каталога в конфигурации выполнения Amazon Web Services Glue.

dataAccessRole -> (строка)

Роль доступа к данным, включенная в сведения о конфигурации источника данных Amazon Web Services Glue.

region -> (строка)

Регион Amazon Web Services, включенный в сведения о конфигурации источника данных Amazon Web Services Glue.

relationalFilterConfigurations -> (список)

Конфигурации реляционных фильтров, включенные в сведения о конфигурации источника данных Amazon Web Services Glue.

(структура)

Конфигурация реляционного фильтра для источника данных.

databaseName -> (строка)

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

filterExpressions -> (список)

Выражения фильтров, указанные в конфигурации реляционного фильтра для источника данных.

(структура)

Выражение фильтра в Amazon DataZone.

expression -> (строка)

Выражение фильтра поиска.

type -> (строка)

Тип выражения фильтра поиска.

schemaName -> (строка)

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

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

Конфигурация источника данных Amazon Redshift.

accountId -> (строка)

Идентификатор учетной записи Amazon Web Services, включенный в сведения о конфигурации источника данных Amazon Redshift.

dataAccessRole -> (строка)

Роль доступа к данным, включенная в сведения о конфигурации источника данных Amazon Redshift.

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

Подробная информация о необходимых учетных данных для доступа к кластеру Amazon Redshift.

secretManagerArn -> (строка)

ARN секретного менеджера для кластера Amazon Redshift.

redshiftStorage -> (структура помеченных объединений)

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

Примечание

Это структура помеченных объединений. Только один из следующих ключевых элементов верхнего уровня может быть задан: redshiftClusterSource, redshiftServerlessSource.

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

Подробная информация об источнике кластера Amazon Redshift.

clusterName -> (строка)

Имя кластера Amazon Redshift.

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

Подробная информация об источнике рабочей группы Amazon Redshift Serverless.

workgroupName -> (строка)

Имя рабочей группы Amazon Redshift Serverless.

region -> (строка)

Регион Amazon Web Services, включенный в сведения о конфигурации источника данных Amazon Redshift.

relationalFilterConfigurations -> (список)

Конфигурации реляционных фильтров, включенные в сведения о конфигурации источника данных Amazon Redshift.

(структура)

Конфигурация реляционного фильтра для источника данных.

databaseName -> (строка)

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

filterExpressions -> (список)

Выражения фильтров, указанные в конфигурации реляционного фильтра для источника данных.

(структура)

Выражение фильтра в Amazon DataZone.

expression -> (строка)

Выражение фильтра поиска.

type -> (строка)

Тип выражения фильтра поиска.

schemaName -> (строка)

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

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

Конфигурация выполнения Amazon SageMaker.

accountId -> (строка)

Идентификатор учетной записи Amazon SageMaker.

region -> (строка)

Регион Amazon SageMaker.

trackingAssets -> (массив)

Отслеживаемые активы Amazon SageMaker.

key -> (строка)

value -> (список)

(строка)

connectionId -> (строка)

Идентификатор подключения.

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

Метка времени обновления источника данных.

description -> (строка)

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

domainId -> (строка)

Идентификатор домена Amazon DataZone, в котором должен быть обновлен источник данных.

enableSetting -> (строка)

Настройка включения, которая должна быть обновлена в рамках действия UpdateDataSource.

environmentId -> (строка)

Идентификатор среды, в которой должен быть обновлен источник данных.

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

Указывает сообщение об ошибке, которое возвращается, если операция не может быть успешно завершена.

errorDetail -> (строка)

Подробности сообщения об ошибке, которое возвращается, если операция не может быть успешно завершена.

errorType -> (строка)

Тип сообщения об ошибке, которое возвращается, если операция не может быть успешно завершена.

id -> (строка)

Идентификатор источника данных, который должен быть обновлен.

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

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

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

Сообщение об ошибке последнего выполнения источника данных.

errorDetail -> (строка)

Подробности сообщения об ошибке, которое возвращается, если операция не может быть успешно завершена.

errorType -> (строка)

Тип сообщения об ошибке, которое возвращается, если операция не может быть успешно завершена.

lastRunStatus -> (строка)

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

name -> (строка)

Имя, которое должно быть обновлено в рамках действия UpdateDataSource.

projectId -> (строка)

Идентификатор проекта, в котором должен быть обновлен источник данных.

publishOnImport -> (логическое значение)

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

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

Рекомендация, которая должна быть обновлена в рамках действия UpdateDataSource.

enableBusinessNameGeneration -> (логическое значение)

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

retainPermissionsOnRevokeFailure -> (логическое значение)

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

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

Расписание, которое должно быть обновлено в рамках действия UpdateDataSource.

schedule -> (строка)

Расписание выполнения источника данных.

timezone -> (строка)

Часовой пояс для выполнения источника данных.

selfGrantStatus -> (структура помеченных объединений)

Указывает статус функции самоприсвоения разрешений.

Примечание

Это структура помеченных объединений. Только один из следующих ключевых элементов верхнего уровня может быть задан: glueSelfGrantStatus, redshiftSelfGrantStatus.

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

Подробная информация о статусе самоприсвоения разрешений для источника данных Glue.

selfGrantStatusDetails -> (список)

Подробная информация о статусе самоприсвоения разрешений для источника данных Glue.

(структура)

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

databaseName -> (строка)

Имя базы данных, используемой для источника данных.

failureCause -> (строка)

Причина неудачи операции.

schemaName -> (строка)

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

status -> (строка)

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

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

Подробная информация о статусе самоприсвоения разрешений для источника данных Amazon Redshift.

selfGrantStatusDetails -> (список)

Подробная информация о статусе самоприсвоения разрешений для источника данных Amazon Redshift.

(структура)

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

databaseName -> (строка)

Имя базы данных, используемой для источника данных.

failureCause -> (строка)

Причина неудачи операции.

schemaName -> (строка)

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

status -> (строка)

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

status -> (строка)

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

type -> (строка)

Тип, который должен быть обновлен в рамках действия UpdateDataSource.

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

Метка времени обновления источника данных.

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

Spec-Zone.ru

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