Describe Feature Group

sagemaker_describe_feature_group

R Documentation

Use this operation to describe a FeatureGroup

Description

Use this operation to describe a FeatureGroup. The response includes information on the creation time, FeatureGroup name, the unique identifier for each FeatureGroup, and more.

Usage

sagemaker_describe_feature_group(FeatureGroupName, NextToken)

Arguments

FeatureGroupName

[required] The name or Amazon Resource Name (ARN) of the FeatureGroup you want described.

NextToken

A token to resume pagination of the list of Features (FeatureDefinitions). 2,500 Features are returned by default.

Value

A list with the following syntax:

list(
  FeatureGroupArn = "string",
  FeatureGroupName = "string",
  RecordIdentifierFeatureName = "string",
  EventTimeFeatureName = "string",
  FeatureDefinitions = list(
    list(
      FeatureName = "string",
      FeatureType = "Integral"|"Fractional"|"String",
      CollectionType = "List"|"Set"|"Vector",
      CollectionConfig = list(
        VectorConfig = list(
          Dimension = 123
        )
      )
    )
  ),
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTime = as.POSIXct(
    "2015-01-01"
  ),
  OnlineStoreConfig = list(
    SecurityConfig = list(
      KmsKeyId = "string"
    ),
    EnableOnlineStore = TRUE|FALSE,
    TtlDuration = list(
      Unit = "Seconds"|"Minutes"|"Hours"|"Days"|"Weeks",
      Value = 123
    ),
    StorageType = "Standard"|"InMemory"
  ),
  OfflineStoreConfig = list(
    S3StorageConfig = list(
      S3Uri = "string",
      KmsKeyId = "string",
      ResolvedOutputS3Uri = "string"
    ),
    DisableGlueTableCreation = TRUE|FALSE,
    DataCatalogConfig = list(
      TableName = "string",
      Catalog = "string",
      Database = "string"
    ),
    TableFormat = "Default"|"Glue"|"Iceberg"
  ),
  ThroughputConfig = list(
    ThroughputMode = "OnDemand"|"Provisioned",
    ProvisionedReadCapacityUnits = 123,
    ProvisionedWriteCapacityUnits = 123
  ),
  RoleArn = "string",
  FeatureGroupStatus = "Creating"|"Created"|"CreateFailed"|"Deleting"|"DeleteFailed",
  OfflineStoreStatus = list(
    Status = "Active"|"Blocked"|"Disabled",
    BlockedReason = "string"
  ),
  LastUpdateStatus = list(
    Status = "Successful"|"Failed"|"InProgress",
    FailureReason = "string"
  ),
  FailureReason = "string",
  Description = "string",
  NextToken = "string",
  OnlineStoreTotalSizeBytes = 123
)

Request syntax

svc$describe_feature_group(
  FeatureGroupName = "string",
  NextToken = "string"
)