FraudDetectorClient#
Index > FraudDetector > FraudDetectorClient
Auto-generated documentation for FraudDetector type annotations stubs module types-boto3-frauddetector.
FraudDetectorClient#
Type annotations and code completion for boto3.client("frauddetector")
.
boto3 documentation
# FraudDetectorClient usage example
from boto3.session import Session
from types_boto3_frauddetector.client import FraudDetectorClient
def get_frauddetector_client() -> FraudDetectorClient:
return Session().client("frauddetector")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("frauddetector").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("frauddetector")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ResourceUnavailableException,
client.exceptions.ThrottlingException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from types_boto3_frauddetector.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
can_paginate#
Type annotations and code completion for boto3.client("frauddetector").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
generate_presigned_url#
Type annotations and code completion for boto3.client("frauddetector").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
batch_create_variable#
Creates a batch of variables.
Type annotations and code completion for boto3.client("frauddetector").batch_create_variable
method.
boto3 documentation
# batch_create_variable method definition
def batch_create_variable(
self,
*,
variableEntries: Sequence[VariableEntryTypeDef], # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
) -> BatchCreateVariableResultTypeDef: # (3)
...
# batch_create_variable method usage example with argument unpacking
kwargs: BatchCreateVariableRequestRequestTypeDef = { # (1)
"variableEntries": ...,
}
parent.batch_create_variable(**kwargs)
batch_get_variable#
Gets a batch of variables.
Type annotations and code completion for boto3.client("frauddetector").batch_get_variable
method.
boto3 documentation
# batch_get_variable method definition
def batch_get_variable(
self,
*,
names: Sequence[str],
) -> BatchGetVariableResultTypeDef: # (1)
...
# batch_get_variable method usage example with argument unpacking
kwargs: BatchGetVariableRequestRequestTypeDef = { # (1)
"names": ...,
}
parent.batch_get_variable(**kwargs)
cancel_batch_import_job#
Cancels an in-progress batch import job.
Type annotations and code completion for boto3.client("frauddetector").cancel_batch_import_job
method.
boto3 documentation
# cancel_batch_import_job method definition
def cancel_batch_import_job(
self,
*,
jobId: str,
) -> dict[str, Any]:
...
# cancel_batch_import_job method usage example with argument unpacking
kwargs: CancelBatchImportJobRequestRequestTypeDef = { # (1)
"jobId": ...,
}
parent.cancel_batch_import_job(**kwargs)
cancel_batch_prediction_job#
Cancels the specified batch prediction job.
Type annotations and code completion for boto3.client("frauddetector").cancel_batch_prediction_job
method.
boto3 documentation
# cancel_batch_prediction_job method definition
def cancel_batch_prediction_job(
self,
*,
jobId: str,
) -> dict[str, Any]:
...
# cancel_batch_prediction_job method usage example with argument unpacking
kwargs: CancelBatchPredictionJobRequestRequestTypeDef = { # (1)
"jobId": ...,
}
parent.cancel_batch_prediction_job(**kwargs)
create_batch_import_job#
Creates a batch import job.
Type annotations and code completion for boto3.client("frauddetector").create_batch_import_job
method.
boto3 documentation
# create_batch_import_job method definition
def create_batch_import_job(
self,
*,
jobId: str,
inputPath: str,
outputPath: str,
eventTypeName: str,
iamRoleArn: str,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> dict[str, Any]:
...
- See TagTypeDef
# create_batch_import_job method usage example with argument unpacking
kwargs: CreateBatchImportJobRequestRequestTypeDef = { # (1)
"jobId": ...,
"inputPath": ...,
"outputPath": ...,
"eventTypeName": ...,
"iamRoleArn": ...,
}
parent.create_batch_import_job(**kwargs)
create_batch_prediction_job#
Creates a batch prediction job.
Type annotations and code completion for boto3.client("frauddetector").create_batch_prediction_job
method.
boto3 documentation
# create_batch_prediction_job method definition
def create_batch_prediction_job(
self,
*,
jobId: str,
inputPath: str,
outputPath: str,
eventTypeName: str,
detectorName: str,
iamRoleArn: str,
detectorVersion: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> dict[str, Any]:
...
- See TagTypeDef
# create_batch_prediction_job method usage example with argument unpacking
kwargs: CreateBatchPredictionJobRequestRequestTypeDef = { # (1)
"jobId": ...,
"inputPath": ...,
"outputPath": ...,
"eventTypeName": ...,
"detectorName": ...,
"iamRoleArn": ...,
}
parent.create_batch_prediction_job(**kwargs)
create_detector_version#
Creates a detector version.
Type annotations and code completion for boto3.client("frauddetector").create_detector_version
method.
boto3 documentation
# create_detector_version method definition
def create_detector_version(
self,
*,
detectorId: str,
rules: Sequence[RuleTypeDef], # (1)
description: str = ...,
externalModelEndpoints: Sequence[str] = ...,
modelVersions: Sequence[ModelVersionTypeDef] = ..., # (2)
ruleExecutionMode: RuleExecutionModeType = ..., # (3)
tags: Sequence[TagTypeDef] = ..., # (4)
) -> CreateDetectorVersionResultTypeDef: # (5)
...
- See RuleTypeDef
- See ModelVersionTypeDef
- See RuleExecutionModeType
- See TagTypeDef
- See CreateDetectorVersionResultTypeDef
# create_detector_version method usage example with argument unpacking
kwargs: CreateDetectorVersionRequestRequestTypeDef = { # (1)
"detectorId": ...,
"rules": ...,
}
parent.create_detector_version(**kwargs)
create_list#
Creates a list.
Type annotations and code completion for boto3.client("frauddetector").create_list
method.
boto3 documentation
# create_list method definition
def create_list(
self,
*,
name: str,
elements: Sequence[str] = ...,
variableType: str = ...,
description: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> dict[str, Any]:
...
- See TagTypeDef
# create_list method usage example with argument unpacking
kwargs: CreateListRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.create_list(**kwargs)
create_model#
Creates a model using the specified model type.
Type annotations and code completion for boto3.client("frauddetector").create_model
method.
boto3 documentation
# create_model method definition
def create_model(
self,
*,
modelId: str,
modelType: ModelTypeEnumType, # (1)
eventTypeName: str,
description: str = ...,
tags: Sequence[TagTypeDef] = ..., # (2)
) -> dict[str, Any]:
...
- See ModelTypeEnumType
- See TagTypeDef
# create_model method usage example with argument unpacking
kwargs: CreateModelRequestRequestTypeDef = { # (1)
"modelId": ...,
"modelType": ...,
"eventTypeName": ...,
}
parent.create_model(**kwargs)
create_model_version#
Creates a version of the model using the specified model type and model id.
Type annotations and code completion for boto3.client("frauddetector").create_model_version
method.
boto3 documentation
# create_model_version method definition
def create_model_version(
self,
*,
modelId: str,
modelType: ModelTypeEnumType, # (1)
trainingDataSource: TrainingDataSourceEnumType, # (2)
trainingDataSchema: TrainingDataSchemaTypeDef, # (3)
externalEventsDetail: ExternalEventsDetailTypeDef = ..., # (4)
ingestedEventsDetail: IngestedEventsDetailTypeDef = ..., # (5)
tags: Sequence[TagTypeDef] = ..., # (6)
) -> CreateModelVersionResultTypeDef: # (7)
...
- See ModelTypeEnumType
- See TrainingDataSourceEnumType
- See TrainingDataSchemaTypeDef
- See ExternalEventsDetailTypeDef
- See IngestedEventsDetailTypeDef
- See TagTypeDef
- See CreateModelVersionResultTypeDef
# create_model_version method usage example with argument unpacking
kwargs: CreateModelVersionRequestRequestTypeDef = { # (1)
"modelId": ...,
"modelType": ...,
"trainingDataSource": ...,
"trainingDataSchema": ...,
}
parent.create_model_version(**kwargs)
create_rule#
Creates a rule for use with the specified detector.
Type annotations and code completion for boto3.client("frauddetector").create_rule
method.
boto3 documentation
# create_rule method definition
def create_rule(
self,
*,
ruleId: str,
detectorId: str,
expression: str,
language: LanguageType, # (1)
outcomes: Sequence[str],
description: str = ...,
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateRuleResultTypeDef: # (3)
...
- See LanguageType
- See TagTypeDef
- See CreateRuleResultTypeDef
# create_rule method usage example with argument unpacking
kwargs: CreateRuleRequestRequestTypeDef = { # (1)
"ruleId": ...,
"detectorId": ...,
"expression": ...,
"language": ...,
"outcomes": ...,
}
parent.create_rule(**kwargs)
create_variable#
Creates a variable.
Type annotations and code completion for boto3.client("frauddetector").create_variable
method.
boto3 documentation
# create_variable method definition
def create_variable(
self,
*,
name: str,
dataType: DataTypeType, # (1)
dataSource: DataSourceType, # (2)
defaultValue: str,
description: str = ...,
variableType: str = ...,
tags: Sequence[TagTypeDef] = ..., # (3)
) -> dict[str, Any]:
...
- See DataTypeType
- See DataSourceType
- See TagTypeDef
# create_variable method usage example with argument unpacking
kwargs: CreateVariableRequestRequestTypeDef = { # (1)
"name": ...,
"dataType": ...,
"dataSource": ...,
"defaultValue": ...,
}
parent.create_variable(**kwargs)
delete_batch_import_job#
Deletes the specified batch import job ID record.
Type annotations and code completion for boto3.client("frauddetector").delete_batch_import_job
method.
boto3 documentation
# delete_batch_import_job method definition
def delete_batch_import_job(
self,
*,
jobId: str,
) -> dict[str, Any]:
...
# delete_batch_import_job method usage example with argument unpacking
kwargs: DeleteBatchImportJobRequestRequestTypeDef = { # (1)
"jobId": ...,
}
parent.delete_batch_import_job(**kwargs)
delete_batch_prediction_job#
Deletes a batch prediction job.
Type annotations and code completion for boto3.client("frauddetector").delete_batch_prediction_job
method.
boto3 documentation
# delete_batch_prediction_job method definition
def delete_batch_prediction_job(
self,
*,
jobId: str,
) -> dict[str, Any]:
...
# delete_batch_prediction_job method usage example with argument unpacking
kwargs: DeleteBatchPredictionJobRequestRequestTypeDef = { # (1)
"jobId": ...,
}
parent.delete_batch_prediction_job(**kwargs)
delete_detector#
Deletes the detector.
Type annotations and code completion for boto3.client("frauddetector").delete_detector
method.
boto3 documentation
# delete_detector method definition
def delete_detector(
self,
*,
detectorId: str,
) -> dict[str, Any]:
...
# delete_detector method usage example with argument unpacking
kwargs: DeleteDetectorRequestRequestTypeDef = { # (1)
"detectorId": ...,
}
parent.delete_detector(**kwargs)
delete_detector_version#
Deletes the detector version.
Type annotations and code completion for boto3.client("frauddetector").delete_detector_version
method.
boto3 documentation
# delete_detector_version method definition
def delete_detector_version(
self,
*,
detectorId: str,
detectorVersionId: str,
) -> dict[str, Any]:
...
# delete_detector_version method usage example with argument unpacking
kwargs: DeleteDetectorVersionRequestRequestTypeDef = { # (1)
"detectorId": ...,
"detectorVersionId": ...,
}
parent.delete_detector_version(**kwargs)
delete_entity_type#
Deletes an entity type.
Type annotations and code completion for boto3.client("frauddetector").delete_entity_type
method.
boto3 documentation
# delete_entity_type method definition
def delete_entity_type(
self,
*,
name: str,
) -> dict[str, Any]:
...
# delete_entity_type method usage example with argument unpacking
kwargs: DeleteEntityTypeRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.delete_entity_type(**kwargs)
delete_event#
Deletes the specified event.
Type annotations and code completion for boto3.client("frauddetector").delete_event
method.
boto3 documentation
# delete_event method definition
def delete_event(
self,
*,
eventId: str,
eventTypeName: str,
deleteAuditHistory: bool = ...,
) -> dict[str, Any]:
...
# delete_event method usage example with argument unpacking
kwargs: DeleteEventRequestRequestTypeDef = { # (1)
"eventId": ...,
"eventTypeName": ...,
}
parent.delete_event(**kwargs)
delete_event_type#
Deletes an event type.
Type annotations and code completion for boto3.client("frauddetector").delete_event_type
method.
boto3 documentation
# delete_event_type method definition
def delete_event_type(
self,
*,
name: str,
) -> dict[str, Any]:
...
# delete_event_type method usage example with argument unpacking
kwargs: DeleteEventTypeRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.delete_event_type(**kwargs)
delete_events_by_event_type#
Deletes all events of a particular event type.
Type annotations and code completion for boto3.client("frauddetector").delete_events_by_event_type
method.
boto3 documentation
# delete_events_by_event_type method definition
def delete_events_by_event_type(
self,
*,
eventTypeName: str,
) -> DeleteEventsByEventTypeResultTypeDef: # (1)
...
# delete_events_by_event_type method usage example with argument unpacking
kwargs: DeleteEventsByEventTypeRequestRequestTypeDef = { # (1)
"eventTypeName": ...,
}
parent.delete_events_by_event_type(**kwargs)
delete_external_model#
Removes a SageMaker model from Amazon Fraud Detector.
Type annotations and code completion for boto3.client("frauddetector").delete_external_model
method.
boto3 documentation
# delete_external_model method definition
def delete_external_model(
self,
*,
modelEndpoint: str,
) -> dict[str, Any]:
...
# delete_external_model method usage example with argument unpacking
kwargs: DeleteExternalModelRequestRequestTypeDef = { # (1)
"modelEndpoint": ...,
}
parent.delete_external_model(**kwargs)
delete_label#
Deletes a label.
Type annotations and code completion for boto3.client("frauddetector").delete_label
method.
boto3 documentation
# delete_label method definition
def delete_label(
self,
*,
name: str,
) -> dict[str, Any]:
...
# delete_label method usage example with argument unpacking
kwargs: DeleteLabelRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.delete_label(**kwargs)
delete_list#
Deletes the list, provided it is not used in a rule.
Type annotations and code completion for boto3.client("frauddetector").delete_list
method.
boto3 documentation
# delete_list method definition
def delete_list(
self,
*,
name: str,
) -> dict[str, Any]:
...
# delete_list method usage example with argument unpacking
kwargs: DeleteListRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.delete_list(**kwargs)
delete_model#
Deletes a model.
Type annotations and code completion for boto3.client("frauddetector").delete_model
method.
boto3 documentation
# delete_model method definition
def delete_model(
self,
*,
modelId: str,
modelType: ModelTypeEnumType, # (1)
) -> dict[str, Any]:
...
# delete_model method usage example with argument unpacking
kwargs: DeleteModelRequestRequestTypeDef = { # (1)
"modelId": ...,
"modelType": ...,
}
parent.delete_model(**kwargs)
delete_model_version#
Deletes a model version.
Type annotations and code completion for boto3.client("frauddetector").delete_model_version
method.
boto3 documentation
# delete_model_version method definition
def delete_model_version(
self,
*,
modelId: str,
modelType: ModelTypeEnumType, # (1)
modelVersionNumber: str,
) -> dict[str, Any]:
...
# delete_model_version method usage example with argument unpacking
kwargs: DeleteModelVersionRequestRequestTypeDef = { # (1)
"modelId": ...,
"modelType": ...,
"modelVersionNumber": ...,
}
parent.delete_model_version(**kwargs)
delete_outcome#
Deletes an outcome.
Type annotations and code completion for boto3.client("frauddetector").delete_outcome
method.
boto3 documentation
# delete_outcome method definition
def delete_outcome(
self,
*,
name: str,
) -> dict[str, Any]:
...
# delete_outcome method usage example with argument unpacking
kwargs: DeleteOutcomeRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.delete_outcome(**kwargs)
delete_rule#
Deletes the rule.
Type annotations and code completion for boto3.client("frauddetector").delete_rule
method.
boto3 documentation
# delete_rule method definition
def delete_rule(
self,
*,
rule: RuleTypeDef, # (1)
) -> dict[str, Any]:
...
- See RuleTypeDef
# delete_rule method usage example with argument unpacking
kwargs: DeleteRuleRequestRequestTypeDef = { # (1)
"rule": ...,
}
parent.delete_rule(**kwargs)
delete_variable#
Deletes a variable.
Type annotations and code completion for boto3.client("frauddetector").delete_variable
method.
boto3 documentation
# delete_variable method definition
def delete_variable(
self,
*,
name: str,
) -> dict[str, Any]:
...
# delete_variable method usage example with argument unpacking
kwargs: DeleteVariableRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.delete_variable(**kwargs)
describe_detector#
Gets all versions for a specified detector.
Type annotations and code completion for boto3.client("frauddetector").describe_detector
method.
boto3 documentation
# describe_detector method definition
def describe_detector(
self,
*,
detectorId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> DescribeDetectorResultTypeDef: # (1)
...
# describe_detector method usage example with argument unpacking
kwargs: DescribeDetectorRequestRequestTypeDef = { # (1)
"detectorId": ...,
}
parent.describe_detector(**kwargs)
describe_model_versions#
Gets all of the model versions for the specified model type or for the specified model type and model ID.
Type annotations and code completion for boto3.client("frauddetector").describe_model_versions
method.
boto3 documentation
# describe_model_versions method definition
def describe_model_versions(
self,
*,
modelId: str = ...,
modelVersionNumber: str = ...,
modelType: ModelTypeEnumType = ..., # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> DescribeModelVersionsResultTypeDef: # (2)
...
# describe_model_versions method usage example with argument unpacking
kwargs: DescribeModelVersionsRequestRequestTypeDef = { # (1)
"modelId": ...,
}
parent.describe_model_versions(**kwargs)
get_batch_import_jobs#
Gets all batch import jobs or a specific job of the specified ID.
Type annotations and code completion for boto3.client("frauddetector").get_batch_import_jobs
method.
boto3 documentation
# get_batch_import_jobs method definition
def get_batch_import_jobs(
self,
*,
jobId: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> GetBatchImportJobsResultTypeDef: # (1)
...
# get_batch_import_jobs method usage example with argument unpacking
kwargs: GetBatchImportJobsRequestRequestTypeDef = { # (1)
"jobId": ...,
}
parent.get_batch_import_jobs(**kwargs)
get_batch_prediction_jobs#
Gets all batch prediction jobs or a specific job if you specify a job ID.
Type annotations and code completion for boto3.client("frauddetector").get_batch_prediction_jobs
method.
boto3 documentation
# get_batch_prediction_jobs method definition
def get_batch_prediction_jobs(
self,
*,
jobId: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> GetBatchPredictionJobsResultTypeDef: # (1)
...
# get_batch_prediction_jobs method usage example with argument unpacking
kwargs: GetBatchPredictionJobsRequestRequestTypeDef = { # (1)
"jobId": ...,
}
parent.get_batch_prediction_jobs(**kwargs)
get_delete_events_by_event_type_status#
Retrieves the status of a DeleteEventsByEventType
action.
Type annotations and code completion for boto3.client("frauddetector").get_delete_events_by_event_type_status
method.
boto3 documentation
# get_delete_events_by_event_type_status method definition
def get_delete_events_by_event_type_status(
self,
*,
eventTypeName: str,
) -> GetDeleteEventsByEventTypeStatusResultTypeDef: # (1)
...
# get_delete_events_by_event_type_status method usage example with argument unpacking
kwargs: GetDeleteEventsByEventTypeStatusRequestRequestTypeDef = { # (1)
"eventTypeName": ...,
}
parent.get_delete_events_by_event_type_status(**kwargs)
get_detector_version#
Gets a particular detector version.
Type annotations and code completion for boto3.client("frauddetector").get_detector_version
method.
boto3 documentation
# get_detector_version method definition
def get_detector_version(
self,
*,
detectorId: str,
detectorVersionId: str,
) -> GetDetectorVersionResultTypeDef: # (1)
...
# get_detector_version method usage example with argument unpacking
kwargs: GetDetectorVersionRequestRequestTypeDef = { # (1)
"detectorId": ...,
"detectorVersionId": ...,
}
parent.get_detector_version(**kwargs)
get_detectors#
Gets all detectors or a single detector if a detectorId
is
specified.
Type annotations and code completion for boto3.client("frauddetector").get_detectors
method.
boto3 documentation
# get_detectors method definition
def get_detectors(
self,
*,
detectorId: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> GetDetectorsResultTypeDef: # (1)
...
# get_detectors method usage example with argument unpacking
kwargs: GetDetectorsRequestRequestTypeDef = { # (1)
"detectorId": ...,
}
parent.get_detectors(**kwargs)
get_entity_types#
Gets all entity types or a specific entity type if a name is specified.
Type annotations and code completion for boto3.client("frauddetector").get_entity_types
method.
boto3 documentation
# get_entity_types method definition
def get_entity_types(
self,
*,
name: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> GetEntityTypesResultTypeDef: # (1)
...
# get_entity_types method usage example with argument unpacking
kwargs: GetEntityTypesRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.get_entity_types(**kwargs)
get_event#
Retrieves details of events stored with Amazon Fraud Detector.
Type annotations and code completion for boto3.client("frauddetector").get_event
method.
boto3 documentation
# get_event method definition
def get_event(
self,
*,
eventId: str,
eventTypeName: str,
) -> GetEventResultTypeDef: # (1)
...
# get_event method usage example with argument unpacking
kwargs: GetEventRequestRequestTypeDef = { # (1)
"eventId": ...,
"eventTypeName": ...,
}
parent.get_event(**kwargs)
get_event_prediction#
Evaluates an event against a detector version.
Type annotations and code completion for boto3.client("frauddetector").get_event_prediction
method.
boto3 documentation
# get_event_prediction method definition
def get_event_prediction(
self,
*,
detectorId: str,
eventId: str,
eventTypeName: str,
entities: Sequence[EntityTypeDef], # (1)
eventTimestamp: str,
eventVariables: Mapping[str, str],
detectorVersionId: str = ...,
externalModelEndpointDataBlobs: Mapping[str, ModelEndpointDataBlobTypeDef] = ..., # (2)
) -> GetEventPredictionResultTypeDef: # (3)
...
# get_event_prediction method usage example with argument unpacking
kwargs: GetEventPredictionRequestRequestTypeDef = { # (1)
"detectorId": ...,
"eventId": ...,
"eventTypeName": ...,
"entities": ...,
"eventTimestamp": ...,
"eventVariables": ...,
}
parent.get_event_prediction(**kwargs)
get_event_prediction_metadata#
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.
Type annotations and code completion for boto3.client("frauddetector").get_event_prediction_metadata
method.
boto3 documentation
# get_event_prediction_metadata method definition
def get_event_prediction_metadata(
self,
*,
eventId: str,
eventTypeName: str,
detectorId: str,
detectorVersionId: str,
predictionTimestamp: str,
) -> GetEventPredictionMetadataResultTypeDef: # (1)
...
# get_event_prediction_metadata method usage example with argument unpacking
kwargs: GetEventPredictionMetadataRequestRequestTypeDef = { # (1)
"eventId": ...,
"eventTypeName": ...,
"detectorId": ...,
"detectorVersionId": ...,
"predictionTimestamp": ...,
}
parent.get_event_prediction_metadata(**kwargs)
get_event_types#
Gets all event types or a specific event type if name is provided.
Type annotations and code completion for boto3.client("frauddetector").get_event_types
method.
boto3 documentation
# get_event_types method definition
def get_event_types(
self,
*,
name: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> GetEventTypesResultTypeDef: # (1)
...
# get_event_types method usage example with argument unpacking
kwargs: GetEventTypesRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.get_event_types(**kwargs)
get_external_models#
Gets the details for one or more Amazon SageMaker models that have been imported into the service.
Type annotations and code completion for boto3.client("frauddetector").get_external_models
method.
boto3 documentation
# get_external_models method definition
def get_external_models(
self,
*,
modelEndpoint: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> GetExternalModelsResultTypeDef: # (1)
...
# get_external_models method usage example with argument unpacking
kwargs: GetExternalModelsRequestRequestTypeDef = { # (1)
"modelEndpoint": ...,
}
parent.get_external_models(**kwargs)
get_kms_encryption_key#
Gets the encryption key if a KMS key has been specified to be used to encrypt content in Amazon Fraud Detector.
Type annotations and code completion for boto3.client("frauddetector").get_kms_encryption_key
method.
boto3 documentation
# get_kms_encryption_key method definition
def get_kms_encryption_key(
self,
) -> GetKMSEncryptionKeyResultTypeDef: # (1)
...
get_labels#
Gets all labels or a specific label if name is provided.
Type annotations and code completion for boto3.client("frauddetector").get_labels
method.
boto3 documentation
# get_labels method definition
def get_labels(
self,
*,
name: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> GetLabelsResultTypeDef: # (1)
...
# get_labels method usage example with argument unpacking
kwargs: GetLabelsRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.get_labels(**kwargs)
get_list_elements#
Gets all the elements in the specified list.
Type annotations and code completion for boto3.client("frauddetector").get_list_elements
method.
boto3 documentation
# get_list_elements method definition
def get_list_elements(
self,
*,
name: str,
nextToken: str = ...,
maxResults: int = ...,
) -> GetListElementsResultTypeDef: # (1)
...
# get_list_elements method usage example with argument unpacking
kwargs: GetListElementsRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.get_list_elements(**kwargs)
get_lists_metadata#
Gets the metadata of either all the lists under the account or the specified list.
Type annotations and code completion for boto3.client("frauddetector").get_lists_metadata
method.
boto3 documentation
# get_lists_metadata method definition
def get_lists_metadata(
self,
*,
name: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> GetListsMetadataResultTypeDef: # (1)
...
# get_lists_metadata method usage example with argument unpacking
kwargs: GetListsMetadataRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.get_lists_metadata(**kwargs)
get_model_version#
Gets the details of the specified model version.
Type annotations and code completion for boto3.client("frauddetector").get_model_version
method.
boto3 documentation
# get_model_version method definition
def get_model_version(
self,
*,
modelId: str,
modelType: ModelTypeEnumType, # (1)
modelVersionNumber: str,
) -> GetModelVersionResultTypeDef: # (2)
...
# get_model_version method usage example with argument unpacking
kwargs: GetModelVersionRequestRequestTypeDef = { # (1)
"modelId": ...,
"modelType": ...,
"modelVersionNumber": ...,
}
parent.get_model_version(**kwargs)
get_models#
Gets one or more models.
Type annotations and code completion for boto3.client("frauddetector").get_models
method.
boto3 documentation
# get_models method definition
def get_models(
self,
*,
modelId: str = ...,
modelType: ModelTypeEnumType = ..., # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> GetModelsResultTypeDef: # (2)
...
# get_models method usage example with argument unpacking
kwargs: GetModelsRequestRequestTypeDef = { # (1)
"modelId": ...,
}
parent.get_models(**kwargs)
get_outcomes#
Gets one or more outcomes.
Type annotations and code completion for boto3.client("frauddetector").get_outcomes
method.
boto3 documentation
# get_outcomes method definition
def get_outcomes(
self,
*,
name: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> GetOutcomesResultTypeDef: # (1)
...
# get_outcomes method usage example with argument unpacking
kwargs: GetOutcomesRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.get_outcomes(**kwargs)
get_rules#
Get all rules for a detector (paginated) if ruleId
and
ruleVersion
are not specified.
Type annotations and code completion for boto3.client("frauddetector").get_rules
method.
boto3 documentation
# get_rules method definition
def get_rules(
self,
*,
detectorId: str,
ruleId: str = ...,
ruleVersion: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> GetRulesResultTypeDef: # (1)
...
# get_rules method usage example with argument unpacking
kwargs: GetRulesRequestRequestTypeDef = { # (1)
"detectorId": ...,
}
parent.get_rules(**kwargs)
get_variables#
Gets all of the variables or the specific variable.
Type annotations and code completion for boto3.client("frauddetector").get_variables
method.
boto3 documentation
# get_variables method definition
def get_variables(
self,
*,
name: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> GetVariablesResultTypeDef: # (1)
...
# get_variables method usage example with argument unpacking
kwargs: GetVariablesRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.get_variables(**kwargs)
list_event_predictions#
Gets a list of past predictions.
Type annotations and code completion for boto3.client("frauddetector").list_event_predictions
method.
boto3 documentation
# list_event_predictions method definition
def list_event_predictions(
self,
*,
eventId: FilterConditionTypeDef = ..., # (1)
eventType: FilterConditionTypeDef = ..., # (1)
detectorId: FilterConditionTypeDef = ..., # (1)
detectorVersionId: FilterConditionTypeDef = ..., # (1)
predictionTimeRange: PredictionTimeRangeTypeDef = ..., # (5)
nextToken: str = ...,
maxResults: int = ...,
) -> ListEventPredictionsResultTypeDef: # (6)
...
- See FilterConditionTypeDef
- See FilterConditionTypeDef
- See FilterConditionTypeDef
- See FilterConditionTypeDef
- See PredictionTimeRangeTypeDef
- See ListEventPredictionsResultTypeDef
# list_event_predictions method usage example with argument unpacking
kwargs: ListEventPredictionsRequestRequestTypeDef = { # (1)
"eventId": ...,
}
parent.list_event_predictions(**kwargs)
list_tags_for_resource#
Lists all tags associated with the resource.
Type annotations and code completion for boto3.client("frauddetector").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
resourceARN: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListTagsForResourceResultTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)
put_detector#
Creates or updates a detector.
Type annotations and code completion for boto3.client("frauddetector").put_detector
method.
boto3 documentation
# put_detector method definition
def put_detector(
self,
*,
detectorId: str,
eventTypeName: str,
description: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> dict[str, Any]:
...
- See TagTypeDef
# put_detector method usage example with argument unpacking
kwargs: PutDetectorRequestRequestTypeDef = { # (1)
"detectorId": ...,
"eventTypeName": ...,
}
parent.put_detector(**kwargs)
put_entity_type#
Creates or updates an entity type.
Type annotations and code completion for boto3.client("frauddetector").put_entity_type
method.
boto3 documentation
# put_entity_type method definition
def put_entity_type(
self,
*,
name: str,
description: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> dict[str, Any]:
...
- See TagTypeDef
# put_entity_type method usage example with argument unpacking
kwargs: PutEntityTypeRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.put_entity_type(**kwargs)
put_event_type#
Creates or updates an event type.
Type annotations and code completion for boto3.client("frauddetector").put_event_type
method.
boto3 documentation
# put_event_type method definition
def put_event_type(
self,
*,
name: str,
eventVariables: Sequence[str],
entityTypes: Sequence[str],
description: str = ...,
labels: Sequence[str] = ...,
eventIngestion: EventIngestionType = ..., # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
eventOrchestration: EventOrchestrationTypeDef = ..., # (3)
) -> dict[str, Any]:
...
- See EventIngestionType
- See TagTypeDef
- See EventOrchestrationTypeDef
# put_event_type method usage example with argument unpacking
kwargs: PutEventTypeRequestRequestTypeDef = { # (1)
"name": ...,
"eventVariables": ...,
"entityTypes": ...,
}
parent.put_event_type(**kwargs)
put_external_model#
Creates or updates an Amazon SageMaker model endpoint.
Type annotations and code completion for boto3.client("frauddetector").put_external_model
method.
boto3 documentation
# put_external_model method definition
def put_external_model(
self,
*,
modelEndpoint: str,
modelSource: ModelSourceType, # (1)
invokeModelEndpointRoleArn: str,
inputConfiguration: ModelInputConfigurationTypeDef, # (2)
outputConfiguration: ModelOutputConfigurationTypeDef, # (3)
modelEndpointStatus: ModelEndpointStatusType, # (4)
tags: Sequence[TagTypeDef] = ..., # (5)
) -> dict[str, Any]:
...
- See ModelSourceType
- See ModelInputConfigurationTypeDef
- See ModelOutputConfigurationTypeDef
- See ModelEndpointStatusType
- See TagTypeDef
# put_external_model method usage example with argument unpacking
kwargs: PutExternalModelRequestRequestTypeDef = { # (1)
"modelEndpoint": ...,
"modelSource": ...,
"invokeModelEndpointRoleArn": ...,
"inputConfiguration": ...,
"outputConfiguration": ...,
"modelEndpointStatus": ...,
}
parent.put_external_model(**kwargs)
put_kms_encryption_key#
Specifies the KMS key to be used to encrypt content in Amazon Fraud Detector.
Type annotations and code completion for boto3.client("frauddetector").put_kms_encryption_key
method.
boto3 documentation
# put_kms_encryption_key method definition
def put_kms_encryption_key(
self,
*,
kmsEncryptionKeyArn: str,
) -> dict[str, Any]:
...
# put_kms_encryption_key method usage example with argument unpacking
kwargs: PutKMSEncryptionKeyRequestRequestTypeDef = { # (1)
"kmsEncryptionKeyArn": ...,
}
parent.put_kms_encryption_key(**kwargs)
put_label#
Creates or updates label.
Type annotations and code completion for boto3.client("frauddetector").put_label
method.
boto3 documentation
# put_label method definition
def put_label(
self,
*,
name: str,
description: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> dict[str, Any]:
...
- See TagTypeDef
# put_label method usage example with argument unpacking
kwargs: PutLabelRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.put_label(**kwargs)
put_outcome#
Creates or updates an outcome.
Type annotations and code completion for boto3.client("frauddetector").put_outcome
method.
boto3 documentation
# put_outcome method definition
def put_outcome(
self,
*,
name: str,
description: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> dict[str, Any]:
...
- See TagTypeDef
# put_outcome method usage example with argument unpacking
kwargs: PutOutcomeRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.put_outcome(**kwargs)
send_event#
Stores events in Amazon Fraud Detector without generating fraud predictions for those events.
Type annotations and code completion for boto3.client("frauddetector").send_event
method.
boto3 documentation
# send_event method definition
def send_event(
self,
*,
eventId: str,
eventTypeName: str,
eventTimestamp: str,
eventVariables: Mapping[str, str],
entities: Sequence[EntityTypeDef], # (1)
assignedLabel: str = ...,
labelTimestamp: str = ...,
) -> dict[str, Any]:
...
- See EntityTypeDef
# send_event method usage example with argument unpacking
kwargs: SendEventRequestRequestTypeDef = { # (1)
"eventId": ...,
"eventTypeName": ...,
"eventTimestamp": ...,
"eventVariables": ...,
"entities": ...,
}
parent.send_event(**kwargs)
tag_resource#
Assigns tags to a resource.
Type annotations and code completion for boto3.client("frauddetector").tag_resource
method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
resourceARN: str,
tags: Sequence[TagTypeDef], # (1)
) -> dict[str, Any]:
...
- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceARN": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Removes tags from a resource.
Type annotations and code completion for boto3.client("frauddetector").untag_resource
method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
resourceARN: str,
tagKeys: Sequence[str],
) -> dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceARN": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_detector_version#
Updates a detector version.
Type annotations and code completion for boto3.client("frauddetector").update_detector_version
method.
boto3 documentation
# update_detector_version method definition
def update_detector_version(
self,
*,
detectorId: str,
detectorVersionId: str,
externalModelEndpoints: Sequence[str],
rules: Sequence[RuleTypeDef], # (1)
description: str = ...,
modelVersions: Sequence[ModelVersionTypeDef] = ..., # (2)
ruleExecutionMode: RuleExecutionModeType = ..., # (3)
) -> dict[str, Any]:
...
- See RuleTypeDef
- See ModelVersionTypeDef
- See RuleExecutionModeType
# update_detector_version method usage example with argument unpacking
kwargs: UpdateDetectorVersionRequestRequestTypeDef = { # (1)
"detectorId": ...,
"detectorVersionId": ...,
"externalModelEndpoints": ...,
"rules": ...,
}
parent.update_detector_version(**kwargs)
update_detector_version_metadata#
Updates the detector version's description.
Type annotations and code completion for boto3.client("frauddetector").update_detector_version_metadata
method.
boto3 documentation
# update_detector_version_metadata method definition
def update_detector_version_metadata(
self,
*,
detectorId: str,
detectorVersionId: str,
description: str,
) -> dict[str, Any]:
...
# update_detector_version_metadata method usage example with argument unpacking
kwargs: UpdateDetectorVersionMetadataRequestRequestTypeDef = { # (1)
"detectorId": ...,
"detectorVersionId": ...,
"description": ...,
}
parent.update_detector_version_metadata(**kwargs)
update_detector_version_status#
Updates the detector version's status.
Type annotations and code completion for boto3.client("frauddetector").update_detector_version_status
method.
boto3 documentation
# update_detector_version_status method definition
def update_detector_version_status(
self,
*,
detectorId: str,
detectorVersionId: str,
status: DetectorVersionStatusType, # (1)
) -> dict[str, Any]:
...
# update_detector_version_status method usage example with argument unpacking
kwargs: UpdateDetectorVersionStatusRequestRequestTypeDef = { # (1)
"detectorId": ...,
"detectorVersionId": ...,
"status": ...,
}
parent.update_detector_version_status(**kwargs)
update_event_label#
Updates the specified event with a new label.
Type annotations and code completion for boto3.client("frauddetector").update_event_label
method.
boto3 documentation
# update_event_label method definition
def update_event_label(
self,
*,
eventId: str,
eventTypeName: str,
assignedLabel: str,
labelTimestamp: str,
) -> dict[str, Any]:
...
# update_event_label method usage example with argument unpacking
kwargs: UpdateEventLabelRequestRequestTypeDef = { # (1)
"eventId": ...,
"eventTypeName": ...,
"assignedLabel": ...,
"labelTimestamp": ...,
}
parent.update_event_label(**kwargs)
update_list#
Updates a list.
Type annotations and code completion for boto3.client("frauddetector").update_list
method.
boto3 documentation
# update_list method definition
def update_list(
self,
*,
name: str,
elements: Sequence[str] = ...,
description: str = ...,
updateMode: ListUpdateModeType = ..., # (1)
variableType: str = ...,
) -> dict[str, Any]:
...
# update_list method usage example with argument unpacking
kwargs: UpdateListRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.update_list(**kwargs)
update_model#
Updates model description.
Type annotations and code completion for boto3.client("frauddetector").update_model
method.
boto3 documentation
# update_model method definition
def update_model(
self,
*,
modelId: str,
modelType: ModelTypeEnumType, # (1)
description: str = ...,
) -> dict[str, Any]:
...
# update_model method usage example with argument unpacking
kwargs: UpdateModelRequestRequestTypeDef = { # (1)
"modelId": ...,
"modelType": ...,
}
parent.update_model(**kwargs)
update_model_version#
Updates a model version.
Type annotations and code completion for boto3.client("frauddetector").update_model_version
method.
boto3 documentation
# update_model_version method definition
def update_model_version(
self,
*,
modelId: str,
modelType: ModelTypeEnumType, # (1)
majorVersionNumber: str,
externalEventsDetail: ExternalEventsDetailTypeDef = ..., # (2)
ingestedEventsDetail: IngestedEventsDetailTypeDef = ..., # (3)
tags: Sequence[TagTypeDef] = ..., # (4)
) -> UpdateModelVersionResultTypeDef: # (5)
...
- See ModelTypeEnumType
- See ExternalEventsDetailTypeDef
- See IngestedEventsDetailTypeDef
- See TagTypeDef
- See UpdateModelVersionResultTypeDef
# update_model_version method usage example with argument unpacking
kwargs: UpdateModelVersionRequestRequestTypeDef = { # (1)
"modelId": ...,
"modelType": ...,
"majorVersionNumber": ...,
}
parent.update_model_version(**kwargs)
update_model_version_status#
Updates the status of a model version.
Type annotations and code completion for boto3.client("frauddetector").update_model_version_status
method.
boto3 documentation
# update_model_version_status method definition
def update_model_version_status(
self,
*,
modelId: str,
modelType: ModelTypeEnumType, # (1)
modelVersionNumber: str,
status: ModelVersionStatusType, # (2)
) -> dict[str, Any]:
...
# update_model_version_status method usage example with argument unpacking
kwargs: UpdateModelVersionStatusRequestRequestTypeDef = { # (1)
"modelId": ...,
"modelType": ...,
"modelVersionNumber": ...,
"status": ...,
}
parent.update_model_version_status(**kwargs)
update_rule_metadata#
Updates a rule's metadata.
Type annotations and code completion for boto3.client("frauddetector").update_rule_metadata
method.
boto3 documentation
# update_rule_metadata method definition
def update_rule_metadata(
self,
*,
rule: RuleTypeDef, # (1)
description: str,
) -> dict[str, Any]:
...
- See RuleTypeDef
# update_rule_metadata method usage example with argument unpacking
kwargs: UpdateRuleMetadataRequestRequestTypeDef = { # (1)
"rule": ...,
"description": ...,
}
parent.update_rule_metadata(**kwargs)
update_rule_version#
Updates a rule version resulting in a new rule version.
Type annotations and code completion for boto3.client("frauddetector").update_rule_version
method.
boto3 documentation
# update_rule_version method definition
def update_rule_version(
self,
*,
rule: RuleTypeDef, # (1)
expression: str,
language: LanguageType, # (2)
outcomes: Sequence[str],
description: str = ...,
tags: Sequence[TagTypeDef] = ..., # (3)
) -> UpdateRuleVersionResultTypeDef: # (4)
...
- See RuleTypeDef
- See LanguageType
- See TagTypeDef
- See UpdateRuleVersionResultTypeDef
# update_rule_version method usage example with argument unpacking
kwargs: UpdateRuleVersionRequestRequestTypeDef = { # (1)
"rule": ...,
"expression": ...,
"language": ...,
"outcomes": ...,
}
parent.update_rule_version(**kwargs)
update_variable#
Updates a variable.
Type annotations and code completion for boto3.client("frauddetector").update_variable
method.
boto3 documentation
# update_variable method definition
def update_variable(
self,
*,
name: str,
defaultValue: str = ...,
description: str = ...,
variableType: str = ...,
) -> dict[str, Any]:
...
# update_variable method usage example with argument unpacking
kwargs: UpdateVariableRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.update_variable(**kwargs)