frauddetector

package module
v1.31.4 Latest Latest
Warning

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

Go to latest
Published: Mar 29, 2024 License: Apache-2.0 Imports: 39 Imported by: 16

Documentation

Overview

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/) . We provide the Query API as well as AWS software development kits (SDK) for Amazon Fraud Detector in Java and Python programming languages. The Amazon Fraud Detector Query API provides HTTPS requests that use the HTTP verb GET or POST and a Query parameter Action . AWS SDK provides libraries, sample code, tutorials, and other resources for software developers who prefer to build applications using language-specific APIs instead of submitting a request over HTTP or HTTPS. These libraries provide basic functions that automatically take care of tasks such as cryptographically signing your requests, retrying requests, and handling error responses, so that it is easier for you to get started. For more information about the AWS SDKs, go to Tools to build on AWS (https://aws.amazon.com/developer/tools/) page, scroll down to the SDK section, and choose plus (+) sign to expand the section.

Index

Constants

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

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0

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

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

func WithEndpointResolver deprecated

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.26.0

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.28.2

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.28.2

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.28.2

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.28.2

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type BatchGetVariableInput

type BatchGetVariableInput struct {

	// The list of variable names to get.
	//
	// This member is required.
	Names []string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type CancelBatchImportJobInput added in v1.10.0

type CancelBatchImportJobInput struct {

	// The ID of an in-progress batch import job to cancel. Amazon Fraud Detector will
	// throw an error if the batch import job is in FAILED , CANCELED , or COMPLETED
	// state.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type CancelBatchImportJobOutput added in v1.10.0

type CancelBatchImportJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CancelBatchPredictionJobInput added in v1.3.0

type CancelBatchPredictionJobInput struct {

	// The ID of the batch prediction job to cancel.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type CancelBatchPredictionJobOutput added in v1.3.0

type CancelBatchPredictionJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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) CancelBatchImportJob added in v1.10.0

func (c *Client) CancelBatchImportJob(ctx context.Context, params *CancelBatchImportJobInput, optFns ...func(*Options)) (*CancelBatchImportJobOutput, error)

Cancels an in-progress batch import job.

func (*Client) CancelBatchPredictionJob added in v1.3.0

func (c *Client) CancelBatchPredictionJob(ctx context.Context, params *CancelBatchPredictionJobInput, optFns ...func(*Options)) (*CancelBatchPredictionJobOutput, error)

Cancels the specified batch prediction job.

func (*Client) CreateBatchImportJob added in v1.10.0

func (c *Client) CreateBatchImportJob(ctx context.Context, params *CreateBatchImportJobInput, optFns ...func(*Options)) (*CreateBatchImportJobOutput, error)

Creates a batch import job.

func (*Client) CreateBatchPredictionJob added in v1.3.0

func (c *Client) CreateBatchPredictionJob(ctx context.Context, params *CreateBatchPredictionJobInput, optFns ...func(*Options)) (*CreateBatchPredictionJobOutput, error)

Creates a batch prediction job.

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) CreateList added in v1.23.0

func (c *Client) CreateList(ctx context.Context, params *CreateListInput, optFns ...func(*Options)) (*CreateListOutput, error)

Creates a list. List is a set of input data for a variable in your event dataset. You use the input data in a rule that's associated with your detector. For more information, see Lists (https://docs.aws.amazon.com/frauddetector/latest/ug/lists.html) .

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) DeleteBatchImportJob added in v1.10.0

func (c *Client) DeleteBatchImportJob(ctx context.Context, params *DeleteBatchImportJobInput, optFns ...func(*Options)) (*DeleteBatchImportJobOutput, error)

Deletes the specified batch import job ID record. This action does not delete the data that was batch imported.

func (*Client) DeleteBatchPredictionJob added in v1.3.0

func (c *Client) DeleteBatchPredictionJob(ctx context.Context, params *DeleteBatchPredictionJobInput, optFns ...func(*Options)) (*DeleteBatchPredictionJobOutput, error)

Deletes a batch prediction job.

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 added in v0.30.0

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. If deleteAuditHistory is True , event data is available through search for up to 30 seconds after the delete operation is completed.

func (*Client) DeleteEventType added in v0.30.0

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 event type, Amazon Fraud Detector permanently deletes that event type and the data is no longer stored in Amazon Fraud Detector.

func (*Client) DeleteEventsByEventType added in v1.10.0

func (c *Client) DeleteEventsByEventType(ctx context.Context, params *DeleteEventsByEventTypeInput, optFns ...func(*Options)) (*DeleteEventsByEventTypeOutput, error)

Deletes all events of a particular event type.

func (*Client) DeleteExternalModel added in v0.30.0

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 added in v0.30.0

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) DeleteList added in v1.23.0

func (c *Client) DeleteList(ctx context.Context, params *DeleteListInput, optFns ...func(*Options)) (*DeleteListOutput, error)

Deletes the list, provided it is not used in a rule. When you delete a list, Amazon Fraud Detector permanently deletes that list and the elements in the list.

func (*Client) DeleteModel added in v0.30.0

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 added in v0.30.0

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 added in v0.30.0

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 added in v0.30.0

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) GetBatchImportJobs added in v1.10.0

func (c *Client) GetBatchImportJobs(ctx context.Context, params *GetBatchImportJobsInput, optFns ...func(*Options)) (*GetBatchImportJobsOutput, error)

Gets all batch import jobs or a specific job of the specified ID. 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 1 and 50. To get the next page results, provide the pagination token from the GetBatchImportJobsResponse as part of your request. A null pagination token fetches the records from the beginning.

func (*Client) GetBatchPredictionJobs added in v1.3.0

func (c *Client) GetBatchPredictionJobs(ctx context.Context, params *GetBatchPredictionJobsInput, optFns ...func(*Options)) (*GetBatchPredictionJobsOutput, error)

Gets all batch prediction jobs or a specific job if you specify a job ID. 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 1 and 50. To get the next page results, provide the pagination token from the GetBatchPredictionJobsResponse as part of your request. A null pagination token fetches the records from the beginning.

func (*Client) GetDeleteEventsByEventTypeStatus added in v1.10.0

func (c *Client) GetDeleteEventsByEventTypeStatus(ctx context.Context, params *GetDeleteEventsByEventTypeStatusInput, optFns ...func(*Options)) (*GetDeleteEventsByEventTypeStatusOutput, error)

Retrieves the status of a DeleteEventsByEventType action.

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) GetEvent added in v1.10.0

func (c *Client) GetEvent(ctx context.Context, params *GetEventInput, optFns ...func(*Options)) (*GetEventOutput, error)

Retrieves details of events stored with Amazon Fraud Detector. This action does not retrieve prediction results.

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) GetEventPredictionMetadata added in v1.17.0

func (c *Client) GetEventPredictionMetadata(ctx context.Context, params *GetEventPredictionMetadataInput, optFns ...func(*Options)) (*GetEventPredictionMetadataOutput, error)

Gets details of the past fraud predictions for the specified event ID, event type, detector ID, and detector version ID that was generated in the specified time period.

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 KMS key 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) GetListElements added in v1.23.0

func (c *Client) GetListElements(ctx context.Context, params *GetListElementsInput, optFns ...func(*Options)) (*GetListElementsOutput, error)

Gets all the elements in the specified list.

func (*Client) GetListsMetadata added in v1.23.0

func (c *Client) GetListsMetadata(ctx context.Context, params *GetListsMetadataInput, optFns ...func(*Options)) (*GetListsMetadataOutput, error)

Gets the metadata of either all the lists under the account or the specified list.

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 Amazon Web Services account if no model type and no model id provided. Gets all models for the Amazon Web Services 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) ListEventPredictions added in v1.17.0

func (c *Client) ListEventPredictions(ctx context.Context, params *ListEventPredictionsInput, optFns ...func(*Options)) (*ListEventPredictionsOutput, error)

Gets a list of past predictions. The list can be filtered by detector ID, detector version ID, event ID, event type, or by specifying a time period. If filter is not specified, the most recent prediction is returned. For example, the following filter lists all past predictions for xyz event type - { "eventType":{ "value": "xyz" }” } This is a paginated API. If you provide a null maxResults , this action will retrieve a maximum of 10 records per page. If you provide a maxResults , the value must be between 50 and 100. To get the next page results, provide the nextToken from the response as part of your request. A null nextToken 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) Options added in v1.29.0

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

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 KMS key 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) SendEvent added in v1.10.0

func (c *Client) SendEvent(ctx context.Context, params *SendEventInput, optFns ...func(*Options)) (*SendEventOutput, error)

Stores events in Amazon Fraud Detector without generating fraud predictions for those events. For example, you can use SendEvent to upload a historical dataset, which you can then later use to train a model.

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) UpdateEventLabel added in v1.10.0

func (c *Client) UpdateEventLabel(ctx context.Context, params *UpdateEventLabelInput, optFns ...func(*Options)) (*UpdateEventLabelOutput, error)

Updates the specified event with a new label.

func (*Client) UpdateList added in v1.23.0

func (c *Client) UpdateList(ctx context.Context, params *UpdateListInput, optFns ...func(*Options)) (*UpdateListOutput, error)

Updates a list.

func (*Client) UpdateModel

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

Updates model description.

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_IN_PROGRESS status to TRAINING_CANCELLED .
  • Change the TRAINING_COMPLETE status to ACTIVE .
  • Change ACTIVE to 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 CreateBatchImportJobInput added in v1.10.0

type CreateBatchImportJobInput struct {

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

	// The ARN of the IAM role created for Amazon S3 bucket that holds your data file.
	// The IAM role must have read permissions to your input S3 bucket and write
	// permissions to your output S3 bucket. For more information about bucket
	// permissions, see User policy examples (https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-policies-s3.html)
	// in the Amazon S3 User Guide.
	//
	// This member is required.
	IamRoleArn *string

	// The URI that points to the Amazon S3 location of your data file.
	//
	// This member is required.
	InputPath *string

	// The ID of the batch import job. The ID cannot be of a past job, unless the job
	// exists in CREATE_FAILED state.
	//
	// This member is required.
	JobId *string

	// The URI that points to the Amazon S3 location for storing your results.
	//
	// This member is required.
	OutputPath *string

	// A collection of key-value pairs associated with this request.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateBatchImportJobOutput added in v1.10.0

type CreateBatchImportJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateBatchPredictionJobInput added in v1.3.0

type CreateBatchPredictionJobInput struct {

	// The name of the detector.
	//
	// This member is required.
	DetectorName *string

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

	// The ARN of the IAM role to use for this job request. The IAM Role must have
	// read permissions to your input S3 bucket and write permissions to your output S3
	// bucket. For more information about bucket permissions, see User policy examples (https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-policies-s3.html)
	// in the Amazon S3 User Guide.
	//
	// This member is required.
	IamRoleArn *string

	// The Amazon S3 location of your training file.
	//
	// This member is required.
	InputPath *string

	// The ID of the batch prediction job.
	//
	// This member is required.
	JobId *string

	// The Amazon S3 location of your output file.
	//
	// This member is required.
	OutputPath *string

	// The detector version.
	DetectorVersion *string

	// A collection of key and value pairs.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateBatchPredictionJobOutput added in v1.3.0

type CreateBatchPredictionJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type CreateListInput added in v1.23.0

type CreateListInput struct {

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

	// The description of the list.
	Description *string

	// The names of the elements, if providing. You can also create an empty list and
	// add elements later using the UpdateList (https://docs.aws.amazon.com/frauddetector/latest/api/API_Updatelist.html)
	// API.
	Elements []string

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

	// The variable type of the list. You can only assign the variable type with
	// String data type. For more information, see Variable types (https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#variable-types)
	// .
	VariableType *string
	// contains filtered or unexported fields
}

type CreateListOutput added in v1.23.0

type CreateListOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type CreateModelOutput

type CreateModelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 of the external events data used for model version training. Required
	// if trainingDataSource is EXTERNAL_EVENTS .
	ExternalEventsDetail *types.ExternalEventsDetail

	// Details of the ingested events data used for model version training. Required
	// if trainingDataSource is INGESTED_EVENTS .
	IngestedEventsDetail *types.IngestedEventsDetail

	// A collection of key and value pairs.
	Tags []types.Tag
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type CreateRuleOutput

type CreateRuleOutput struct {

	// The created rule.
	Rule *types.Rule

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateVariableInput

type CreateVariableInput struct {

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

	// The data type of the variable.
	//
	// 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
	// contains filtered or unexported fields
}

type CreateVariableOutput

type CreateVariableOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteBatchImportJobInput added in v1.10.0

type DeleteBatchImportJobInput struct {

	// The ID of the batch import job to delete.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type DeleteBatchImportJobOutput added in v1.10.0

type DeleteBatchImportJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteBatchPredictionJobInput added in v1.3.0

type DeleteBatchPredictionJobInput struct {

	// The ID of the batch prediction job to delete.
	//
	// This member is required.
	JobId *string
	// contains filtered or unexported fields
}

type DeleteBatchPredictionJobOutput added in v1.3.0

type DeleteBatchPredictionJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDetectorInput

type DeleteDetectorInput struct {

	// The ID of the detector to delete.
	//
	// This member is required.
	DetectorId *string
	// contains filtered or unexported fields
}

type DeleteDetectorOutput

type DeleteDetectorOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type DeleteDetectorVersionOutput

type DeleteDetectorVersionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteEntityTypeInput added in v0.30.0

type DeleteEntityTypeInput struct {

	// The name of the entity type to delete.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type DeleteEntityTypeOutput added in v0.30.0

type DeleteEntityTypeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

	// Specifies whether or not to delete any predictions associated with the event.
	// If set to True ,
	DeleteAuditHistory *bool
	// contains filtered or unexported fields
}

type DeleteEventOutput

type DeleteEventOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteEventTypeInput added in v0.30.0

type DeleteEventTypeInput struct {

	// The name of the event type to delete.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type DeleteEventTypeOutput added in v0.30.0

type DeleteEventTypeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteEventsByEventTypeInput added in v1.10.0

type DeleteEventsByEventTypeInput struct {

	// The name of the event type.
	//
	// This member is required.
	EventTypeName *string
	// contains filtered or unexported fields
}

type DeleteEventsByEventTypeOutput added in v1.10.0

type DeleteEventsByEventTypeOutput struct {

	// Name of event type for which to delete the events.
	EventTypeName *string

	// The status of the delete request.
	EventsDeletionStatus *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteExternalModelInput added in v0.30.0

type DeleteExternalModelInput struct {

	// The endpoint of the Amazon Sagemaker model to delete.
	//
	// This member is required.
	ModelEndpoint *string
	// contains filtered or unexported fields
}

type DeleteExternalModelOutput added in v0.30.0

type DeleteExternalModelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteLabelInput added in v0.30.0

type DeleteLabelInput struct {

	// The name of the label to delete.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type DeleteLabelOutput added in v0.30.0

type DeleteLabelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteListInput added in v1.23.0

type DeleteListInput struct {

	// The name of the list to delete.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type DeleteListOutput added in v1.23.0

type DeleteListOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteModelInput added in v0.30.0

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
	// contains filtered or unexported fields
}

type DeleteModelOutput added in v0.30.0

type DeleteModelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteModelVersionInput added in v0.30.0

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
	// contains filtered or unexported fields
}

type DeleteModelVersionOutput added in v0.30.0

type DeleteModelVersionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteOutcomeInput added in v0.30.0

type DeleteOutcomeInput struct {

	// The name of the outcome to delete.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type DeleteOutcomeOutput added in v0.30.0

type DeleteOutcomeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteRuleInput

type DeleteRuleInput struct {

	// A rule.
	//
	// This member is required.
	Rule *types.Rule
	// contains filtered or unexported fields
}

type DeleteRuleOutput

type DeleteRuleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteVariableInput added in v0.30.0

type DeleteVariableInput struct {

	// The name of the variable to delete.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type DeleteVariableOutput added in v0.30.0

type DeleteVariableOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type DescribeModelVersionsAPIClient added in v0.30.0

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type DescribeModelVersionsPaginator added in v0.30.0

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

DescribeModelVersionsPaginator is a paginator for DescribeModelVersions

func NewDescribeModelVersionsPaginator added in v0.30.0

NewDescribeModelVersionsPaginator returns a new DescribeModelVersionsPaginator

func (*DescribeModelVersionsPaginator) HasMorePages added in v0.30.0

func (p *DescribeModelVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeModelVersionsPaginator) NextPage added in v0.30.0

NextPage retrieves the next DescribeModelVersions page.

type DescribeModelVersionsPaginatorOptions added in v0.30.0

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 EndpointParameters added in v1.26.0

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.26.0

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.26.0

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0

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 added in v0.29.0

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.26.0

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.26.0

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetBatchImportJobsAPIClient added in v1.10.0

type GetBatchImportJobsAPIClient interface {
	GetBatchImportJobs(context.Context, *GetBatchImportJobsInput, ...func(*Options)) (*GetBatchImportJobsOutput, error)
}

GetBatchImportJobsAPIClient is a client that implements the GetBatchImportJobs operation.

type GetBatchImportJobsInput added in v1.10.0

type GetBatchImportJobsInput struct {

	// The ID of the batch import job to get.
	JobId *string

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

	// The next token from the previous request.
	NextToken *string
	// contains filtered or unexported fields
}

type GetBatchImportJobsOutput added in v1.10.0

type GetBatchImportJobsOutput struct {

	// An array containing the details of each batch import job.
	BatchImports []types.BatchImport

	// The next token for the subsequent resquest.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetBatchImportJobsPaginator added in v1.10.0

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

GetBatchImportJobsPaginator is a paginator for GetBatchImportJobs

func NewGetBatchImportJobsPaginator added in v1.10.0

func NewGetBatchImportJobsPaginator(client GetBatchImportJobsAPIClient, params *GetBatchImportJobsInput, optFns ...func(*GetBatchImportJobsPaginatorOptions)) *GetBatchImportJobsPaginator

NewGetBatchImportJobsPaginator returns a new GetBatchImportJobsPaginator

func (*GetBatchImportJobsPaginator) HasMorePages added in v1.10.0

func (p *GetBatchImportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetBatchImportJobsPaginator) NextPage added in v1.10.0

func (p *GetBatchImportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetBatchImportJobsOutput, error)

NextPage retrieves the next GetBatchImportJobs page.

type GetBatchImportJobsPaginatorOptions added in v1.10.0

type GetBatchImportJobsPaginatorOptions struct {
	// The maximum number of objects to return for 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
}

GetBatchImportJobsPaginatorOptions is the paginator options for GetBatchImportJobs

type GetBatchPredictionJobsAPIClient added in v1.3.0

type GetBatchPredictionJobsAPIClient interface {
	GetBatchPredictionJobs(context.Context, *GetBatchPredictionJobsInput, ...func(*Options)) (*GetBatchPredictionJobsOutput, error)
}

GetBatchPredictionJobsAPIClient is a client that implements the GetBatchPredictionJobs operation.

type GetBatchPredictionJobsInput added in v1.3.0

type GetBatchPredictionJobsInput struct {

	// The batch prediction job for which to get the details.
	JobId *string

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

	// The next token from the previous request.
	NextToken *string
	// contains filtered or unexported fields
}

type GetBatchPredictionJobsOutput added in v1.3.0

type GetBatchPredictionJobsOutput struct {

	// An array containing the details of each batch prediction job.
	BatchPredictions []types.BatchPrediction

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetBatchPredictionJobsPaginator added in v1.3.0

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

GetBatchPredictionJobsPaginator is a paginator for GetBatchPredictionJobs

func NewGetBatchPredictionJobsPaginator added in v1.3.0

NewGetBatchPredictionJobsPaginator returns a new GetBatchPredictionJobsPaginator

func (*GetBatchPredictionJobsPaginator) HasMorePages added in v1.3.0

func (p *GetBatchPredictionJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetBatchPredictionJobsPaginator) NextPage added in v1.3.0

NextPage retrieves the next GetBatchPredictionJobs page.

type GetBatchPredictionJobsPaginatorOptions added in v1.3.0

type GetBatchPredictionJobsPaginatorOptions 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
}

GetBatchPredictionJobsPaginatorOptions is the paginator options for GetBatchPredictionJobs

type GetDeleteEventsByEventTypeStatusInput added in v1.10.0

type GetDeleteEventsByEventTypeStatusInput struct {

	// Name of event type for which to get the deletion status.
	//
	// This member is required.
	EventTypeName *string
	// contains filtered or unexported fields
}

type GetDeleteEventsByEventTypeStatusOutput added in v1.10.0

type GetDeleteEventsByEventTypeStatusOutput struct {

	// The event type name.
	EventTypeName *string

	// The deletion status.
	EventsDeletionStatus types.AsyncJobStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetDetectorVersionInput

type GetDetectorVersionInput struct {

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

	// The detector version ID.
	//
	// This member is required.
	DetectorVersionId *string
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type GetDetectorsAPIClient added in v0.30.0

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type GetDetectorsPaginator added in v0.30.0

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

GetDetectorsPaginator is a paginator for GetDetectors

func NewGetDetectorsPaginator added in v0.30.0

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

NewGetDetectorsPaginator returns a new GetDetectorsPaginator

func (*GetDetectorsPaginator) HasMorePages added in v0.30.0

func (p *GetDetectorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetDetectorsPaginator) NextPage added in v0.30.0

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

NextPage retrieves the next GetDetectors page.

type GetDetectorsPaginatorOptions added in v0.30.0

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 added in v0.30.0

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type GetEntityTypesPaginator added in v0.30.0

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

GetEntityTypesPaginator is a paginator for GetEntityTypes

func NewGetEntityTypesPaginator added in v0.30.0

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

NewGetEntityTypesPaginator returns a new GetEntityTypesPaginator

func (*GetEntityTypesPaginator) HasMorePages added in v0.30.0

func (p *GetEntityTypesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetEntityTypesPaginator) NextPage added in v0.30.0

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

NextPage retrieves the next GetEntityTypes page.

type GetEntityTypesPaginatorOptions added in v0.30.0

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 GetEventInput added in v1.10.0

type GetEventInput struct {

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

	// The event type of the event to retrieve.
	//
	// This member is required.
	EventTypeName *string
	// contains filtered or unexported fields
}

type GetEventOutput added in v1.10.0

type GetEventOutput struct {

	// The details of the event.
	Event *types.Event

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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. The timestamp
	// must be specified using ISO 8601 standard in UTC.
	//
	// 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. You must provide at least one eventVariable To ensure
	// most accurate fraud prediction and to simplify your data preparation, Amazon
	// Fraud Detector will replace all missing variables or values as follows: For
	// Amazon Fraud Detector trained models: If a null value is provided explicitly for
	// a variable or if a variable is missing, model will replace the null value or the
	// missing variable (no variable name in the eventVariables map) with calculated
	// default mean/medians for numeric variables and with special values for
	// categorical variables. For imported SageMaker models: If a null value is
	// provided explicitly for a variable, the model and rules will use “null” as the
	// value. If a variable is not provided (no variable name in the eventVariables
	// map), model and rules will use the default value that is provided for the
	// variable.
	//
	// 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
	// contains filtered or unexported fields
}

type GetEventPredictionMetadataInput added in v1.17.0

type GetEventPredictionMetadataInput struct {

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

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

	// The event ID.
	//
	// This member is required.
	EventId *string

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

	// The timestamp that defines when the prediction was generated. The timestamp
	// must be specified using ISO 8601 standard in UTC. We recommend calling
	// ListEventPredictions (https://docs.aws.amazon.com/frauddetector/latest/api/API_ListEventPredictions.html)
	// first, and using the predictionTimestamp value in the response to provide an
	// accurate prediction timestamp value.
	//
	// This member is required.
	PredictionTimestamp *string
	// contains filtered or unexported fields
}

type GetEventPredictionMetadataOutput added in v1.17.0

type GetEventPredictionMetadataOutput struct {

	// The detector ID.
	DetectorId *string

	// The detector version ID.
	DetectorVersionId *string

	// The status of the detector version.
	DetectorVersionStatus *string

	// The entity ID.
	EntityId *string

	// The entity type.
	EntityType *string

	// External (Amazon SageMaker) models that were evaluated for generating
	// predictions.
	EvaluatedExternalModels []types.EvaluatedExternalModel

	// Model versions that were evaluated for generating predictions.
	EvaluatedModelVersions []types.EvaluatedModelVersion

	// The event ID.
	EventId *string

	// The timestamp for when the prediction was generated for the associated event ID.
	EventTimestamp *string

	// The event type associated with the detector specified for this prediction.
	EventTypeName *string

	// A list of event variables that influenced the prediction scores.
	EventVariables []types.EventVariableSummary

	// The outcomes of the matched rule, based on the rule execution mode.
	Outcomes []string

	// The timestamp that defines when the prediction was generated.
	PredictionTimestamp *string

	// The execution mode of the rule used for evaluating variable values.
	RuleExecutionMode types.RuleExecutionMode

	// List of rules associated with the detector version that were used for
	// evaluating variable values.
	Rules []types.EvaluatedRule

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetEventPredictionOutput

type GetEventPredictionOutput struct {

	// The model scores for Amazon SageMaker models.
	ExternalModelOutputs []types.ExternalModelOutputs

	// 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 from the rules.
	RuleResults []types.RuleResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetEventTypesAPIClient added in v0.30.0

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type GetEventTypesPaginator added in v0.30.0

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

GetEventTypesPaginator is a paginator for GetEventTypes

func NewGetEventTypesPaginator added in v0.30.0

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

NewGetEventTypesPaginator returns a new GetEventTypesPaginator

func (*GetEventTypesPaginator) HasMorePages added in v0.30.0

func (p *GetEventTypesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetEventTypesPaginator) NextPage added in v0.30.0

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

NextPage retrieves the next GetEventTypes page.

type GetEventTypesPaginatorOptions added in v0.30.0

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 added in v0.30.0

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type GetExternalModelsPaginator added in v0.30.0

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

GetExternalModelsPaginator is a paginator for GetExternalModels

func NewGetExternalModelsPaginator added in v0.30.0

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

NewGetExternalModelsPaginator returns a new GetExternalModelsPaginator

func (*GetExternalModelsPaginator) HasMorePages added in v0.30.0

func (p *GetExternalModelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetExternalModelsPaginator) NextPage added in v0.30.0

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

NextPage retrieves the next GetExternalModels page.

type GetExternalModelsPaginatorOptions added in v0.30.0

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 {
	// contains filtered or unexported fields
}

type GetKMSEncryptionKeyOutput

type GetKMSEncryptionKeyOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetLabelsAPIClient added in v0.30.0

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type GetLabelsPaginator added in v0.30.0

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

GetLabelsPaginator is a paginator for GetLabels

func NewGetLabelsPaginator added in v0.30.0

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

NewGetLabelsPaginator returns a new GetLabelsPaginator

func (*GetLabelsPaginator) HasMorePages added in v0.30.0

func (p *GetLabelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetLabelsPaginator) NextPage added in v0.30.0

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

NextPage retrieves the next GetLabels page.

type GetLabelsPaginatorOptions added in v0.30.0

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 GetListElementsAPIClient added in v1.23.0

type GetListElementsAPIClient interface {
	GetListElements(context.Context, *GetListElementsInput, ...func(*Options)) (*GetListElementsOutput, error)
}

GetListElementsAPIClient is a client that implements the GetListElements operation.

type GetListElementsInput added in v1.23.0

type GetListElementsInput struct {

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

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

	// The next token for the subsequent request.
	NextToken *string
	// contains filtered or unexported fields
}

type GetListElementsOutput added in v1.23.0

type GetListElementsOutput struct {

	// The list elements.
	Elements []string

	// The next page token.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetListElementsPaginator added in v1.23.0

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

GetListElementsPaginator is a paginator for GetListElements

func NewGetListElementsPaginator added in v1.23.0

func NewGetListElementsPaginator(client GetListElementsAPIClient, params *GetListElementsInput, optFns ...func(*GetListElementsPaginatorOptions)) *GetListElementsPaginator

NewGetListElementsPaginator returns a new GetListElementsPaginator

func (*GetListElementsPaginator) HasMorePages added in v1.23.0

func (p *GetListElementsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetListElementsPaginator) NextPage added in v1.23.0

func (p *GetListElementsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetListElementsOutput, error)

NextPage retrieves the next GetListElements page.

type GetListElementsPaginatorOptions added in v1.23.0

type GetListElementsPaginatorOptions 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
}

GetListElementsPaginatorOptions is the paginator options for GetListElements

type GetListsMetadataAPIClient added in v1.23.0

type GetListsMetadataAPIClient interface {
	GetListsMetadata(context.Context, *GetListsMetadataInput, ...func(*Options)) (*GetListsMetadataOutput, error)
}

GetListsMetadataAPIClient is a client that implements the GetListsMetadata operation.

type GetListsMetadataInput added in v1.23.0

type GetListsMetadataInput struct {

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

	// The name of the list.
	Name *string

	// The next token for the subsequent request.
	NextToken *string
	// contains filtered or unexported fields
}

type GetListsMetadataOutput added in v1.23.0

type GetListsMetadataOutput struct {

	// The metadata of the specified list or all lists under the account.
	Lists []types.AllowDenyList

	// The next page token.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetListsMetadataPaginator added in v1.23.0

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

GetListsMetadataPaginator is a paginator for GetListsMetadata

func NewGetListsMetadataPaginator added in v1.23.0

func NewGetListsMetadataPaginator(client GetListsMetadataAPIClient, params *GetListsMetadataInput, optFns ...func(*GetListsMetadataPaginatorOptions)) *GetListsMetadataPaginator

NewGetListsMetadataPaginator returns a new GetListsMetadataPaginator

func (*GetListsMetadataPaginator) HasMorePages added in v1.23.0

func (p *GetListsMetadataPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetListsMetadataPaginator) NextPage added in v1.23.0

func (p *GetListsMetadataPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetListsMetadataOutput, error)

NextPage retrieves the next GetListsMetadata page.

type GetListsMetadataPaginatorOptions added in v1.23.0

type GetListsMetadataPaginatorOptions 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
}

GetListsMetadataPaginatorOptions is the paginator options for GetListsMetadata

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
	// contains filtered or unexported fields
}

type GetModelVersionOutput

type GetModelVersionOutput struct {

	// The model version ARN.
	Arn *string

	// The details of the external events data used for training the model version.
	// This will be populated if the trainingDataSource is EXTERNAL_EVENTS
	ExternalEventsDetail *types.ExternalEventsDetail

	// The details of the ingested events data used for training the model version.
	// This will be populated if the trainingDataSource is INGESTED_EVENTS .
	IngestedEventsDetail *types.IngestedEventsDetail

	// 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
	// contains filtered or unexported fields
}

type GetModelsAPIClient added in v0.30.0

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type GetModelsPaginator added in v0.30.0

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

GetModelsPaginator is a paginator for GetModels

func NewGetModelsPaginator added in v0.30.0

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

NewGetModelsPaginator returns a new GetModelsPaginator

func (*GetModelsPaginator) HasMorePages added in v0.30.0

func (p *GetModelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetModelsPaginator) NextPage added in v0.30.0

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

NextPage retrieves the next GetModels page.

type GetModelsPaginatorOptions added in v0.30.0

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 added in v0.30.0

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type GetOutcomesPaginator added in v0.30.0

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

GetOutcomesPaginator is a paginator for GetOutcomes

func NewGetOutcomesPaginator added in v0.30.0

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

NewGetOutcomesPaginator returns a new GetOutcomesPaginator

func (*GetOutcomesPaginator) HasMorePages added in v0.30.0

func (p *GetOutcomesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetOutcomesPaginator) NextPage added in v0.30.0

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

NextPage retrieves the next GetOutcomes page.

type GetOutcomesPaginatorOptions added in v0.30.0

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 added in v0.30.0

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type GetRulesPaginator added in v0.30.0

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

GetRulesPaginator is a paginator for GetRules

func NewGetRulesPaginator added in v0.30.0

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

NewGetRulesPaginator returns a new GetRulesPaginator

func (*GetRulesPaginator) HasMorePages added in v0.30.0

func (p *GetRulesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetRulesPaginator) NextPage added in v0.30.0

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

NextPage retrieves the next GetRules page.

type GetRulesPaginatorOptions added in v0.30.0

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 added in v0.30.0

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type GetVariablesPaginator added in v0.30.0

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

GetVariablesPaginator is a paginator for GetVariables

func NewGetVariablesPaginator added in v0.30.0

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

NewGetVariablesPaginator returns a new GetVariablesPaginator

func (*GetVariablesPaginator) HasMorePages added in v0.30.0

func (p *GetVariablesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetVariablesPaginator) NextPage added in v0.30.0

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

NextPage retrieves the next GetVariables page.

type GetVariablesPaginatorOptions added in v0.30.0

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 ListEventPredictionsAPIClient added in v1.17.0

type ListEventPredictionsAPIClient interface {
	ListEventPredictions(context.Context, *ListEventPredictionsInput, ...func(*Options)) (*ListEventPredictionsOutput, error)
}

ListEventPredictionsAPIClient is a client that implements the ListEventPredictions operation.

type ListEventPredictionsInput added in v1.17.0

type ListEventPredictionsInput struct {

	// The detector ID.
	DetectorId *types.FilterCondition

	// The detector version ID.
	DetectorVersionId *types.FilterCondition

	// The event ID.
	EventId *types.FilterCondition

	// The event type associated with the detector.
	EventType *types.FilterCondition

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

	// Identifies the next page of results to return. Use the token to make the call
	// again to retrieve the next page. Keep all other arguments unchanged. Each
	// pagination token expires after 24 hours.
	NextToken *string

	// The time period for when the predictions were generated.
	PredictionTimeRange *types.PredictionTimeRange
	// contains filtered or unexported fields
}

type ListEventPredictionsOutput added in v1.17.0

type ListEventPredictionsOutput struct {

	// The summary of the past predictions.
	EventPredictionSummaries []types.EventPredictionSummary

	// Identifies the next page of results to return. Use the token to make the call
	// again to retrieve the next page. Keep all other arguments unchanged. Each
	// pagination token expires after 24 hours.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListEventPredictionsPaginator added in v1.17.0

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

ListEventPredictionsPaginator is a paginator for ListEventPredictions

func NewListEventPredictionsPaginator added in v1.17.0

NewListEventPredictionsPaginator returns a new ListEventPredictionsPaginator

func (*ListEventPredictionsPaginator) HasMorePages added in v1.17.0

func (p *ListEventPredictionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEventPredictionsPaginator) NextPage added in v1.17.0

NextPage retrieves the next ListEventPredictions page.

type ListEventPredictionsPaginatorOptions added in v1.17.0

type ListEventPredictionsPaginatorOptions struct {
	// The maximum number of predictions 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
}

ListEventPredictionsPaginatorOptions is the paginator options for ListEventPredictions

type ListTagsForResourceAPIClient added in v0.30.0

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type ListTagsForResourcePaginator added in v0.30.0

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

ListTagsForResourcePaginator is a paginator for ListTagsForResource

func NewListTagsForResourcePaginator added in v0.30.0

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

NewListTagsForResourcePaginator returns a new ListTagsForResourcePaginator

func (*ListTagsForResourcePaginator) HasMorePages added in v0.30.0

func (p *ListTagsForResourcePaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTagsForResourcePaginator) NextPage added in v0.30.0

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

NextPage retrieves the next ListTagsForResource page.

type ListTagsForResourcePaginatorOptions added in v0.30.0

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

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// 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 configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

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

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom
	// endpoint, set the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// 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

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. If specified in an operation call's
	// functional options with a value that is different than the constructed client's
	// Options, the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

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

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver added in v1.28.2

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

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
	// contains filtered or unexported fields
}

type PutDetectorOutput

type PutDetectorOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type PutEntityTypeOutput

type PutEntityTypeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

	// Specifies if ingestion is enabled or disabled.
	EventIngestion types.EventIngestion

	// Enables or disables event orchestration. If enabled, you can send event
	// predictions to select AWS services for downstream processing of the events.
	EventOrchestration *types.EventOrchestration

	// The event type labels.
	Labels []string

	// A collection of key and value pairs.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type PutEventTypeOutput

type PutEventTypeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type PutExternalModelOutput

type PutExternalModelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutKMSEncryptionKeyInput

type PutKMSEncryptionKeyInput struct {

	// The KMS encryption key ARN. The KMS key must be single-Region key. Amazon Fraud
	// Detector does not support multi-Region KMS key.
	//
	// This member is required.
	KmsEncryptionKeyArn *string
	// contains filtered or unexported fields
}

type PutKMSEncryptionKeyOutput

type PutKMSEncryptionKeyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutLabelInput

type PutLabelInput struct {

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

	// The label description.
	Description *string

	// A collection of key and value pairs.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type PutLabelOutput

type PutLabelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type PutOutcomeOutput

type PutOutcomeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type SendEventInput added in v1.10.0

type SendEventInput struct {

	// An array of entities.
	//
	// This member is required.
	Entities []types.Entity

	// The event ID to upload.
	//
	// This member is required.
	EventId *string

	// The timestamp that defines when the event under evaluation occurred. The
	// timestamp must be specified using ISO 8601 standard in UTC.
	//
	// This member is required.
	EventTimestamp *string

	// The event type name of the event.
	//
	// 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 label to associate with the event. Required if specifying labelTimestamp .
	AssignedLabel *string

	// The timestamp associated with the label. Required if specifying assignedLabel .
	LabelTimestamp *string
	// contains filtered or unexported fields
}

type SendEventOutput added in v1.10.0

type SendEventOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type UpdateDetectorVersionMetadataOutput

type UpdateDetectorVersionMetadataOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateDetectorVersionOutput

type UpdateDetectorVersionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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. The only supported values are ACTIVE and INACTIVE
	//
	// This member is required.
	Status types.DetectorVersionStatus
	// contains filtered or unexported fields
}

type UpdateDetectorVersionStatusOutput

type UpdateDetectorVersionStatusOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateEventLabelInput added in v1.10.0

type UpdateEventLabelInput struct {

	// The new label to assign to the event.
	//
	// This member is required.
	AssignedLabel *string

	// The ID of the event associated with the label to update.
	//
	// This member is required.
	EventId *string

	// The event type of the event associated with the label to update.
	//
	// This member is required.
	EventTypeName *string

	// The timestamp associated with the label. The timestamp must be specified using
	// ISO 8601 standard in UTC.
	//
	// This member is required.
	LabelTimestamp *string
	// contains filtered or unexported fields
}

type UpdateEventLabelOutput added in v1.10.0

type UpdateEventLabelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateListInput added in v1.23.0

type UpdateListInput struct {

	// The name of the list to update.
	//
	// This member is required.
	Name *string

	// The new description.
	Description *string

	// One or more list elements to add or replace. If you are providing the elements,
	// make sure to specify the updateMode to use. If you are deleting all elements
	// from the list, use REPLACE for the updateMode and provide an empty list (0
	// elements).
	Elements []string

	// The update mode (type).
	//   - Use APPEND if you are adding elements to the list.
	//   - Use REPLACE if you replacing existing elements in the list.
	//   - Use REMOVE if you are removing elements from the list.
	UpdateMode types.ListUpdateMode

	// The variable type you want to assign to the list. You cannot update a variable
	// type of a list that already has a variable type assigned to it. You can assign a
	// variable type to a list only if the list does not already have a variable type.
	VariableType *string
	// contains filtered or unexported fields
}

type UpdateListOutput added in v1.23.0

type UpdateListOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type UpdateModelOutput

type UpdateModelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 details of the external events data used for training the model version.
	// Required if trainingDataSource is EXTERNAL_EVENTS .
	ExternalEventsDetail *types.ExternalEventsDetail

	// The details of the ingested event used for training the model version. Required
	// if your trainingDataSource is INGESTED_EVENTS .
	IngestedEventsDetail *types.IngestedEventsDetail

	// A collection of key and value pairs.
	Tags []types.Tag
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type UpdateModelVersionStatusOutput

type UpdateModelVersionStatusOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type UpdateRuleMetadataOutput

type UpdateRuleMetadataOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

type UpdateVariableOutput

type UpdateVariableOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

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