describe-feature-group

Описание

Используйте эту операцию для описания FeatureGroup. Ответ включает информацию о времени создания, FeatureGroup имени, уникальном идентификаторе каждого FeatureGroup и многом другом.

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

Синтаксис

  describe-feature-group
--feature-group-name <value>
[--next-token <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]

Параметры

--feature-group-name (строка)

Имя или Amazon Resource Name (ARN) FeatureGroup, которое требуется описать.

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

Токен для возобновления пагинации списка Features (FeatureDefinitions). По умолчанию возвращаются 2 500 Features.

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

Вывод

FeatureGroupArn -> (строка)

Amazon Resource Name (ARN) FeatureGroup .

FeatureGroupName -> (строка)

Имя FeatureGroup .

RecordIdentifierFeatureName -> (строка)

Имя Feature , используемого для RecordIdentifier, значение которого однозначно идентифицирует запись, хранящуюся в хранилище функций.

EventTimeFeatureName -> (строка)

Имя функции, которая хранит EventTime записи в FeatureGroup .

EventTime — это момент времени, когда происходит новое событие, которое соответствует созданию или обновлению Record в FeatureGroup . Все Records в FeatureGroup имеют соответствующую EventTime .

FeatureDefinitions -> (список)

Список Features в FeatureGroup . Каждая функция определяется FeatureName и FeatureType .

(структура)

Список функций. Вы должны включить FeatureName и FeatureType . Допустимые типы функций — Integral , Fractional и String .

FeatureName -> (строка)

Имя функции. Тип должен быть строкой. FeatureName не может быть ни одним из следующих: is_deleted , write_time , api_invocation_time .

Имя должно:

Начинаться с буквенно-цифрового символа.
Содержать только буквенно-цифровые символы, символы подчеркивания и дефисы. Пробелы запрещены.

FeatureType -> (строка)

Тип значения функции. Допустимые значения: Целое, Дробное или Строка.

CollectionType -> (строка)

Группа элементов, где каждый элемент в группе должен иметь одинаковый тип функции (String , Integral или Fractional ).

List: упорядоченная коллекция элементов.
Set: неупорядоченная коллекция уникальных элементов.
Vector: специализированный список, представляющий массив элементов фиксированного размера. Размерность вектора определяется вами. Должны содержать элементы с дробным типом функции.

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

Настройка вашей коллекции.

Примечание

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

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

Настройка для типа коллекции векторов.

Dimension: количество элементов в вашем векторе.

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

Количество элементов в вашем векторе.

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

Метка времени, указывающая, когда SageMaker создал FeatureGroup .

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

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

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

Настройка OnlineStore .

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

Используйте для указания идентификатора ключа KMS (KMSKeyId ) для шифрования данных в состоянии покоя OnlineStore .

KmsKeyId -> (строка)

Amazon Resource Name (ARN) ключа управления ключами Amazon Web Services (KMS), который SageMaker Feature Store использует для шифрования объектов Amazon S3 в состоянии покоя с использованием шифрования на серверной стороне Amazon S3.

Вызывающая сторона (пользователь или роль IAM) CreateFeatureGroup должна иметь нижеприведённые разрешения на OnlineStore KmsKeyId:

"kms:Encrypt"
"kms:Decrypt"
"kms:DescribeKey"
"kms:CreateGrant"
"kms:RetireGrant"
"kms:ReEncryptFrom"
"kms:ReEncryptTo"
"kms:GenerateDataKey"
"kms:ListAliases"
"kms:ListGrants"
"kms:RevokeGrant"

Вызывающая сторона (пользователь или роль IAM) для всех операций DataPlane (PutRecord , GetRecord , DeleteRecord ) должна иметь следующие разрешения на KmsKeyId :

"kms:Decrypt"

EnableOnlineStore -> (булево)

Отключить OnlineStore, указав False для флага EnableOnlineStore . Включить OnlineStore, указав True для флага EnableOnlineStore .

Значение по умолчанию — False .

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

Срок действия, где запись жестко удаляется после достижения срока действия; ExpiresAt = EventTime + TtlDuration . Сведения о жестком удалении см. в руководстве API Amazon SageMaker по API DeleteRecord.

Unit -> (строка)

Единица измерения TtlDuration времени.

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

Значение TtlDuration времени.

StorageType -> (строка)

Вариант для разных уровней низкой задержки для извлечения данных в реальном времени.

Standard: управляемое хранилище данных с низкой задержкой для групп функций.
InMemory: управляемое хранилище данных для групп функций, которое поддерживает очень низкую задержку извлечения.

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

Настройка автономного хранилища. Она включает следующие настройки:

Расположение Amazon S3 автономного хранилища.
Настройка каталога данных Glue.
Формат таблицы автономного хранилища.
Возможность отключения автоматического создания таблицы Glue для автономного хранилища.
Настройка шифрования.

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

Расположение Amazon Simple Storage (Amazon S3) OfflineStore .

S3Uri -> (строка)

S3 URI или расположение в Amazon S3 OfflineStore .

S3 URI имеют формат, похожий на следующий: s3://example-bucket/prefix/ .

KmsKeyId -> (строка)

Amazon Resource Name (ARN) ключа управления ключами Amazon Web Services (KMS) ключа, используемого для шифрования любых объектов, записанных в расположение S3 OfflineStore .

IAM roleARN, переданный в качестве параметра к CreateFeatureGroup, должен иметь нижеприведённые разрешения на KmsKeyId :

"kms:GenerateDataKey"

ResolvedOutputS3Uri -> (строка)

Путь к S3, куда записываются автономные записи.

DisableGlueTableCreation -> (булево)

Установите в значение True, чтобы отключить автоматическое создание таблицы Amazon Web Services Glue при настройке OfflineStore . Если установлено значение False, Feature Store назовёт таблицу Glue OfflineStore в соответствии с рекомендациями Athena относительно именования.

Значение по умолчанию — False .

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

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

TableName -> (строка)

Имя таблицы Glue.

Catalog -> (строка)

Имя каталога таблицы Glue.

Database -> (строка)

Имя базы данных таблицы Glue.

TableFormat -> (строка)

Формат таблицы автономного хранилища. Поддерживаемые форматы — Glue (по умолчанию) и Apache Iceberg.

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

Активная настройка пропускной способности группы функций. Существуют два режима: ON_DEMAND и PROVISIONED . В режиме по требованию вы оплачиваете чтение и запись данных, которые выполняет ваше приложение в вашей группе функций. Вам не нужно указывать пропускную способность чтения и записи, поскольку Feature Store удовлетворяет ваши рабочие нагрузки, по мере их подъема и снижения. Вы можете переключить группу функций в режим по требованию только один раз в 24 часа. В режиме выделенной пропускной способности вы указываете пропускную способность чтения и записи в секунду, которая, по вашему мнению, требуется вашему приложению, и вы оплачиваете ее на основе этих ограничений. Превышение выделенной пропускной способности приведет к ограничению ваших запросов.

Примечание: режим пропускной способности по требованию поддерживается только для групп функций, которые работают только автономно или используют уровень онлайн-хранилища ` Standard https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType`__.

ThroughputMode -> (строка)

Режим, используемый для пропускной способности вашей группы функций: ON_DEMAND или PROVISIONED .

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

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

Это поле не применимо для групп функций по требованию.

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

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

Это поле не применимо для групп функций по требованию.

RoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM выполнения, используемой для сохранения данных в OfflineStore, если предоставлен OfflineStoreConfig.

FeatureGroupStatus -> (строка)

Состояние группы функций.

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

Состояние OfflineStore . Сообщает вам, если дублирование данных в OfflineStore завершилось неудачей. Возвращает либо: Active, либо Blocked.

Status -> (строка)

Статус OfflineStore .

BlockedReason -> (строка)

Обоснование блокировки OfflineStoreStatus (применимо, если применимо).

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

Значение, указывающее, было ли успешным обновление группы функций.

Status -> (строка)

Значение, указывающее, было ли успешным обновление.

FailureReason -> (строка)

Если обновление не было успешным, указывает причину неудачи.

FailureReason -> (строка)

Причина, по которой FeatureGroup не удалось дублировать в OfflineStore . Эта неудача может произойти из-за:

FeatureGroup не удалось создать в OfflineStore .
FeatureGroup не удалось удалить из OfflineStore .

Description -> (строка)

Свободное описание группы функций.

NextToken -> (строка)

Токен для возобновления постраничной загрузки списка Features (FeatureDefinitions ).

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

Размер OnlineStore в байтах.