FraudDetectorClient#
Index > FraudDetector > FraudDetectorClient
Auto-generated documentation for FraudDetector type annotations stubs module mypy-boto3-frauddetector.
FraudDetectorClient#
Type annotations and code completion for boto3.client("frauddetector")
.
boto3 documentation
# FraudDetectorClient usage example
from boto3.session import Session
from mypy_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 mypy_boto3_frauddetector.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
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)
can_paginate#
Check if an operation can be paginated.
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:
...
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)
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("frauddetector").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
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)