frauddetector – github.com/aws/aws-sdk-go-v2/service/frauddetector Index | Files | Directories

package frauddetector

import "github.com/aws/aws-sdk-go-v2/service/frauddetector"

Package frauddetector provides the API client, operations, and parameter types for Amazon Fraud Detector.

This is the Amazon Fraud Detector API Reference. This guide is for developers who need detailed information about Amazon Fraud Detector API actions, data types, and errors. For more information about Amazon Fraud Detector features, see the Amazon Fraud Detector User Guide (https://docs.aws.amazon.com/frauddetector/latest/ug/).

Index

Constants

const ServiceAPIVersion = "2019-11-15"
const ServiceID = "FraudDetector"

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type BatchCreateVariableInput

type BatchCreateVariableInput struct {

	// The list of variables for the batch create variable request.
	//
	// This member is required.
	VariableEntries []types.VariableEntry

	// A collection of key and value pairs.
	Tags []types.Tag
}

type BatchCreateVariableOutput

type BatchCreateVariableOutput struct {

	// Provides the errors for the BatchCreateVariable request.
	Errors []types.BatchCreateVariableError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type BatchGetVariableInput

type BatchGetVariableInput struct {

	// The list of variable names to get.
	//
	// This member is required.
	Names []string
}

type BatchGetVariableOutput

type BatchGetVariableOutput struct {

	// The errors from the request.
	Errors []types.BatchGetVariableError

	// The returned variables.
	Variables []types.Variable

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Client

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

Client provides the API client to make operations call for Amazon Fraud Detector.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) BatchCreateVariable

func (c *Client) BatchCreateVariable(ctx context.Context, params *BatchCreateVariableInput, optFns ...func(*Options)) (*BatchCreateVariableOutput, error)

Creates a batch of variables.

func (*Client) BatchGetVariable

func (c *Client) BatchGetVariable(ctx context.Context, params *BatchGetVariableInput, optFns ...func(*Options)) (*BatchGetVariableOutput, error)

Gets a batch of variables.

func (*Client) CreateDetectorVersion

func (c *Client) CreateDetectorVersion(ctx context.Context, params *CreateDetectorVersionInput, optFns ...func(*Options)) (*CreateDetectorVersionOutput, error)

Creates a detector version. The detector version starts in a DRAFT status.

func (*Client) CreateModel

func (c *Client) CreateModel(ctx context.Context, params *CreateModelInput, optFns ...func(*Options)) (*CreateModelOutput, error)

Creates a model using the specified model type.

func (*Client) CreateModelVersion

func (c *Client) CreateModelVersion(ctx context.Context, params *CreateModelVersionInput, optFns ...func(*Options)) (*CreateModelVersionOutput, error)

Creates a version of the model using the specified model type and model id.

func (*Client) CreateRule

func (c *Client) CreateRule(ctx context.Context, params *CreateRuleInput, optFns ...func(*Options)) (*CreateRuleOutput, error)

Creates a rule for use with the specified detector.

func (*Client) CreateVariable

func (c *Client) CreateVariable(ctx context.Context, params *CreateVariableInput, optFns ...func(*Options)) (*CreateVariableOutput, error)

Creates a variable.

func (*Client) DeleteDetector

func (c *Client) DeleteDetector(ctx context.Context, params *DeleteDetectorInput, optFns ...func(*Options)) (*DeleteDetectorOutput, error)

Deletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector. When you delete a detector, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud Detector.

func (*Client) DeleteDetectorVersion

func (c *Client) DeleteDetectorVersion(ctx context.Context, params *DeleteDetectorVersionInput, optFns ...func(*Options)) (*DeleteDetectorVersionOutput, error)

Deletes the detector version. You cannot delete detector versions that are in ACTIVE status. When you delete a detector version, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud Detector.

func (*Client) DeleteEntityType

func (c *Client) DeleteEntityType(ctx context.Context, params *DeleteEntityTypeInput, optFns ...func(*Options)) (*DeleteEntityTypeOutput, error)

Deletes an entity type. You cannot delete an entity type that is included in an event type. When you delete an entity type, Amazon Fraud Detector permanently deletes that entity type and the data is no longer stored in Amazon Fraud Detector.

func (*Client) DeleteEvent

func (c *Client) DeleteEvent(ctx context.Context, params *DeleteEventInput, optFns ...func(*Options)) (*DeleteEventOutput, error)

Deletes the specified event. When you delete an event, Amazon Fraud Detector permanently deletes that event and the event data is no longer stored in Amazon Fraud Detector.

func (*Client) DeleteEventType

func (c *Client) DeleteEventType(ctx context.Context, params *DeleteEventTypeInput, optFns ...func(*Options)) (*DeleteEventTypeOutput, error)

Deletes an event type. You cannot delete an event type that is used in a detector or a model. When you delete an entity type, Amazon Fraud Detector permanently deletes that entity type and the data is no longer stored in Amazon Fraud Detector.

func (*Client) DeleteExternalModel

func (c *Client) DeleteExternalModel(ctx context.Context, params *DeleteExternalModelInput, optFns ...func(*Options)) (*DeleteExternalModelOutput, error)

Removes a SageMaker model from Amazon Fraud Detector. You can remove an Amazon SageMaker model if it is not associated with a detector version. Removing a SageMaker model disconnects it from Amazon Fraud Detector, but the model remains available in SageMaker.

func (*Client) DeleteLabel

func (c *Client) DeleteLabel(ctx context.Context, params *DeleteLabelInput, optFns ...func(*Options)) (*DeleteLabelOutput, error)

Deletes a label. You cannot delete labels that are included in an event type in Amazon Fraud Detector. You cannot delete a label assigned to an event ID. You must first delete the relevant event ID. When you delete a label, Amazon Fraud Detector permanently deletes that label and the data is no longer stored in Amazon Fraud Detector.

func (*Client) DeleteModel

func (c *Client) DeleteModel(ctx context.Context, params *DeleteModelInput, optFns ...func(*Options)) (*DeleteModelOutput, error)

Deletes a model. You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version. When you delete a model, Amazon Fraud Detector permanently deletes that model and the data is no longer stored in Amazon Fraud Detector.

func (*Client) DeleteModelVersion

func (c *Client) DeleteModelVersion(ctx context.Context, params *DeleteModelVersionInput, optFns ...func(*Options)) (*DeleteModelVersionOutput, error)

Deletes a model version. You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version. When you delete a model version, Amazon Fraud Detector permanently deletes that model version and the data is no longer stored in Amazon Fraud Detector.

func (*Client) DeleteOutcome

func (c *Client) DeleteOutcome(ctx context.Context, params *DeleteOutcomeInput, optFns ...func(*Options)) (*DeleteOutcomeOutput, error)

Deletes an outcome. You cannot delete an outcome that is used in a rule version. When you delete an outcome, Amazon Fraud Detector permanently deletes that outcome and the data is no longer stored in Amazon Fraud Detector.

func (*Client) DeleteRule

func (c *Client) DeleteRule(ctx context.Context, params *DeleteRuleInput, optFns ...func(*Options)) (*DeleteRuleOutput, error)

Deletes the rule. You cannot delete a rule if it is used by an ACTIVE or INACTIVE detector version. When you delete a rule, Amazon Fraud Detector permanently deletes that rule and the data is no longer stored in Amazon Fraud Detector.

func (*Client) DeleteVariable

func (c *Client) DeleteVariable(ctx context.Context, params *DeleteVariableInput, optFns ...func(*Options)) (*DeleteVariableOutput, error)

Deletes a variable. You can't delete variables that are included in an event type in Amazon Fraud Detector. Amazon Fraud Detector automatically deletes model output variables and SageMaker model output variables when you delete the model. You can't delete these variables manually. When you delete a variable, Amazon Fraud Detector permanently deletes that variable and the data is no longer stored in Amazon Fraud Detector.

func (*Client) DescribeDetector

func (c *Client) DescribeDetector(ctx context.Context, params *DescribeDetectorInput, optFns ...func(*Options)) (*DescribeDetectorOutput, error)

Gets all versions for a specified detector.

func (*Client) DescribeModelVersions

func (c *Client) DescribeModelVersions(ctx context.Context, params *DescribeModelVersionsInput, optFns ...func(*Options)) (*DescribeModelVersionsOutput, error)

Gets all of the model versions for the specified model type or for the specified model type and model ID. You can also get details for a single, specified model version.

func (*Client) GetDetectorVersion

func (c *Client) GetDetectorVersion(ctx context.Context, params *GetDetectorVersionInput, optFns ...func(*Options)) (*GetDetectorVersionOutput, error)

Gets a particular detector version.

func (*Client) GetDetectors

func (c *Client) GetDetectors(ctx context.Context, params *GetDetectorsInput, optFns ...func(*Options)) (*GetDetectorsOutput, error)

Gets all detectors or a single detector if a detectorId is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetDetectorsResponse as part of your request. A null pagination token fetches the records from the beginning.

func (*Client) GetEntityTypes

func (c *Client) GetEntityTypes(ctx context.Context, params *GetEntityTypesInput, optFns ...func(*Options)) (*GetEntityTypesOutput, error)

Gets all entity types or a specific entity type if a name is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetEntityTypesResponse as part of your request. A null pagination token fetches the records from the beginning.

func (*Client) GetEventPrediction

func (c *Client) GetEventPrediction(ctx context.Context, params *GetEventPredictionInput, optFns ...func(*Options)) (*GetEventPredictionOutput, error)

Evaluates an event against a detector version. If a version ID is not provided, the detector’s (ACTIVE) version is used.

func (*Client) GetEventTypes

func (c *Client) GetEventTypes(ctx context.Context, params *GetEventTypesInput, optFns ...func(*Options)) (*GetEventTypesOutput, error)

Gets all event types or a specific event type if name is provided. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetEventTypesResponse as part of your request. A null pagination token fetches the records from the beginning.

func (*Client) GetExternalModels

func (c *Client) GetExternalModels(ctx context.Context, params *GetExternalModelsInput, optFns ...func(*Options)) (*GetExternalModelsOutput, error)

Gets the details for one or more Amazon SageMaker models that have been imported into the service. This is a paginated API. If you provide a null maxResults, this actions retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetExternalModelsResult as part of your request. A null pagination token fetches the records from the beginning.

func (*Client) GetKMSEncryptionKey

func (c *Client) GetKMSEncryptionKey(ctx context.Context, params *GetKMSEncryptionKeyInput, optFns ...func(*Options)) (*GetKMSEncryptionKeyOutput, error)

Gets the encryption key if a Key Management Service (KMS) customer master key (CMK) has been specified to be used to encrypt content in Amazon Fraud Detector.

func (*Client) GetLabels

func (c *Client) GetLabels(ctx context.Context, params *GetLabelsInput, optFns ...func(*Options)) (*GetLabelsOutput, error)

Gets all labels or a specific label if name is provided. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 10 and 50. To get the next page results, provide the pagination token from the GetGetLabelsResponse as part of your request. A null pagination token fetches the records from the beginning.

func (*Client) GetModelVersion

func (c *Client) GetModelVersion(ctx context.Context, params *GetModelVersionInput, optFns ...func(*Options)) (*GetModelVersionOutput, error)

Gets the details of the specified model version.

func (*Client) GetModels

func (c *Client) GetModels(ctx context.Context, params *GetModelsInput, optFns ...func(*Options)) (*GetModelsOutput, error)

Gets one or more models. Gets all models for the AWS account if no model type and no model id provided. Gets all models for the AWS account and model type, if the model type is specified but model id is not provided. Gets a specific model if (model type, model id) tuple is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 1 and 10. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning.

func (*Client) GetOutcomes

func (c *Client) GetOutcomes(ctx context.Context, params *GetOutcomesInput, optFns ...func(*Options)) (*GetOutcomesOutput, error)

Gets one or more outcomes. This is a paginated API. If you provide a null maxResults, this actions retrieves a maximum of 100 records per page. If you provide a maxResults, the value must be between 50 and 100. To get the next page results, provide the pagination token from the GetOutcomesResult as part of your request. A null pagination token fetches the records from the beginning.

func (*Client) GetRules

func (c *Client) GetRules(ctx context.Context, params *GetRulesInput, optFns ...func(*Options)) (*GetRulesOutput, error)

Get all rules for a detector (paginated) if ruleId and ruleVersion are not specified. Gets all rules for the detector and the ruleId if present (paginated). Gets a specific rule if both the ruleId and the ruleVersion are specified. This is a paginated API. Providing null maxResults results in retrieving maximum of 100 records per page. If you provide maxResults the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetRulesResult as part of your request. Null pagination token fetches the records from the beginning.

func (*Client) GetVariables

func (c *Client) GetVariables(ctx context.Context, params *GetVariablesInput, optFns ...func(*Options)) (*GetVariablesOutput, error)

Gets all of the variables or the specific variable. This is a paginated API. Providing null maxSizePerPage results in retrieving maximum of 100 records per page. If you provide maxSizePerPage the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetVariablesResult as part of your request. Null pagination token fetches the records from the beginning.

func (*Client) ListTagsForResource

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists all tags associated with the resource. This is a paginated API. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning.

func (*Client) PutDetector

func (c *Client) PutDetector(ctx context.Context, params *PutDetectorInput, optFns ...func(*Options)) (*PutDetectorOutput, error)

Creates or updates a detector.

func (*Client) PutEntityType

func (c *Client) PutEntityType(ctx context.Context, params *PutEntityTypeInput, optFns ...func(*Options)) (*PutEntityTypeOutput, error)

Creates or updates an entity type. An entity represents who is performing the event. As part of a fraud prediction, you pass the entity ID to indicate the specific entity who performed the event. An entity type classifies the entity. Example classifications include customer, merchant, or account.

func (*Client) PutEventType

func (c *Client) PutEventType(ctx context.Context, params *PutEventTypeInput, optFns ...func(*Options)) (*PutEventTypeOutput, error)

Creates or updates an event type. An event is a business activity that is evaluated for fraud risk. With Amazon Fraud Detector, you generate fraud predictions for events. An event type defines the structure for an event sent to Amazon Fraud Detector. This includes the variables sent as part of the event, the entity performing the event (such as a customer), and the labels that classify the event. Example event types include online payment transactions, account registrations, and authentications.

func (*Client) PutExternalModel

func (c *Client) PutExternalModel(ctx context.Context, params *PutExternalModelInput, optFns ...func(*Options)) (*PutExternalModelOutput, error)

Creates or updates an Amazon SageMaker model endpoint. You can also use this action to update the configuration of the model endpoint, including the IAM role and/or the mapped variables.

func (*Client) PutKMSEncryptionKey

func (c *Client) PutKMSEncryptionKey(ctx context.Context, params *PutKMSEncryptionKeyInput, optFns ...func(*Options)) (*PutKMSEncryptionKeyOutput, error)

Specifies the Key Management Service (KMS) customer master key (CMK) to be used to encrypt content in Amazon Fraud Detector.

func (*Client) PutLabel

func (c *Client) PutLabel(ctx context.Context, params *PutLabelInput, optFns ...func(*Options)) (*PutLabelOutput, error)

Creates or updates label. A label classifies an event as fraudulent or legitimate. Labels are associated with event types and used to train supervised machine learning models in Amazon Fraud Detector.

func (*Client) PutOutcome

func (c *Client) PutOutcome(ctx context.Context, params *PutOutcomeInput, optFns ...func(*Options)) (*PutOutcomeOutput, error)

Creates or updates an outcome.

func (*Client) TagResource

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Assigns tags to a resource.

func (*Client) UntagResource

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes tags from a resource.

func (*Client) UpdateDetectorVersion

func (c *Client) UpdateDetectorVersion(ctx context.Context, params *UpdateDetectorVersionInput, optFns ...func(*Options)) (*UpdateDetectorVersionOutput, error)

Updates a detector version. The detector version attributes that you can update include models, external model endpoints, rules, rule execution mode, and description. You can only update a DRAFT detector version.

func (*Client) UpdateDetectorVersionMetadata

func (c *Client) UpdateDetectorVersionMetadata(ctx context.Context, params *UpdateDetectorVersionMetadataInput, optFns ...func(*Options)) (*UpdateDetectorVersionMetadataOutput, error)

Updates the detector version's description. You can update the metadata for any detector version (DRAFT, ACTIVE, or INACTIVE).

func (*Client) UpdateDetectorVersionStatus

func (c *Client) UpdateDetectorVersionStatus(ctx context.Context, params *UpdateDetectorVersionStatusInput, optFns ...func(*Options)) (*UpdateDetectorVersionStatusOutput, error)

Updates the detector version’s status. You can perform the following promotions or demotions using UpdateDetectorVersionStatus: DRAFT to ACTIVE, ACTIVE to INACTIVE, and INACTIVE to ACTIVE.

func (*Client) UpdateModel

func (c *Client) UpdateModel(ctx context.Context, params *UpdateModelInput, optFns ...func(*Options)) (*UpdateModelOutput, error)

Updates a model. You can update the description attribute using this action.

func (*Client) UpdateModelVersion

func (c *Client) UpdateModelVersion(ctx context.Context, params *UpdateModelVersionInput, optFns ...func(*Options)) (*UpdateModelVersionOutput, error)

Updates a model version. Updating a model version retrains an existing model version using updated training data and produces a new minor version of the model. You can update the training data set location and data access role attributes using this action. This action creates and trains a new minor version of the model, for example version 1.01, 1.02, 1.03.

func (*Client) UpdateModelVersionStatus

func (c *Client) UpdateModelVersionStatus(ctx context.Context, params *UpdateModelVersionStatusInput, optFns ...func(*Options)) (*UpdateModelVersionStatusOutput, error)

Updates the status of a model version. You can perform the following status updates:

* Change the TRAINING_COMPLETE status to ACTIVE.

* Change ACTIVEto INACTIVE.

func (*Client) UpdateRuleMetadata

func (c *Client) UpdateRuleMetadata(ctx context.Context, params *UpdateRuleMetadataInput, optFns ...func(*Options)) (*UpdateRuleMetadataOutput, error)

Updates a rule's metadata. The description attribute can be updated.

func (*Client) UpdateRuleVersion

func (c *Client) UpdateRuleVersion(ctx context.Context, params *UpdateRuleVersionInput, optFns ...func(*Options)) (*UpdateRuleVersionOutput, error)

Updates a rule version resulting in a new rule version. Updates a rule version resulting in a new rule version (version 1, 2, 3 ...).

func (*Client) UpdateVariable

func (c *Client) UpdateVariable(ctx context.Context, params *UpdateVariableInput, optFns ...func(*Options)) (*UpdateVariableOutput, error)

Updates a variable.

type CreateDetectorVersionInput

type CreateDetectorVersionInput struct {

	// The ID of the detector under which you want to create a new version.
	//
	// This member is required.
	DetectorId *string

	// The rules to include in the detector version.
	//
	// This member is required.
	Rules []types.Rule

	// The description of the detector version.
	Description *string

	// The Amazon Sagemaker model endpoints to include in the detector version.
	ExternalModelEndpoints []string

	// The model versions to include in the detector version.
	ModelVersions []types.ModelVersion

	// The rule execution mode for the rules included in the detector version. You can
	// define and edit the rule mode at the detector version level, when it is in draft
	// status. If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules
	// sequentially, first to last, stopping at the first matched rule. Amazon Fraud
	// dectector then provides the outcomes for that single rule. If you specifiy
	// ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes
	// for all matched rules. The default behavior is FIRST_MATCHED.
	RuleExecutionMode types.RuleExecutionMode

	// A collection of key and value pairs.
	Tags []types.Tag
}

type CreateDetectorVersionOutput

type CreateDetectorVersionOutput struct {

	// The ID for the created version's parent detector.
	DetectorId *string

	// The ID for the created detector.
	DetectorVersionId *string

	// The status of the detector version.
	Status types.DetectorVersionStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateModelInput

type CreateModelInput struct {

	// The name of the event type.
	//
	// This member is required.
	EventTypeName *string

	// The model ID.
	//
	// This member is required.
	ModelId *string

	// The model type.
	//
	// This member is required.
	ModelType types.ModelTypeEnum

	// The model description.
	Description *string

	// A collection of key and value pairs.
	Tags []types.Tag
}

type CreateModelOutput

type CreateModelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateModelVersionInput

type CreateModelVersionInput struct {

	// The model ID.
	//
	// This member is required.
	ModelId *string

	// The model type.
	//
	// This member is required.
	ModelType types.ModelTypeEnum

	// The training data schema.
	//
	// This member is required.
	TrainingDataSchema *types.TrainingDataSchema

	// The training data source location in Amazon S3.
	//
	// This member is required.
	TrainingDataSource types.TrainingDataSourceEnum

	// Details for the external events data used for model version training. Required
	// if trainingDataSource is EXTERNAL_EVENTS.
	ExternalEventsDetail *types.ExternalEventsDetail

	// A collection of key and value pairs.
	Tags []types.Tag
}

type CreateModelVersionOutput

type CreateModelVersionOutput struct {

	// The model ID.
	ModelId *string

	// The model type.
	ModelType types.ModelTypeEnum

	// The model version number of the model version created.
	ModelVersionNumber *string

	// The model version status.
	Status *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateRuleInput

type CreateRuleInput struct {

	// The detector ID for the rule's parent detector.
	//
	// This member is required.
	DetectorId *string

	// The rule expression.
	//
	// This member is required.
	Expression *string

	// The language of the rule.
	//
	// This member is required.
	Language types.Language

	// The outcome or outcomes returned when the rule expression matches.
	//
	// This member is required.
	Outcomes []string

	// The rule ID.
	//
	// This member is required.
	RuleId *string

	// The rule description.
	Description *string

	// A collection of key and value pairs.
	Tags []types.Tag
}

type CreateRuleOutput

type CreateRuleOutput struct {

	// The created rule.
	Rule *types.Rule

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateVariableInput

type CreateVariableInput struct {

	// The source of the data.
	//
	// This member is required.
	DataSource types.DataSource

	// The data type.
	//
	// This member is required.
	DataType types.DataType

	// The default value for the variable when no value is received.
	//
	// This member is required.
	DefaultValue *string

	// The name of the variable.
	//
	// This member is required.
	Name *string

	// The description.
	Description *string

	// A collection of key and value pairs.
	Tags []types.Tag

	// The variable type. For more information see Variable types
	// (https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types).
	// Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 |
	// BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE |
	// BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS |
	// FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID |
	// PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 |
	// SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME |
	// SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT
	VariableType *string
}

type CreateVariableOutput

type CreateVariableOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteDetectorInput

type DeleteDetectorInput struct {

	// The ID of the detector to delete.
	//
	// This member is required.
	DetectorId *string
}

type DeleteDetectorOutput

type DeleteDetectorOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteDetectorVersionInput

type DeleteDetectorVersionInput struct {

	// The ID of the parent detector for the detector version to delete.
	//
	// This member is required.
	DetectorId *string

	// The ID of the detector version to delete.
	//
	// This member is required.
	DetectorVersionId *string
}

type DeleteDetectorVersionOutput

type DeleteDetectorVersionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteEntityTypeInput

type DeleteEntityTypeInput struct {

	// The name of the entity type to delete.
	//
	// This member is required.
	Name *string
}

type DeleteEntityTypeOutput

type DeleteEntityTypeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteEventInput

type DeleteEventInput struct {

	// The ID of the event to delete.
	//
	// This member is required.
	EventId *string

	// The name of the event type.
	//
	// This member is required.
	EventTypeName *string
}

type DeleteEventOutput

type DeleteEventOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteEventTypeInput

type DeleteEventTypeInput struct {

	// The name of the event type to delete.
	//
	// This member is required.
	Name *string
}

type DeleteEventTypeOutput

type DeleteEventTypeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteExternalModelInput

type DeleteExternalModelInput struct {

	// The endpoint of the Amazon Sagemaker model to delete.
	//
	// This member is required.
	ModelEndpoint *string
}

type DeleteExternalModelOutput

type DeleteExternalModelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteLabelInput

type DeleteLabelInput struct {

	// The name of the label to delete.
	//
	// This member is required.
	Name *string
}

type DeleteLabelOutput

type DeleteLabelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteModelInput

type DeleteModelInput struct {

	// The model ID of the model to delete.
	//
	// This member is required.
	ModelId *string

	// The model type of the model to delete.
	//
	// This member is required.
	ModelType types.ModelTypeEnum
}

type DeleteModelOutput

type DeleteModelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteModelVersionInput

type DeleteModelVersionInput struct {

	// The model ID of the model version to delete.
	//
	// This member is required.
	ModelId *string

	// The model type of the model version to delete.
	//
	// This member is required.
	ModelType types.ModelTypeEnum

	// The model version number of the model version to delete.
	//
	// This member is required.
	ModelVersionNumber *string
}

type DeleteModelVersionOutput

type DeleteModelVersionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteOutcomeInput

type DeleteOutcomeInput struct {

	// The name of the outcome to delete.
	//
	// This member is required.
	Name *string
}

type DeleteOutcomeOutput

type DeleteOutcomeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteRuleInput

type DeleteRuleInput struct {

	// A rule.
	//
	// This member is required.
	Rule *types.Rule
}

type DeleteRuleOutput

type DeleteRuleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteVariableInput

type DeleteVariableInput struct {

	// The name of the variable to delete.
	//
	// This member is required.
	Name *string
}

type DeleteVariableOutput

type DeleteVariableOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeDetectorInput

type DescribeDetectorInput struct {

	// The detector ID.
	//
	// This member is required.
	DetectorId *string

	// The maximum number of results to return for the request.
	MaxResults *int32

	// The next token from the previous response.
	NextToken *string
}

type DescribeDetectorOutput

type DescribeDetectorOutput struct {

	// The detector ARN.
	Arn *string

	// The detector ID.
	DetectorId *string

	// The status and description for each detector version.
	DetectorVersionSummaries []types.DetectorVersionSummary

	// The next token to be used for subsequent requests.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeModelVersionsAPIClient

type DescribeModelVersionsAPIClient interface {
	DescribeModelVersions(context.Context, *DescribeModelVersionsInput, ...func(*Options)) (*DescribeModelVersionsOutput, error)
}

DescribeModelVersionsAPIClient is a client that implements the DescribeModelVersions operation.

type DescribeModelVersionsInput

type DescribeModelVersionsInput struct {

	// The maximum number of results to return.
	MaxResults *int32

	// The model ID.
	ModelId *string

	// The model type.
	ModelType types.ModelTypeEnum

	// The model version number.
	ModelVersionNumber *string

	// The next token from the previous results.
	NextToken *string
}

type DescribeModelVersionsOutput

type DescribeModelVersionsOutput struct {

	// The model version details.
	ModelVersionDetails []types.ModelVersionDetail

	// The next token.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeModelVersionsPaginator

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

DescribeModelVersionsPaginator is a paginator for DescribeModelVersions

func NewDescribeModelVersionsPaginator

NewDescribeModelVersionsPaginator returns a new DescribeModelVersionsPaginator

func (*DescribeModelVersionsPaginator) HasMorePages

func (p *DescribeModelVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeModelVersionsPaginator) NextPage

NextPage retrieves the next DescribeModelVersions page.

type DescribeModelVersionsPaginatorOptions

type DescribeModelVersionsPaginatorOptions struct {
	// The maximum number of results to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeModelVersionsPaginatorOptions is the paginator options for DescribeModelVersions

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetDetectorVersionInput

type GetDetectorVersionInput struct {

	// The detector ID.
	//
	// This member is required.
	DetectorId *string

	// The detector version ID.
	//
	// This member is required.
	DetectorVersionId *string
}

type GetDetectorVersionOutput

type GetDetectorVersionOutput struct {

	// The detector version ARN.
	Arn *string

	// The timestamp when the detector version was created.
	CreatedTime *string

	// The detector version description.
	Description *string

	// The detector ID.
	DetectorId *string

	// The detector version ID.
	DetectorVersionId *string

	// The Amazon SageMaker model endpoints included in the detector version.
	ExternalModelEndpoints []string

	// The timestamp when the detector version was last updated.
	LastUpdatedTime *string

	// The model versions included in the detector version.
	ModelVersions []types.ModelVersion

	// The execution mode of the rule in the dectector FIRST_MATCHED indicates that
	// Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at
	// the first matched rule. Amazon Fraud dectector then provides the outcomes for
	// that single rule. ALL_MATCHED indicates that Amazon Fraud Detector evaluates all
	// rules and returns the outcomes for all matched rules. You can define and edit
	// the rule mode at the detector version level, when it is in draft status.
	RuleExecutionMode types.RuleExecutionMode

	// The rules included in the detector version.
	Rules []types.Rule

	// The status of the detector version.
	Status types.DetectorVersionStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetDetectorsAPIClient

type GetDetectorsAPIClient interface {
	GetDetectors(context.Context, *GetDetectorsInput, ...func(*Options)) (*GetDetectorsOutput, error)
}

GetDetectorsAPIClient is a client that implements the GetDetectors operation.

type GetDetectorsInput

type GetDetectorsInput struct {

	// The detector ID.
	DetectorId *string

	// The maximum number of objects to return for the request.
	MaxResults *int32

	// The next token for the subsequent request.
	NextToken *string
}

type GetDetectorsOutput

type GetDetectorsOutput struct {

	// The detectors.
	Detectors []types.Detector

	// The next page token.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetDetectorsPaginator

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

GetDetectorsPaginator is a paginator for GetDetectors

func NewGetDetectorsPaginator

func NewGetDetectorsPaginator(client GetDetectorsAPIClient, params *GetDetectorsInput, optFns ...func(*GetDetectorsPaginatorOptions)) *GetDetectorsPaginator

NewGetDetectorsPaginator returns a new GetDetectorsPaginator

func (*GetDetectorsPaginator) HasMorePages

func (p *GetDetectorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetDetectorsPaginator) NextPage

func (p *GetDetectorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetDetectorsOutput, error)

NextPage retrieves the next GetDetectors page.

type GetDetectorsPaginatorOptions

type GetDetectorsPaginatorOptions struct {
	// The maximum number of objects to return for the request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetDetectorsPaginatorOptions is the paginator options for GetDetectors

type GetEntityTypesAPIClient

type GetEntityTypesAPIClient interface {
	GetEntityTypes(context.Context, *GetEntityTypesInput, ...func(*Options)) (*GetEntityTypesOutput, error)
}

GetEntityTypesAPIClient is a client that implements the GetEntityTypes operation.

type GetEntityTypesInput

type GetEntityTypesInput struct {

	// The maximum number of objects to return for the request.
	MaxResults *int32

	// The name.
	Name *string

	// The next token for the subsequent request.
	NextToken *string
}

type GetEntityTypesOutput

type GetEntityTypesOutput struct {

	// An array of entity types.
	EntityTypes []types.EntityType

	// The next page token.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetEntityTypesPaginator

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

GetEntityTypesPaginator is a paginator for GetEntityTypes

func NewGetEntityTypesPaginator

func NewGetEntityTypesPaginator(client GetEntityTypesAPIClient, params *GetEntityTypesInput, optFns ...func(*GetEntityTypesPaginatorOptions)) *GetEntityTypesPaginator

NewGetEntityTypesPaginator returns a new GetEntityTypesPaginator

func (*GetEntityTypesPaginator) HasMorePages

func (p *GetEntityTypesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetEntityTypesPaginator) NextPage

func (p *GetEntityTypesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetEntityTypesOutput, error)

NextPage retrieves the next GetEntityTypes page.

type GetEntityTypesPaginatorOptions

type GetEntityTypesPaginatorOptions struct {
	// The maximum number of objects to return for the request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetEntityTypesPaginatorOptions is the paginator options for GetEntityTypes

type GetEventPredictionInput

type GetEventPredictionInput struct {

	// The detector ID.
	//
	// This member is required.
	DetectorId *string

	// The entity type (associated with the detector's event type) and specific entity
	// ID representing who performed the event. If an entity id is not available, use
	// "UNKNOWN."
	//
	// This member is required.
	Entities []types.Entity

	// The unique ID used to identify the event.
	//
	// This member is required.
	EventId *string

	// Timestamp that defines when the event under evaluation occurred.
	//
	// This member is required.
	EventTimestamp *string

	// The event type associated with the detector specified for the prediction.
	//
	// This member is required.
	EventTypeName *string

	// Names of the event type's variables you defined in Amazon Fraud Detector to
	// represent data elements and their corresponding values for the event you are
	// sending for evaluation.
	//
	// This member is required.
	EventVariables map[string]string

	// The detector version ID.
	DetectorVersionId *string

	// The Amazon SageMaker model endpoint input data blobs.
	ExternalModelEndpointDataBlobs map[string]types.ModelEndpointDataBlob
}

type GetEventPredictionOutput

type GetEventPredictionOutput struct {

	// The model scores. Amazon Fraud Detector generates model scores between 0 and
	// 1000, where 0 is low fraud risk and 1000 is high fraud risk. Model scores are
	// directly related to the false positive rate (FPR). For example, a score of 600
	// corresponds to an estimated 10% false positive rate whereas a score of 900
	// corresponds to an estimated 2% false positive rate.
	ModelScores []types.ModelScores

	// The results.
	RuleResults []types.RuleResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetEventTypesAPIClient

type GetEventTypesAPIClient interface {
	GetEventTypes(context.Context, *GetEventTypesInput, ...func(*Options)) (*GetEventTypesOutput, error)
}

GetEventTypesAPIClient is a client that implements the GetEventTypes operation.

type GetEventTypesInput

type GetEventTypesInput struct {

	// The maximum number of objects to return for the request.
	MaxResults *int32

	// The name.
	Name *string

	// The next token for the subsequent request.
	NextToken *string
}

type GetEventTypesOutput

type GetEventTypesOutput struct {

	// An array of event types.
	EventTypes []types.EventType

	// The next page token.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetEventTypesPaginator

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

GetEventTypesPaginator is a paginator for GetEventTypes

func NewGetEventTypesPaginator

func NewGetEventTypesPaginator(client GetEventTypesAPIClient, params *GetEventTypesInput, optFns ...func(*GetEventTypesPaginatorOptions)) *GetEventTypesPaginator

NewGetEventTypesPaginator returns a new GetEventTypesPaginator

func (*GetEventTypesPaginator) HasMorePages

func (p *GetEventTypesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetEventTypesPaginator) NextPage

func (p *GetEventTypesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetEventTypesOutput, error)

NextPage retrieves the next GetEventTypes page.

type GetEventTypesPaginatorOptions

type GetEventTypesPaginatorOptions struct {
	// The maximum number of objects to return for the request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetEventTypesPaginatorOptions is the paginator options for GetEventTypes

type GetExternalModelsAPIClient

type GetExternalModelsAPIClient interface {
	GetExternalModels(context.Context, *GetExternalModelsInput, ...func(*Options)) (*GetExternalModelsOutput, error)
}

GetExternalModelsAPIClient is a client that implements the GetExternalModels operation.

type GetExternalModelsInput

type GetExternalModelsInput struct {

	// The maximum number of objects to return for the request.
	MaxResults *int32

	// The Amazon SageMaker model endpoint.
	ModelEndpoint *string

	// The next page token for the request.
	NextToken *string
}

type GetExternalModelsOutput

type GetExternalModelsOutput struct {

	// Gets the Amazon SageMaker models.
	ExternalModels []types.ExternalModel

	// The next page token to be used in subsequent requests.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetExternalModelsPaginator

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

GetExternalModelsPaginator is a paginator for GetExternalModels

func NewGetExternalModelsPaginator

func NewGetExternalModelsPaginator(client GetExternalModelsAPIClient, params *GetExternalModelsInput, optFns ...func(*GetExternalModelsPaginatorOptions)) *GetExternalModelsPaginator

NewGetExternalModelsPaginator returns a new GetExternalModelsPaginator

func (*GetExternalModelsPaginator) HasMorePages

func (p *GetExternalModelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetExternalModelsPaginator) NextPage

func (p *GetExternalModelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetExternalModelsOutput, error)

NextPage retrieves the next GetExternalModels page.

type GetExternalModelsPaginatorOptions

type GetExternalModelsPaginatorOptions struct {
	// The maximum number of objects to return for the request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetExternalModelsPaginatorOptions is the paginator options for GetExternalModels

type GetKMSEncryptionKeyInput

type GetKMSEncryptionKeyInput struct {
}

type GetKMSEncryptionKeyOutput

type GetKMSEncryptionKeyOutput struct {

	// The KMS encryption key.
	KmsKey *types.KMSKey

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetLabelsAPIClient

type GetLabelsAPIClient interface {
	GetLabels(context.Context, *GetLabelsInput, ...func(*Options)) (*GetLabelsOutput, error)
}

GetLabelsAPIClient is a client that implements the GetLabels operation.

type GetLabelsInput

type GetLabelsInput struct {

	// The maximum number of objects to return for the request.
	MaxResults *int32

	// The name of the label or labels to get.
	Name *string

	// The next token for the subsequent request.
	NextToken *string
}

type GetLabelsOutput

type GetLabelsOutput struct {

	// An array of labels.
	Labels []types.Label

	// The next page token.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetLabelsPaginator

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

GetLabelsPaginator is a paginator for GetLabels

func NewGetLabelsPaginator

func NewGetLabelsPaginator(client GetLabelsAPIClient, params *GetLabelsInput, optFns ...func(*GetLabelsPaginatorOptions)) *GetLabelsPaginator

NewGetLabelsPaginator returns a new GetLabelsPaginator

func (*GetLabelsPaginator) HasMorePages

func (p *GetLabelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetLabelsPaginator) NextPage

func (p *GetLabelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetLabelsOutput, error)

NextPage retrieves the next GetLabels page.

type GetLabelsPaginatorOptions

type GetLabelsPaginatorOptions struct {
	// The maximum number of objects to return for the request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetLabelsPaginatorOptions is the paginator options for GetLabels

type GetModelVersionInput

type GetModelVersionInput struct {

	// The model ID.
	//
	// This member is required.
	ModelId *string

	// The model type.
	//
	// This member is required.
	ModelType types.ModelTypeEnum

	// The model version number.
	//
	// This member is required.
	ModelVersionNumber *string
}

type GetModelVersionOutput

type GetModelVersionOutput struct {

	// The model version ARN.
	Arn *string

	// The event details.
	ExternalEventsDetail *types.ExternalEventsDetail

	// The model ID.
	ModelId *string

	// The model type.
	ModelType types.ModelTypeEnum

	// The model version number.
	ModelVersionNumber *string

	// The model version status. Possible values are:
	//
	// * TRAINING_IN_PROGRESS
	//
	// *
	// TRAINING_COMPLETE
	//
	// * ACTIVATE_REQUESTED
	//
	// * ACTIVATE_IN_PROGRESS
	//
	// * ACTIVE
	//
	// *
	// INACTIVATE_REQUESTED
	//
	// * INACTIVATE_IN_PROGRESS
	//
	// * INACTIVE
	//
	// * ERROR
	Status *string

	// The training data schema.
	TrainingDataSchema *types.TrainingDataSchema

	// The training data source.
	TrainingDataSource types.TrainingDataSourceEnum

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetModelsAPIClient

type GetModelsAPIClient interface {
	GetModels(context.Context, *GetModelsInput, ...func(*Options)) (*GetModelsOutput, error)
}

GetModelsAPIClient is a client that implements the GetModels operation.

type GetModelsInput

type GetModelsInput struct {

	// The maximum number of objects to return for the request.
	MaxResults *int32

	// The model ID.
	ModelId *string

	// The model type.
	ModelType types.ModelTypeEnum

	// The next token for the subsequent request.
	NextToken *string
}

type GetModelsOutput

type GetModelsOutput struct {

	// The array of models.
	Models []types.Model

	// The next page token to be used in subsequent requests.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetModelsPaginator

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

GetModelsPaginator is a paginator for GetModels

func NewGetModelsPaginator

func NewGetModelsPaginator(client GetModelsAPIClient, params *GetModelsInput, optFns ...func(*GetModelsPaginatorOptions)) *GetModelsPaginator

NewGetModelsPaginator returns a new GetModelsPaginator

func (*GetModelsPaginator) HasMorePages

func (p *GetModelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetModelsPaginator) NextPage

func (p *GetModelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetModelsOutput, error)

NextPage retrieves the next GetModels page.

type GetModelsPaginatorOptions

type GetModelsPaginatorOptions struct {
	// The maximum number of objects to return for the request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetModelsPaginatorOptions is the paginator options for GetModels

type GetOutcomesAPIClient

type GetOutcomesAPIClient interface {
	GetOutcomes(context.Context, *GetOutcomesInput, ...func(*Options)) (*GetOutcomesOutput, error)
}

GetOutcomesAPIClient is a client that implements the GetOutcomes operation.

type GetOutcomesInput

type GetOutcomesInput struct {

	// The maximum number of objects to return for the request.
	MaxResults *int32

	// The name of the outcome or outcomes to get.
	Name *string

	// The next page token for the request.
	NextToken *string
}

type GetOutcomesOutput

type GetOutcomesOutput struct {

	// The next page token for subsequent requests.
	NextToken *string

	// The outcomes.
	Outcomes []types.Outcome

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetOutcomesPaginator

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

GetOutcomesPaginator is a paginator for GetOutcomes

func NewGetOutcomesPaginator

func NewGetOutcomesPaginator(client GetOutcomesAPIClient, params *GetOutcomesInput, optFns ...func(*GetOutcomesPaginatorOptions)) *GetOutcomesPaginator

NewGetOutcomesPaginator returns a new GetOutcomesPaginator

func (*GetOutcomesPaginator) HasMorePages

func (p *GetOutcomesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetOutcomesPaginator) NextPage

func (p *GetOutcomesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetOutcomesOutput, error)

NextPage retrieves the next GetOutcomes page.

type GetOutcomesPaginatorOptions

type GetOutcomesPaginatorOptions struct {
	// The maximum number of objects to return for the request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetOutcomesPaginatorOptions is the paginator options for GetOutcomes

type GetRulesAPIClient

type GetRulesAPIClient interface {
	GetRules(context.Context, *GetRulesInput, ...func(*Options)) (*GetRulesOutput, error)
}

GetRulesAPIClient is a client that implements the GetRules operation.

type GetRulesInput

type GetRulesInput struct {

	// The detector ID.
	//
	// This member is required.
	DetectorId *string

	// The maximum number of rules to return for the request.
	MaxResults *int32

	// The next page token.
	NextToken *string

	// The rule ID.
	RuleId *string

	// The rule version.
	RuleVersion *string
}

type GetRulesOutput

type GetRulesOutput struct {

	// The next page token to be used in subsequent requests.
	NextToken *string

	// The details of the requested rule.
	RuleDetails []types.RuleDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetRulesPaginator

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

GetRulesPaginator is a paginator for GetRules

func NewGetRulesPaginator

func NewGetRulesPaginator(client GetRulesAPIClient, params *GetRulesInput, optFns ...func(*GetRulesPaginatorOptions)) *GetRulesPaginator

NewGetRulesPaginator returns a new GetRulesPaginator

func (*GetRulesPaginator) HasMorePages

func (p *GetRulesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetRulesPaginator) NextPage

func (p *GetRulesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetRulesOutput, error)

NextPage retrieves the next GetRules page.

type GetRulesPaginatorOptions

type GetRulesPaginatorOptions struct {
	// The maximum number of rules to return for the request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetRulesPaginatorOptions is the paginator options for GetRules

type GetVariablesAPIClient

type GetVariablesAPIClient interface {
	GetVariables(context.Context, *GetVariablesInput, ...func(*Options)) (*GetVariablesOutput, error)
}

GetVariablesAPIClient is a client that implements the GetVariables operation.

type GetVariablesInput

type GetVariablesInput struct {

	// The max size per page determined for the get variable request.
	MaxResults *int32

	// The name of the variable.
	Name *string

	// The next page token of the get variable request.
	NextToken *string
}

type GetVariablesOutput

type GetVariablesOutput struct {

	// The next page token to be used in subsequent requests.
	NextToken *string

	// The names of the variables returned.
	Variables []types.Variable

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetVariablesPaginator

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

GetVariablesPaginator is a paginator for GetVariables

func NewGetVariablesPaginator

func NewGetVariablesPaginator(client GetVariablesAPIClient, params *GetVariablesInput, optFns ...func(*GetVariablesPaginatorOptions)) *GetVariablesPaginator

NewGetVariablesPaginator returns a new GetVariablesPaginator

func (*GetVariablesPaginator) HasMorePages

func (p *GetVariablesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetVariablesPaginator) NextPage

func (p *GetVariablesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetVariablesOutput, error)

NextPage retrieves the next GetVariables page.

type GetVariablesPaginatorOptions

type GetVariablesPaginatorOptions struct {
	// The max size per page determined for the get variable request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetVariablesPaginatorOptions is the paginator options for GetVariables

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListTagsForResourceAPIClient

type ListTagsForResourceAPIClient interface {
	ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error)
}

ListTagsForResourceAPIClient is a client that implements the ListTagsForResource operation.

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The ARN that specifies the resource whose tags you want to list.
	//
	// This member is required.
	ResourceARN *string

	// The maximum number of objects to return for the request.
	MaxResults *int32

	// The next token from the previous results.
	NextToken *string
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The next token for subsequent requests.
	NextToken *string

	// A collection of key and value pairs.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListTagsForResourcePaginator

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

ListTagsForResourcePaginator is a paginator for ListTagsForResource

func NewListTagsForResourcePaginator

func NewListTagsForResourcePaginator(client ListTagsForResourceAPIClient, params *ListTagsForResourceInput, optFns ...func(*ListTagsForResourcePaginatorOptions)) *ListTagsForResourcePaginator

NewListTagsForResourcePaginator returns a new ListTagsForResourcePaginator

func (*ListTagsForResourcePaginator) HasMorePages

func (p *ListTagsForResourcePaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTagsForResourcePaginator) NextPage

func (p *ListTagsForResourcePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

NextPage retrieves the next ListTagsForResource page.

type ListTagsForResourcePaginatorOptions

type ListTagsForResourcePaginatorOptions struct {
	// The maximum number of objects to return for the request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTagsForResourcePaginatorOptions is the paginator options for ListTagsForResource

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer aws.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type PutDetectorInput

type PutDetectorInput struct {

	// The detector ID.
	//
	// This member is required.
	DetectorId *string

	// The name of the event type.
	//
	// This member is required.
	EventTypeName *string

	// The description of the detector.
	Description *string

	// A collection of key and value pairs.
	Tags []types.Tag
}

type PutDetectorOutput

type PutDetectorOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutEntityTypeInput

type PutEntityTypeInput struct {

	// The name of the entity type.
	//
	// This member is required.
	Name *string

	// The description.
	Description *string

	// A collection of key and value pairs.
	Tags []types.Tag
}

type PutEntityTypeOutput

type PutEntityTypeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutEventTypeInput

type PutEventTypeInput struct {

	// The entity type for the event type. Example entity types: customer, merchant,
	// account.
	//
	// This member is required.
	EntityTypes []string

	// The event type variables.
	//
	// This member is required.
	EventVariables []string

	// The name.
	//
	// This member is required.
	Name *string

	// The description of the event type.
	Description *string

	// The event type labels.
	Labels []string

	// A collection of key and value pairs.
	Tags []types.Tag
}

type PutEventTypeOutput

type PutEventTypeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutExternalModelInput

type PutExternalModelInput struct {

	// The model endpoint input configuration.
	//
	// This member is required.
	InputConfiguration *types.ModelInputConfiguration

	// The IAM role used to invoke the model endpoint.
	//
	// This member is required.
	InvokeModelEndpointRoleArn *string

	// The model endpoints name.
	//
	// This member is required.
	ModelEndpoint *string

	// The model endpoint’s status in Amazon Fraud Detector.
	//
	// This member is required.
	ModelEndpointStatus types.ModelEndpointStatus

	// The source of the model.
	//
	// This member is required.
	ModelSource types.ModelSource

	// The model endpoint output configuration.
	//
	// This member is required.
	OutputConfiguration *types.ModelOutputConfiguration

	// A collection of key and value pairs.
	Tags []types.Tag
}

type PutExternalModelOutput

type PutExternalModelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutKMSEncryptionKeyInput

type PutKMSEncryptionKeyInput struct {

	// The KMS encryption key ARN.
	//
	// This member is required.
	KmsEncryptionKeyArn *string
}

type PutKMSEncryptionKeyOutput

type PutKMSEncryptionKeyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutLabelInput

type PutLabelInput struct {

	// The label name.
	//
	// This member is required.
	Name *string

	// The label description.
	Description *string

	//
	Tags []types.Tag
}

type PutLabelOutput

type PutLabelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type PutOutcomeInput

type PutOutcomeInput struct {

	// The name of the outcome.
	//
	// This member is required.
	Name *string

	// The outcome description.
	Description *string

	// A collection of key and value pairs.
	Tags []types.Tag
}

type PutOutcomeOutput

type PutOutcomeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type TagResourceInput

type TagResourceInput struct {

	// The resource ARN.
	//
	// This member is required.
	ResourceARN *string

	// The tags to assign to the resource.
	//
	// This member is required.
	Tags []types.Tag
}

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UntagResourceInput

type UntagResourceInput struct {

	// The ARN of the resource from which to remove the tag.
	//
	// This member is required.
	ResourceARN *string

	// The resource ARN.
	//
	// This member is required.
	TagKeys []string
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateDetectorVersionInput

type UpdateDetectorVersionInput struct {

	// The parent detector ID for the detector version you want to update.
	//
	// This member is required.
	DetectorId *string

	// The detector version ID.
	//
	// This member is required.
	DetectorVersionId *string

	// The Amazon SageMaker model endpoints to include in the detector version.
	//
	// This member is required.
	ExternalModelEndpoints []string

	// The rules to include in the detector version.
	//
	// This member is required.
	Rules []types.Rule

	// The detector version description.
	Description *string

	// The model versions to include in the detector version.
	ModelVersions []types.ModelVersion

	// The rule execution mode to add to the detector. If you specify FIRST_MATCHED,
	// Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at
	// the first matched rule. Amazon Fraud dectector then provides the outcomes for
	// that single rule. If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates
	// all rules and returns the outcomes for all matched rules. You can define and
	// edit the rule mode at the detector version level, when it is in draft status.
	// The default behavior is FIRST_MATCHED.
	RuleExecutionMode types.RuleExecutionMode
}

type UpdateDetectorVersionMetadataInput

type UpdateDetectorVersionMetadataInput struct {

	// The description.
	//
	// This member is required.
	Description *string

	// The detector ID.
	//
	// This member is required.
	DetectorId *string

	// The detector version ID.
	//
	// This member is required.
	DetectorVersionId *string
}

type UpdateDetectorVersionMetadataOutput

type UpdateDetectorVersionMetadataOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateDetectorVersionOutput

type UpdateDetectorVersionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateDetectorVersionStatusInput

type UpdateDetectorVersionStatusInput struct {

	// The detector ID.
	//
	// This member is required.
	DetectorId *string

	// The detector version ID.
	//
	// This member is required.
	DetectorVersionId *string

	// The new status.
	//
	// This member is required.
	Status types.DetectorVersionStatus
}

type UpdateDetectorVersionStatusOutput

type UpdateDetectorVersionStatusOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateModelInput

type UpdateModelInput struct {

	// The model ID.
	//
	// This member is required.
	ModelId *string

	// The model type.
	//
	// This member is required.
	ModelType types.ModelTypeEnum

	// The new model description.
	Description *string
}

type UpdateModelOutput

type UpdateModelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateModelVersionInput

type UpdateModelVersionInput struct {

	// The major version number.
	//
	// This member is required.
	MajorVersionNumber *string

	// The model ID.
	//
	// This member is required.
	ModelId *string

	// The model type.
	//
	// This member is required.
	ModelType types.ModelTypeEnum

	// The event details.
	ExternalEventsDetail *types.ExternalEventsDetail

	// A collection of key and value pairs.
	Tags []types.Tag
}

type UpdateModelVersionOutput

type UpdateModelVersionOutput struct {

	// The model ID.
	ModelId *string

	// The model type.
	ModelType types.ModelTypeEnum

	// The model version number of the model version updated.
	ModelVersionNumber *string

	// The status of the updated model version.
	Status *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateModelVersionStatusInput

type UpdateModelVersionStatusInput struct {

	// The model ID of the model version to update.
	//
	// This member is required.
	ModelId *string

	// The model type.
	//
	// This member is required.
	ModelType types.ModelTypeEnum

	// The model version number.
	//
	// This member is required.
	ModelVersionNumber *string

	// The model version status.
	//
	// This member is required.
	Status types.ModelVersionStatus
}

type UpdateModelVersionStatusOutput

type UpdateModelVersionStatusOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateRuleMetadataInput

type UpdateRuleMetadataInput struct {

	// The rule description.
	//
	// This member is required.
	Description *string

	// The rule to update.
	//
	// This member is required.
	Rule *types.Rule
}

type UpdateRuleMetadataOutput

type UpdateRuleMetadataOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateRuleVersionInput

type UpdateRuleVersionInput struct {

	// The rule expression.
	//
	// This member is required.
	Expression *string

	// The language.
	//
	// This member is required.
	Language types.Language

	// The outcomes.
	//
	// This member is required.
	Outcomes []string

	// The rule to update.
	//
	// This member is required.
	Rule *types.Rule

	// The description.
	Description *string

	// The tags to assign to the rule version.
	Tags []types.Tag
}

type UpdateRuleVersionOutput

type UpdateRuleVersionOutput struct {

	// The new rule version that was created.
	Rule *types.Rule

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateVariableInput

type UpdateVariableInput struct {

	// The name of the variable.
	//
	// This member is required.
	Name *string

	// The new default value of the variable.
	DefaultValue *string

	// The new description.
	Description *string

	// The variable type. For more information see Variable types
	// (https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types).
	VariableType *string
}

type UpdateVariableOutput

type UpdateVariableOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Source Files

api_client.go api_op_BatchCreateVariable.go api_op_BatchGetVariable.go api_op_CreateDetectorVersion.go api_op_CreateModel.go api_op_CreateModelVersion.go api_op_CreateRule.go api_op_CreateVariable.go api_op_DeleteDetector.go api_op_DeleteDetectorVersion.go api_op_DeleteEntityType.go api_op_DeleteEvent.go api_op_DeleteEventType.go api_op_DeleteExternalModel.go api_op_DeleteLabel.go api_op_DeleteModel.go api_op_DeleteModelVersion.go api_op_DeleteOutcome.go api_op_DeleteRule.go api_op_DeleteVariable.go api_op_DescribeDetector.go api_op_DescribeModelVersions.go api_op_GetDetectorVersion.go api_op_GetDetectors.go api_op_GetEntityTypes.go api_op_GetEventPrediction.go api_op_GetEventTypes.go api_op_GetExternalModels.go api_op_GetKMSEncryptionKey.go api_op_GetLabels.go api_op_GetModelVersion.go api_op_GetModels.go api_op_GetOutcomes.go api_op_GetRules.go api_op_GetVariables.go api_op_ListTagsForResource.go api_op_PutDetector.go api_op_PutEntityType.go api_op_PutEventType.go api_op_PutExternalModel.go api_op_PutKMSEncryptionKey.go api_op_PutLabel.go api_op_PutOutcome.go api_op_TagResource.go api_op_UntagResource.go api_op_UpdateDetectorVersion.go api_op_UpdateDetectorVersionMetadata.go api_op_UpdateDetectorVersionStatus.go api_op_UpdateModel.go api_op_UpdateModelVersion.go api_op_UpdateModelVersionStatus.go api_op_UpdateRuleMetadata.go api_op_UpdateRuleVersion.go api_op_UpdateVariable.go deserializers.go doc.go endpoints.go serializers.go validators.go

Directories

PathSynopsis
internal
types
Version
v1.2.0
Published
Mar 18, 2021
Platform
js/wasm
Imports
26 packages
Last checked
now

Tools for package owners.