Spec-Zone.ru › AWS CLI v2

[ aws . datazone ]

создание-источника-данных

Описание

Создает источник данных Amazon DataZone.

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

Синтаксис

  create-data-source
[--asset-forms-input <value>]
[--client-token <value>]
[--configuration <value>]
[--connection-identifier <value>]
[--description <value>]
--domain-identifier <value>
[--enable-setting <value>]
[--environment-identifier <value>]
--name <value>
--project-identifier <value>
[--publish-on-import| --no-publish-on-import]
[--recommendation <value>]
[--schedule <value>]
--type <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 (список)

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

(структура)

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

content -> (строка)

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

formName -> (строка)

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

typeIdentifier -> (строка)

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

typeRevision -> (строка)

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

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

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

Синтаксис JSON:

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

--client-token (строка)

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

--configuration (структура помеченного союза)

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

Примечание

Это структура помеченного союза. Только один из следующих ключей верхнего уровня может быть установлен: 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", ...]
      ...}
  }
}

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

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

--description (строка)

Описание источника данных.

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

Идентификатор домена Amazon DataZone, где создается источник данных.

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

Указывает, включен ли источник данных.

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

  • ENABLED
  • DISABLED

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

Уникальный идентификатор среды Amazon DataZone, в которую источник данных публикует активы.

--name (строка)

Название источника данных.

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

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

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

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

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

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

enableBusinessNameGeneration -> (булево)

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

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

enableBusinessNameGeneration=boolean

Синтаксис JSON:

{
  "enableBusinessNameGeneration": true|false
}

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

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

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"
}

--type (строка)

Тип источника данных. В Amazon DataZone вы можете использовать источники данных для импорта технических метаданных активов (данных) из исходных баз данных или хранилищ данных в Amazon DataZone. В текущей версии Amazon DataZone вы можете создавать и запускать источники данных для Amazon Web Services Glue и Amazon Redshift.

--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 (boolean)

Включить ведение журнала отладки.

--endpoint-url (string)

Переопределить URL по умолчанию для команды указанным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с сервисами AWS. Для каждого SSL-подключения AWS CLI будет проверять SSL-сертификаты. Эта опция переопределяет поведение по умолчанию для проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическое разбиение на страницы. Если автоматическое разбиение на страницы отключено, AWS CLI сделает только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования для вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из вашего файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки config/env.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/отключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Пакет сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки config/env.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокироваться и не будет тайм-аута. Значение по умолчанию - 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокироваться и не будет тайм-аута. Значение по умолчанию - 60 секунд.

--cli-binary-format (string)

Стиль форматирования, который будет использоваться для двоичных больших объектов. Формат по умолчанию - 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 (boolean)

Отключить пейджер cli для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

assetFormsOutput -> (list)

Формы метаданных, прикрепленные к активам, которые создает этот источник данных.

(structure)

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

content -> (string)

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

formName -> (string)

Название формы метаданных.

typeName -> (string)

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

typeRevision -> (string)

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

configuration -> (tagged union structure)

Задает конфигурацию источника данных. Его можно установить либо в glueRunConfiguration, либо в redshiftRunConfiguration.

Примечание

Это структура Tagged Union. Можно установить только один из следующих ключей верхнего уровня: glueRunConfiguration, redshiftRunConfiguration, sageMakerRunConfiguration.

glueRunConfiguration -> (structure)

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

accountId -> (string)

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

autoImportDataQualityResult -> (boolean)

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

catalogName -> (string)

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

dataAccessRole -> (string)

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

region -> (string)

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

relationalFilterConfigurations -> (list)

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

(structure)

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

databaseName -> (string)

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

filterExpressions -> (list)

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

(structure)

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

expression -> (string)

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

type -> (string)

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

schemaName -> (string)

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

redshiftRunConfiguration -> (structure)

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

accountId -> (string)

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

dataAccessRole -> (string)

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

redshiftCredentialConfiguration -> (structure)

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

secretManagerArn -> (string)

ARN диспетчера секретов для кластера Amazon Redshift.

redshiftStorage -> (tagged union structure)

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

Примечание

Это структура Tagged Union. Можно установить только один из следующих ключей верхнего уровня: redshiftClusterSource, redshiftServerlessSource.

redshiftClusterSource -> (structure)

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

clusterName -> (string)

Название кластера Amazon Redshift.

redshiftServerlessSource -> (structure)

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

workgroupName -> (string)

Название рабочей группы Amazon Redshift Serverless.

region -> (string)

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

relationalFilterConfigurations -> (list)

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

(structure)

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

databaseName -> (string)

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

filterExpressions -> (list)

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

(structure)

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

expression -> (string)

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

type -> (string)

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

schemaName -> (string)

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

sageMakerRunConfiguration -> (structure)

Конфигурация запуска Amazon SageMaker.

accountId -> (string)

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

region -> (string)

Регион Amazon SageMaker.

trackingAssets -> (map)

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

key -> (string)

value -> (list)

(string)

connectionId -> (string)

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

createdAt -> (timestamp)

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

description -> (string)

Описание источника данных.

domainId -> (string)

Идентификатор домена Amazon DataZone, в котором создается источник данных.

enableSetting -> (string)

Указывает, включен ли источник данных.

environmentId -> (string)

Уникальный идентификатор среды Amazon DataZone, в которой источник данных публикует активы.

errorMessage -> (structure)

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

errorDetail -> (string)

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

errorType -> (string)

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

id -> (string)

Уникальный идентификатор источника данных.

lastRunAt -> (timestamp)

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

lastRunErrorMessage -> (structure)

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

errorDetail -> (string)

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

errorType -> (string)

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

lastRunStatus -> (string)

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

name -> (string)

Имя источника данных.

projectId -> (string)

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

publishOnImport -> (boolean)

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

recommendation -> (structure)

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

enableBusinessNameGeneration -> (boolean)

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

schedule -> (structure)

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

schedule -> (string)

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

timezone -> (string)

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

status -> (string)

Статус источника данных.

type -> (string)

Тип источника данных.

updatedAt -> (timestamp)

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

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

Spec-Zone.ru

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