sagemakerfeaturestoreruntime

package
v1.41.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 12, 2021 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package sagemakerfeaturestoreruntime provides the client and types for making API requests to Amazon SageMaker Feature Store Runtime.

Contains all data plane API operations and data types for the Amazon SageMaker Feature Store. Use this API to put, delete, and retrieve (get) features from a feature store.

Use the following operations to configure your OnlineStore and OfflineStore features, and to create and manage feature groups:

See https://docs.aws.amazon.com/goto/WebAPI/sagemaker-featurestore-runtime-2020-07-01 for more information on this service.

See sagemakerfeaturestoreruntime package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/sagemakerfeaturestoreruntime/

Using the Client

To contact Amazon SageMaker Feature Store Runtime with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon SageMaker Feature Store Runtime client SageMakerFeatureStoreRuntime for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/sagemakerfeaturestoreruntime/#New

Index

Constants

View Source
const (

	// ErrCodeAccessForbidden for service response error code
	// "AccessForbidden".
	//
	// You do not have permission to perform an action.
	ErrCodeAccessForbidden = "AccessForbidden"

	// ErrCodeInternalFailure for service response error code
	// "InternalFailure".
	//
	// An internal failure occurred. Try your request again. If the problem persists,
	// contact AWS customer support.
	ErrCodeInternalFailure = "InternalFailure"

	// ErrCodeResourceNotFound for service response error code
	// "ResourceNotFound".
	//
	// A resource that is required to perform an action was not found.
	ErrCodeResourceNotFound = "ResourceNotFound"

	// ErrCodeServiceUnavailable for service response error code
	// "ServiceUnavailable".
	//
	// The service is currently unavailable.
	ErrCodeServiceUnavailable = "ServiceUnavailable"

	// ErrCodeValidationError for service response error code
	// "ValidationError".
	//
	// There was an error validating your request.
	ErrCodeValidationError = "ValidationError"
)
View Source
const (
	ServiceName = "SageMaker FeatureStore Runtime" // Name of service.
	EndpointsID = "featurestore-runtime.sagemaker" // ID to lookup a service endpoint with.
	ServiceID   = "SageMaker FeatureStore Runtime" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessForbidden

type AccessForbidden struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

You do not have permission to perform an action.

func (*AccessForbidden) Code

func (s *AccessForbidden) Code() string

Code returns the exception type name.

func (*AccessForbidden) Error

func (s *AccessForbidden) Error() string

func (AccessForbidden) GoString

func (s AccessForbidden) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessForbidden) Message

func (s *AccessForbidden) Message() string

Message returns the exception's message.

func (*AccessForbidden) OrigErr

func (s *AccessForbidden) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessForbidden) RequestID

func (s *AccessForbidden) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessForbidden) StatusCode

func (s *AccessForbidden) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessForbidden) String

func (s AccessForbidden) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetRecordError

type BatchGetRecordError struct {

	// The error code of an error that has occured when attempting to retrieve a
	// batch of Records. For more information on errors, see Errors (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_GetRecord.html#API_feature_store_GetRecord_Errors).
	//
	// ErrorCode is a required field
	ErrorCode *string `type:"string" required:"true"`

	// The error message of an error that has occured when attempting to retrieve
	// a record in the batch.
	//
	// ErrorMessage is a required field
	ErrorMessage *string `type:"string" required:"true"`

	// The name of the feature group that the record belongs to.
	//
	// FeatureGroupName is a required field
	FeatureGroupName *string `type:"string" required:"true"`

	// The value for the RecordIdentifier in string format of a Record from a FeatureGroup
	// that is causing an error when attempting to be retrieved.
	//
	// RecordIdentifierValueAsString is a required field
	RecordIdentifierValueAsString *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The error that has occurred when attempting to retrieve a batch of Records.

func (BatchGetRecordError) GoString

func (s BatchGetRecordError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetRecordError) SetErrorCode

func (s *BatchGetRecordError) SetErrorCode(v string) *BatchGetRecordError

SetErrorCode sets the ErrorCode field's value.

func (*BatchGetRecordError) SetErrorMessage

func (s *BatchGetRecordError) SetErrorMessage(v string) *BatchGetRecordError

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchGetRecordError) SetFeatureGroupName

func (s *BatchGetRecordError) SetFeatureGroupName(v string) *BatchGetRecordError

SetFeatureGroupName sets the FeatureGroupName field's value.

func (*BatchGetRecordError) SetRecordIdentifierValueAsString

func (s *BatchGetRecordError) SetRecordIdentifierValueAsString(v string) *BatchGetRecordError

SetRecordIdentifierValueAsString sets the RecordIdentifierValueAsString field's value.

func (BatchGetRecordError) String

func (s BatchGetRecordError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetRecordIdentifier

type BatchGetRecordIdentifier struct {

	// A FeatureGroupName containing Records you are retrieving in a batch.
	//
	// FeatureGroupName is a required field
	FeatureGroupName *string `min:"1" type:"string" required:"true"`

	// List of names of Features to be retrieved. If not specified, the latest value
	// for all the Features are returned.
	FeatureNames []*string `min:"1" type:"list"`

	// The value for a list of record identifiers in string format.
	//
	// RecordIdentifiersValueAsString is a required field
	RecordIdentifiersValueAsString []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The identifier that identifies the batch of Records you are retrieving in a batch.

func (BatchGetRecordIdentifier) GoString

func (s BatchGetRecordIdentifier) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetRecordIdentifier) SetFeatureGroupName

func (s *BatchGetRecordIdentifier) SetFeatureGroupName(v string) *BatchGetRecordIdentifier

SetFeatureGroupName sets the FeatureGroupName field's value.

func (*BatchGetRecordIdentifier) SetFeatureNames

func (s *BatchGetRecordIdentifier) SetFeatureNames(v []*string) *BatchGetRecordIdentifier

SetFeatureNames sets the FeatureNames field's value.

func (*BatchGetRecordIdentifier) SetRecordIdentifiersValueAsString

func (s *BatchGetRecordIdentifier) SetRecordIdentifiersValueAsString(v []*string) *BatchGetRecordIdentifier

SetRecordIdentifiersValueAsString sets the RecordIdentifiersValueAsString field's value.

func (BatchGetRecordIdentifier) String

func (s BatchGetRecordIdentifier) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetRecordIdentifier) Validate

func (s *BatchGetRecordIdentifier) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchGetRecordInput

type BatchGetRecordInput struct {

	// A list of FeatureGroup names, with their corresponding RecordIdentifier value,
	// and Feature name that have been requested to be retrieved in batch.
	//
	// Identifiers is a required field
	Identifiers []*BatchGetRecordIdentifier `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchGetRecordInput) GoString

func (s BatchGetRecordInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetRecordInput) SetIdentifiers

SetIdentifiers sets the Identifiers field's value.

func (BatchGetRecordInput) String

func (s BatchGetRecordInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetRecordInput) Validate

func (s *BatchGetRecordInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchGetRecordOutput

type BatchGetRecordOutput struct {

	// A list of errors that have occured when retrieving a batch of Records.
	//
	// Errors is a required field
	Errors []*BatchGetRecordError `type:"list" required:"true"`

	// A list of Records you requested to be retrieved in batch.
	//
	// Records is a required field
	Records []*BatchGetRecordResultDetail `type:"list" required:"true"`

	// A unprocessed list of FeatureGroup names, with their corresponding RecordIdentifier
	// value, and Feature name.
	//
	// UnprocessedIdentifiers is a required field
	UnprocessedIdentifiers []*BatchGetRecordIdentifier `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchGetRecordOutput) GoString

func (s BatchGetRecordOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetRecordOutput) SetErrors

SetErrors sets the Errors field's value.

func (*BatchGetRecordOutput) SetRecords

SetRecords sets the Records field's value.

func (*BatchGetRecordOutput) SetUnprocessedIdentifiers

func (s *BatchGetRecordOutput) SetUnprocessedIdentifiers(v []*BatchGetRecordIdentifier) *BatchGetRecordOutput

SetUnprocessedIdentifiers sets the UnprocessedIdentifiers field's value.

func (BatchGetRecordOutput) String

func (s BatchGetRecordOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetRecordResultDetail

type BatchGetRecordResultDetail struct {

	// The FeatureGroupName containing Records you retrieved in a batch.
	//
	// FeatureGroupName is a required field
	FeatureGroupName *string `type:"string" required:"true"`

	// The Record retrieved.
	//
	// Record is a required field
	Record []*FeatureValue `min:"1" type:"list" required:"true"`

	// The value of the record identifer in string format.
	//
	// RecordIdentifierValueAsString is a required field
	RecordIdentifierValueAsString *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The output of Records that have been retrieved in a batch.

func (BatchGetRecordResultDetail) GoString

func (s BatchGetRecordResultDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetRecordResultDetail) SetFeatureGroupName

SetFeatureGroupName sets the FeatureGroupName field's value.

func (*BatchGetRecordResultDetail) SetRecord

SetRecord sets the Record field's value.

func (*BatchGetRecordResultDetail) SetRecordIdentifierValueAsString

func (s *BatchGetRecordResultDetail) SetRecordIdentifierValueAsString(v string) *BatchGetRecordResultDetail

SetRecordIdentifierValueAsString sets the RecordIdentifierValueAsString field's value.

func (BatchGetRecordResultDetail) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteRecordInput

type DeleteRecordInput struct {

	// Timestamp indicating when the deletion event occurred. EventTime can be used
	// to query data at a certain point in time.
	//
	// EventTime is a required field
	EventTime *string `location:"querystring" locationName:"EventTime" type:"string" required:"true"`

	// The name of the feature group to delete the record from.
	//
	// FeatureGroupName is a required field
	FeatureGroupName *string `location:"uri" locationName:"FeatureGroupName" min:"1" type:"string" required:"true"`

	// The value for the RecordIdentifier that uniquely identifies the record, in
	// string format.
	//
	// RecordIdentifierValueAsString is a required field
	RecordIdentifierValueAsString *string `location:"querystring" locationName:"RecordIdentifierValueAsString" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteRecordInput) GoString

func (s DeleteRecordInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRecordInput) SetEventTime

func (s *DeleteRecordInput) SetEventTime(v string) *DeleteRecordInput

SetEventTime sets the EventTime field's value.

func (*DeleteRecordInput) SetFeatureGroupName

func (s *DeleteRecordInput) SetFeatureGroupName(v string) *DeleteRecordInput

SetFeatureGroupName sets the FeatureGroupName field's value.

func (*DeleteRecordInput) SetRecordIdentifierValueAsString

func (s *DeleteRecordInput) SetRecordIdentifierValueAsString(v string) *DeleteRecordInput

SetRecordIdentifierValueAsString sets the RecordIdentifierValueAsString field's value.

func (DeleteRecordInput) String

func (s DeleteRecordInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRecordInput) Validate

func (s *DeleteRecordInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteRecordOutput

type DeleteRecordOutput struct {
	// contains filtered or unexported fields
}

func (DeleteRecordOutput) GoString

func (s DeleteRecordOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteRecordOutput) String

func (s DeleteRecordOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FeatureValue

type FeatureValue struct {

	// The name of a feature that a feature value corresponds to.
	//
	// FeatureName is a required field
	FeatureName *string `min:"1" type:"string" required:"true"`

	// The value associated with a feature, in string format. Note that features
	// types can be String, Integral, or Fractional. This value represents all three
	// types as a string.
	//
	// ValueAsString is a required field
	ValueAsString *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The value associated with a feature.

func (FeatureValue) GoString

func (s FeatureValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FeatureValue) SetFeatureName

func (s *FeatureValue) SetFeatureName(v string) *FeatureValue

SetFeatureName sets the FeatureName field's value.

func (*FeatureValue) SetValueAsString

func (s *FeatureValue) SetValueAsString(v string) *FeatureValue

SetValueAsString sets the ValueAsString field's value.

func (FeatureValue) String

func (s FeatureValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FeatureValue) Validate

func (s *FeatureValue) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetRecordInput

type GetRecordInput struct {

	// The name of the feature group in which you want to put the records.
	//
	// FeatureGroupName is a required field
	FeatureGroupName *string `location:"uri" locationName:"FeatureGroupName" min:"1" type:"string" required:"true"`

	// List of names of Features to be retrieved. If not specified, the latest value
	// for all the Features are returned.
	FeatureNames []*string `location:"querystring" locationName:"FeatureName" min:"1" type:"list"`

	// The value that corresponds to RecordIdentifier type and uniquely identifies
	// the record in the FeatureGroup.
	//
	// RecordIdentifierValueAsString is a required field
	RecordIdentifierValueAsString *string `location:"querystring" locationName:"RecordIdentifierValueAsString" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetRecordInput) GoString

func (s GetRecordInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRecordInput) SetFeatureGroupName

func (s *GetRecordInput) SetFeatureGroupName(v string) *GetRecordInput

SetFeatureGroupName sets the FeatureGroupName field's value.

func (*GetRecordInput) SetFeatureNames

func (s *GetRecordInput) SetFeatureNames(v []*string) *GetRecordInput

SetFeatureNames sets the FeatureNames field's value.

func (*GetRecordInput) SetRecordIdentifierValueAsString

func (s *GetRecordInput) SetRecordIdentifierValueAsString(v string) *GetRecordInput

SetRecordIdentifierValueAsString sets the RecordIdentifierValueAsString field's value.

func (GetRecordInput) String

func (s GetRecordInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRecordInput) Validate

func (s *GetRecordInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetRecordOutput

type GetRecordOutput struct {

	// The record you requested. A list of FeatureValues.
	Record []*FeatureValue `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (GetRecordOutput) GoString

func (s GetRecordOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRecordOutput) SetRecord

func (s *GetRecordOutput) SetRecord(v []*FeatureValue) *GetRecordOutput

SetRecord sets the Record field's value.

func (GetRecordOutput) String

func (s GetRecordOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalFailure

type InternalFailure struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support.

func (*InternalFailure) Code

func (s *InternalFailure) Code() string

Code returns the exception type name.

func (*InternalFailure) Error

func (s *InternalFailure) Error() string

func (InternalFailure) GoString

func (s InternalFailure) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalFailure) Message

func (s *InternalFailure) Message() string

Message returns the exception's message.

func (*InternalFailure) OrigErr

func (s *InternalFailure) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalFailure) RequestID

func (s *InternalFailure) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalFailure) StatusCode

func (s *InternalFailure) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalFailure) String

func (s InternalFailure) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutRecordInput

type PutRecordInput struct {

	// The name of the feature group that you want to insert the record into.
	//
	// FeatureGroupName is a required field
	FeatureGroupName *string `location:"uri" locationName:"FeatureGroupName" min:"1" type:"string" required:"true"`

	// 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.
	//
	// Record is a required field
	Record []*FeatureValue `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (PutRecordInput) GoString

func (s PutRecordInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRecordInput) SetFeatureGroupName

func (s *PutRecordInput) SetFeatureGroupName(v string) *PutRecordInput

SetFeatureGroupName sets the FeatureGroupName field's value.

func (*PutRecordInput) SetRecord

func (s *PutRecordInput) SetRecord(v []*FeatureValue) *PutRecordInput

SetRecord sets the Record field's value.

func (PutRecordInput) String

func (s PutRecordInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRecordInput) Validate

func (s *PutRecordInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutRecordOutput

type PutRecordOutput struct {
	// contains filtered or unexported fields
}

func (PutRecordOutput) GoString

func (s PutRecordOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutRecordOutput) String

func (s PutRecordOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFound

type ResourceNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

A resource that is required to perform an action was not found.

func (*ResourceNotFound) Code

func (s *ResourceNotFound) Code() string

Code returns the exception type name.

func (*ResourceNotFound) Error

func (s *ResourceNotFound) Error() string

func (ResourceNotFound) GoString

func (s ResourceNotFound) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFound) Message

func (s *ResourceNotFound) Message() string

Message returns the exception's message.

func (*ResourceNotFound) OrigErr

func (s *ResourceNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFound) RequestID

func (s *ResourceNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFound) StatusCode

func (s *ResourceNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFound) String

func (s ResourceNotFound) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SageMakerFeatureStoreRuntime

type SageMakerFeatureStoreRuntime struct {
	*client.Client
}

SageMakerFeatureStoreRuntime provides the API operation methods for making requests to Amazon SageMaker Feature Store Runtime. See this package's package overview docs for details on the service.

SageMakerFeatureStoreRuntime methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

New creates a new instance of the SageMakerFeatureStoreRuntime client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a SageMakerFeatureStoreRuntime client from just a session.
svc := sagemakerfeaturestoreruntime.New(mySession)

// Create a SageMakerFeatureStoreRuntime client with additional configuration
svc := sagemakerfeaturestoreruntime.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*SageMakerFeatureStoreRuntime) BatchGetRecord

BatchGetRecord API operation for Amazon SageMaker Feature Store Runtime.

Retrieves a batch of Records from a FeatureGroup.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon SageMaker Feature Store Runtime's API operation BatchGetRecord for usage and error information.

Returned Error Types:

  • ValidationError There was an error validating your request.

  • InternalFailure An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support.

  • ServiceUnavailable The service is currently unavailable.

  • AccessForbidden You do not have permission to perform an action.

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord

func (*SageMakerFeatureStoreRuntime) BatchGetRecordRequest

func (c *SageMakerFeatureStoreRuntime) BatchGetRecordRequest(input *BatchGetRecordInput) (req *request.Request, output *BatchGetRecordOutput)

BatchGetRecordRequest generates a "aws/request.Request" representing the client's request for the BatchGetRecord operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchGetRecord for more information on using the BatchGetRecord API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchGetRecordRequest method.
req, resp := client.BatchGetRecordRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-featurestore-runtime-2020-07-01/BatchGetRecord

func (*SageMakerFeatureStoreRuntime) BatchGetRecordWithContext

func (c *SageMakerFeatureStoreRuntime) BatchGetRecordWithContext(ctx aws.Context, input *BatchGetRecordInput, opts ...request.Option) (*BatchGetRecordOutput, error)

BatchGetRecordWithContext is the same as BatchGetRecord with the addition of the ability to pass a context and additional request options.

See BatchGetRecord for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SageMakerFeatureStoreRuntime) DeleteRecord

DeleteRecord API operation for Amazon SageMaker Feature Store Runtime.

Deletes a Record from a FeatureGroup. A new record will show up in the OfflineStore when the DeleteRecord API is called. This record will have a value of True in the is_deleted column.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon SageMaker Feature Store Runtime's API operation DeleteRecord for usage and error information.

Returned Error Types:

  • ValidationError There was an error validating your request.

  • InternalFailure An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support.

  • ServiceUnavailable The service is currently unavailable.

  • AccessForbidden You do not have permission to perform an action.

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-featurestore-runtime-2020-07-01/DeleteRecord

func (*SageMakerFeatureStoreRuntime) DeleteRecordRequest

func (c *SageMakerFeatureStoreRuntime) DeleteRecordRequest(input *DeleteRecordInput) (req *request.Request, output *DeleteRecordOutput)

DeleteRecordRequest generates a "aws/request.Request" representing the client's request for the DeleteRecord operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteRecord for more information on using the DeleteRecord API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteRecordRequest method.
req, resp := client.DeleteRecordRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-featurestore-runtime-2020-07-01/DeleteRecord

func (*SageMakerFeatureStoreRuntime) DeleteRecordWithContext

func (c *SageMakerFeatureStoreRuntime) DeleteRecordWithContext(ctx aws.Context, input *DeleteRecordInput, opts ...request.Option) (*DeleteRecordOutput, error)

DeleteRecordWithContext is the same as DeleteRecord with the addition of the ability to pass a context and additional request options.

See DeleteRecord for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SageMakerFeatureStoreRuntime) GetRecord

GetRecord API operation for Amazon SageMaker Feature Store Runtime.

Use for OnlineStore serving from a FeatureStore. Only the latest records stored in the OnlineStore can be retrieved. If no Record with RecordIdentifierValue is found, then an empty result is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon SageMaker Feature Store Runtime's API operation GetRecord for usage and error information.

Returned Error Types:

  • ValidationError There was an error validating your request.

  • ResourceNotFound A resource that is required to perform an action was not found.

  • InternalFailure An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support.

  • ServiceUnavailable The service is currently unavailable.

  • AccessForbidden You do not have permission to perform an action.

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-featurestore-runtime-2020-07-01/GetRecord

func (*SageMakerFeatureStoreRuntime) GetRecordRequest

func (c *SageMakerFeatureStoreRuntime) GetRecordRequest(input *GetRecordInput) (req *request.Request, output *GetRecordOutput)

GetRecordRequest generates a "aws/request.Request" representing the client's request for the GetRecord operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRecord for more information on using the GetRecord API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRecordRequest method.
req, resp := client.GetRecordRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-featurestore-runtime-2020-07-01/GetRecord

func (*SageMakerFeatureStoreRuntime) GetRecordWithContext

func (c *SageMakerFeatureStoreRuntime) GetRecordWithContext(ctx aws.Context, input *GetRecordInput, opts ...request.Option) (*GetRecordOutput, error)

GetRecordWithContext is the same as GetRecord with the addition of the ability to pass a context and additional request options.

See GetRecord for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SageMakerFeatureStoreRuntime) PutRecord

PutRecord API operation for Amazon SageMaker Feature Store Runtime.

Used for data ingestion into the FeatureStore. The PutRecord API writes to both the OnlineStore and OfflineStore. If the record is the latest record for the recordIdentifier, the record is written to both the OnlineStore and OfflineStore. If the record is a historic record, it is written only to the OfflineStore.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon SageMaker Feature Store Runtime's API operation PutRecord for usage and error information.

Returned Error Types:

  • ValidationError There was an error validating your request.

  • InternalFailure An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support.

  • ServiceUnavailable The service is currently unavailable.

  • AccessForbidden You do not have permission to perform an action.

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-featurestore-runtime-2020-07-01/PutRecord

func (*SageMakerFeatureStoreRuntime) PutRecordRequest

func (c *SageMakerFeatureStoreRuntime) PutRecordRequest(input *PutRecordInput) (req *request.Request, output *PutRecordOutput)

PutRecordRequest generates a "aws/request.Request" representing the client's request for the PutRecord operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutRecord for more information on using the PutRecord API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutRecordRequest method.
req, resp := client.PutRecordRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-featurestore-runtime-2020-07-01/PutRecord

func (*SageMakerFeatureStoreRuntime) PutRecordWithContext

func (c *SageMakerFeatureStoreRuntime) PutRecordWithContext(ctx aws.Context, input *PutRecordInput, opts ...request.Option) (*PutRecordOutput, error)

PutRecordWithContext is the same as PutRecord with the addition of the ability to pass a context and additional request options.

See PutRecord for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ServiceUnavailable

type ServiceUnavailable struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The service is currently unavailable.

func (*ServiceUnavailable) Code

func (s *ServiceUnavailable) Code() string

Code returns the exception type name.

func (*ServiceUnavailable) Error

func (s *ServiceUnavailable) Error() string

func (ServiceUnavailable) GoString

func (s ServiceUnavailable) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceUnavailable) Message

func (s *ServiceUnavailable) Message() string

Message returns the exception's message.

func (*ServiceUnavailable) OrigErr

func (s *ServiceUnavailable) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailable) RequestID

func (s *ServiceUnavailable) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailable) StatusCode

func (s *ServiceUnavailable) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceUnavailable) String

func (s ServiceUnavailable) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationError

type ValidationError struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

There was an error validating your request.

func (*ValidationError) Code

func (s *ValidationError) Code() string

Code returns the exception type name.

func (*ValidationError) Error

func (s *ValidationError) Error() string

func (ValidationError) GoString

func (s ValidationError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationError) Message

func (s *ValidationError) Message() string

Message returns the exception's message.

func (*ValidationError) OrigErr

func (s *ValidationError) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationError) RequestID

func (s *ValidationError) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationError) StatusCode

func (s *ValidationError) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationError) String

func (s ValidationError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package sagemakerfeaturestoreruntimeiface provides an interface to enable mocking the Amazon SageMaker Feature Store Runtime service client for testing your code.
Package sagemakerfeaturestoreruntimeiface provides an interface to enable mocking the Amazon SageMaker Feature Store Runtime service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL