AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker-featurestore-runtime ]

put-record

Description

The PutRecord API is used to ingest a list of Records into your feature group.

If a new record’s EventTime is greater, the new record is written to both the OnlineStore and OfflineStore . Otherwise, the record is a historic record and it is written only to the OfflineStore .

You can specify the ingestion to be applied to the OnlineStore , OfflineStore , or both by using the TargetStores request parameter.

You can set the ingested record to expire at a given time to live (TTL) duration after the record’s event time, ExpiresAt = EventTime + TtlDuration , by specifying the TtlDuration parameter. A record level TtlDuration is set when specifying the TtlDuration parameter using the PutRecord API call. If the input TtlDuration is null or unspecified, TtlDuration is set to the default feature group level TtlDuration . A record level TtlDuration supersedes the group level TtlDuration .

See also: AWS API Documentation

Synopsis

  put-record
--feature-group-name <value>
--record <value>
[--target-stores <value>]
[--ttl-duration <value>]
[--cli-input-json <value>]
[--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>]

Options

--feature-group-name (string)

The name or Amazon Resource Name (ARN) of the feature group that you want to insert the record into.

--record (list)

List of FeatureValues to be inserted. This will be a full over-write. If you only want to update few of the feature values, do the following:

  • Use GetRecord to retrieve the latest record.
  • Update the record returned from GetRecord .
  • Use PutRecord to update feature values.

(structure)

The value associated with a feature.

FeatureName -> (string)

The name of a feature that a feature value corresponds to.

ValueAsString -> (string)

The value in string format associated with a feature. Used when your CollectionType is None . Note that features types can be String , Integral , or Fractional . This value represents all three types as a string.

ValueAsStringList -> (list)

The list of values in string format associated with a feature. Used when your CollectionType is a List , Set , or Vector . Note that features types can be String , Integral , or Fractional . These values represents all three types as a string.

(string)

Shorthand Syntax:

FeatureName=string,ValueAsString=string,ValueAsStringList=string,string ...

JSON Syntax:

[
  {
    "FeatureName": "string",
    "ValueAsString": "string",
    "ValueAsStringList": ["string", ...]
  }
  ...
]

--target-stores (list)

A list of stores to which you're adding the record. By default, Feature Store adds the record to all of the stores that you're using for the FeatureGroup .

(string)

Syntax:

"string" "string" ...

Where valid values are:
  OnlineStore
  OfflineStore

--ttl-duration (structure)

Time to live duration, where the record is hard deleted after the expiration time is reached; ExpiresAt = EventTime + TtlDuration . For information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.

Unit -> (string)

TtlDuration time unit.

Value -> (integer)

TtlDuration time value.

Shorthand Syntax:

Unit=string,Value=integer

JSON Syntax:

{
  "Unit": "Seconds"|"Minutes"|"Hours"|"Days"|"Weeks",
  "Value": integer
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

None