Skip to content

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

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.

Usage example
client = boto3.client("frauddetector")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.ResourceNotFoundException,
    client.ResourceUnavailableException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)
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

Method definition
def batch_create_variable(
    self,
    *,
    variableEntries: Sequence[VariableEntryTypeDef],  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> BatchCreateVariableResultTypeDef:  # (3)
    ...
  1. See VariableEntryTypeDef
  2. See TagTypeDef
  3. See BatchCreateVariableResultTypeDef
Usage example with kwargs
kwargs: BatchCreateVariableRequestRequestTypeDef = {  # (1)
    "variableEntries": ...,
}

parent.batch_create_variable(**kwargs)
  1. See BatchCreateVariableRequestRequestTypeDef

batch_get_variable

Gets a batch of variables.

Type annotations and code completion for boto3.client("frauddetector").batch_get_variable method. boto3 documentation

Method definition
def batch_get_variable(
    self,
    *,
    names: Sequence[str],
) -> BatchGetVariableResultTypeDef:  # (1)
    ...
  1. See BatchGetVariableResultTypeDef
Usage example with kwargs
kwargs: BatchGetVariableRequestRequestTypeDef = {  # (1)
    "names": ...,
}

parent.batch_get_variable(**kwargs)
  1. See BatchGetVariableRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("frauddetector").can_paginate method. boto3 documentation

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

Method definition
def cancel_batch_import_job(
    self,
    *,
    jobId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: CancelBatchImportJobRequestRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.cancel_batch_import_job(**kwargs)
  1. See CancelBatchImportJobRequestRequestTypeDef

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

Method definition
def cancel_batch_prediction_job(
    self,
    *,
    jobId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: CancelBatchPredictionJobRequestRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.cancel_batch_prediction_job(**kwargs)
  1. See CancelBatchPredictionJobRequestRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("frauddetector").close method. boto3 documentation

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

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]:
    ...
  1. See TagTypeDef
Usage example with kwargs
kwargs: CreateBatchImportJobRequestRequestTypeDef = {  # (1)
    "jobId": ...,
    "inputPath": ...,
    "outputPath": ...,
    "eventTypeName": ...,
    "iamRoleArn": ...,
}

parent.create_batch_import_job(**kwargs)
  1. See CreateBatchImportJobRequestRequestTypeDef

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

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]:
    ...
  1. See TagTypeDef
Usage example with kwargs
kwargs: CreateBatchPredictionJobRequestRequestTypeDef = {  # (1)
    "jobId": ...,
    "inputPath": ...,
    "outputPath": ...,
    "eventTypeName": ...,
    "detectorName": ...,
    "iamRoleArn": ...,
}

parent.create_batch_prediction_job(**kwargs)
  1. See CreateBatchPredictionJobRequestRequestTypeDef

create_detector_version

Creates a detector version.

Type annotations and code completion for boto3.client("frauddetector").create_detector_version method. boto3 documentation

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)
    ...
  1. See RuleTypeDef
  2. See ModelVersionTypeDef
  3. See RuleExecutionModeType
  4. See TagTypeDef
  5. See CreateDetectorVersionResultTypeDef
Usage example with kwargs
kwargs: CreateDetectorVersionRequestRequestTypeDef = {  # (1)
    "detectorId": ...,
    "rules": ...,
}

parent.create_detector_version(**kwargs)
  1. See CreateDetectorVersionRequestRequestTypeDef

create_model

Creates a model using the specified model type.

Type annotations and code completion for boto3.client("frauddetector").create_model method. boto3 documentation

Method definition
def create_model(
    self,
    *,
    modelId: str,
    modelType: ModelTypeEnumType,  # (1)
    eventTypeName: str,
    description: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> Dict[str, Any]:
    ...
  1. See ModelTypeEnumType
  2. See TagTypeDef
Usage example with kwargs
kwargs: CreateModelRequestRequestTypeDef = {  # (1)
    "modelId": ...,
    "modelType": ...,
    "eventTypeName": ...,
}

parent.create_model(**kwargs)
  1. See CreateModelRequestRequestTypeDef

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

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)
    ...
  1. See ModelTypeEnumType
  2. See TrainingDataSourceEnumType
  3. See TrainingDataSchemaTypeDef
  4. See ExternalEventsDetailTypeDef
  5. See IngestedEventsDetailTypeDef
  6. See TagTypeDef
  7. See CreateModelVersionResultTypeDef
Usage example with kwargs
kwargs: CreateModelVersionRequestRequestTypeDef = {  # (1)
    "modelId": ...,
    "modelType": ...,
    "trainingDataSource": ...,
    "trainingDataSchema": ...,
}

parent.create_model_version(**kwargs)
  1. See CreateModelVersionRequestRequestTypeDef

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

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)
    ...
  1. See LanguageType
  2. See TagTypeDef
  3. See CreateRuleResultTypeDef
Usage example with kwargs
kwargs: CreateRuleRequestRequestTypeDef = {  # (1)
    "ruleId": ...,
    "detectorId": ...,
    "expression": ...,
    "language": ...,
    "outcomes": ...,
}

parent.create_rule(**kwargs)
  1. See CreateRuleRequestRequestTypeDef

create_variable

Creates a variable.

Type annotations and code completion for boto3.client("frauddetector").create_variable method. boto3 documentation

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]:
    ...
  1. See DataTypeType
  2. See DataSourceType
  3. See TagTypeDef
Usage example with kwargs
kwargs: CreateVariableRequestRequestTypeDef = {  # (1)
    "name": ...,
    "dataType": ...,
    "dataSource": ...,
    "defaultValue": ...,
}

parent.create_variable(**kwargs)
  1. See CreateVariableRequestRequestTypeDef

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

Method definition
def delete_batch_import_job(
    self,
    *,
    jobId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteBatchImportJobRequestRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.delete_batch_import_job(**kwargs)
  1. See DeleteBatchImportJobRequestRequestTypeDef

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

Method definition
def delete_batch_prediction_job(
    self,
    *,
    jobId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteBatchPredictionJobRequestRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.delete_batch_prediction_job(**kwargs)
  1. See DeleteBatchPredictionJobRequestRequestTypeDef

delete_detector

Deletes the detector.

Type annotations and code completion for boto3.client("frauddetector").delete_detector method. boto3 documentation

Method definition
def delete_detector(
    self,
    *,
    detectorId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteDetectorRequestRequestTypeDef = {  # (1)
    "detectorId": ...,
}

parent.delete_detector(**kwargs)
  1. See DeleteDetectorRequestRequestTypeDef

delete_detector_version

Deletes the detector version.

Type annotations and code completion for boto3.client("frauddetector").delete_detector_version method. boto3 documentation

Method definition
def delete_detector_version(
    self,
    *,
    detectorId: str,
    detectorVersionId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteDetectorVersionRequestRequestTypeDef = {  # (1)
    "detectorId": ...,
    "detectorVersionId": ...,
}

parent.delete_detector_version(**kwargs)
  1. See DeleteDetectorVersionRequestRequestTypeDef

delete_entity_type

Deletes an entity type.

Type annotations and code completion for boto3.client("frauddetector").delete_entity_type method. boto3 documentation

Method definition
def delete_entity_type(
    self,
    *,
    name: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteEntityTypeRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_entity_type(**kwargs)
  1. See DeleteEntityTypeRequestRequestTypeDef

delete_event

Deletes the specified event.

Type annotations and code completion for boto3.client("frauddetector").delete_event method. boto3 documentation

Method definition
def delete_event(
    self,
    *,
    eventId: str,
    eventTypeName: str,
    deleteAuditHistory: bool = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteEventRequestRequestTypeDef = {  # (1)
    "eventId": ...,
    "eventTypeName": ...,
}

parent.delete_event(**kwargs)
  1. See DeleteEventRequestRequestTypeDef

delete_event_type

Deletes an event type.

Type annotations and code completion for boto3.client("frauddetector").delete_event_type method. boto3 documentation

Method definition
def delete_event_type(
    self,
    *,
    name: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteEventTypeRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_event_type(**kwargs)
  1. See DeleteEventTypeRequestRequestTypeDef

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

Method definition
def delete_events_by_event_type(
    self,
    *,
    eventTypeName: str,
) -> DeleteEventsByEventTypeResultTypeDef:  # (1)
    ...
  1. See DeleteEventsByEventTypeResultTypeDef
Usage example with kwargs
kwargs: DeleteEventsByEventTypeRequestRequestTypeDef = {  # (1)
    "eventTypeName": ...,
}

parent.delete_events_by_event_type(**kwargs)
  1. See DeleteEventsByEventTypeRequestRequestTypeDef

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

Method definition
def delete_external_model(
    self,
    *,
    modelEndpoint: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteExternalModelRequestRequestTypeDef = {  # (1)
    "modelEndpoint": ...,
}

parent.delete_external_model(**kwargs)
  1. See DeleteExternalModelRequestRequestTypeDef

delete_label

Deletes a label.

Type annotations and code completion for boto3.client("frauddetector").delete_label method. boto3 documentation

Method definition
def delete_label(
    self,
    *,
    name: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteLabelRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_label(**kwargs)
  1. See DeleteLabelRequestRequestTypeDef

delete_model

Deletes a model.

Type annotations and code completion for boto3.client("frauddetector").delete_model method. boto3 documentation

Method definition
def delete_model(
    self,
    *,
    modelId: str,
    modelType: ModelTypeEnumType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See ModelTypeEnumType
Usage example with kwargs
kwargs: DeleteModelRequestRequestTypeDef = {  # (1)
    "modelId": ...,
    "modelType": ...,
}

parent.delete_model(**kwargs)
  1. See DeleteModelRequestRequestTypeDef

delete_model_version

Deletes a model version.

Type annotations and code completion for boto3.client("frauddetector").delete_model_version method. boto3 documentation

Method definition
def delete_model_version(
    self,
    *,
    modelId: str,
    modelType: ModelTypeEnumType,  # (1)
    modelVersionNumber: str,
) -> Dict[str, Any]:
    ...
  1. See ModelTypeEnumType
Usage example with kwargs
kwargs: DeleteModelVersionRequestRequestTypeDef = {  # (1)
    "modelId": ...,
    "modelType": ...,
    "modelVersionNumber": ...,
}

parent.delete_model_version(**kwargs)
  1. See DeleteModelVersionRequestRequestTypeDef

delete_outcome

Deletes an outcome.

Type annotations and code completion for boto3.client("frauddetector").delete_outcome method. boto3 documentation

Method definition
def delete_outcome(
    self,
    *,
    name: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteOutcomeRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_outcome(**kwargs)
  1. See DeleteOutcomeRequestRequestTypeDef

delete_rule

Deletes the rule.

Type annotations and code completion for boto3.client("frauddetector").delete_rule method. boto3 documentation

Method definition
def delete_rule(
    self,
    *,
    rule: RuleTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See RuleTypeDef
Usage example with kwargs
kwargs: DeleteRuleRequestRequestTypeDef = {  # (1)
    "rule": ...,
}

parent.delete_rule(**kwargs)
  1. See DeleteRuleRequestRequestTypeDef

delete_variable

Deletes a variable.

Type annotations and code completion for boto3.client("frauddetector").delete_variable method. boto3 documentation

Method definition
def delete_variable(
    self,
    *,
    name: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteVariableRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_variable(**kwargs)
  1. See DeleteVariableRequestRequestTypeDef

describe_detector

Gets all versions for a specified detector.

Type annotations and code completion for boto3.client("frauddetector").describe_detector method. boto3 documentation

Method definition
def describe_detector(
    self,
    *,
    detectorId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> DescribeDetectorResultTypeDef:  # (1)
    ...
  1. See DescribeDetectorResultTypeDef
Usage example with kwargs
kwargs: DescribeDetectorRequestRequestTypeDef = {  # (1)
    "detectorId": ...,
}

parent.describe_detector(**kwargs)
  1. See DescribeDetectorRequestRequestTypeDef

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

Method definition
def describe_model_versions(
    self,
    *,
    modelId: str = ...,
    modelVersionNumber: str = ...,
    modelType: ModelTypeEnumType = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> DescribeModelVersionsResultTypeDef:  # (2)
    ...
  1. See ModelTypeEnumType
  2. See DescribeModelVersionsResultTypeDef
Usage example with kwargs
kwargs: DescribeModelVersionsRequestRequestTypeDef = {  # (1)
    "modelId": ...,
}

parent.describe_model_versions(**kwargs)
  1. See DescribeModelVersionsRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("frauddetector").generate_presigned_url method. boto3 documentation

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

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

Method definition
def get_batch_import_jobs(
    self,
    *,
    jobId: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> GetBatchImportJobsResultTypeDef:  # (1)
    ...
  1. See GetBatchImportJobsResultTypeDef
Usage example with kwargs
kwargs: GetBatchImportJobsRequestRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.get_batch_import_jobs(**kwargs)
  1. See GetBatchImportJobsRequestRequestTypeDef

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

Method definition
def get_batch_prediction_jobs(
    self,
    *,
    jobId: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> GetBatchPredictionJobsResultTypeDef:  # (1)
    ...
  1. See GetBatchPredictionJobsResultTypeDef
Usage example with kwargs
kwargs: GetBatchPredictionJobsRequestRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.get_batch_prediction_jobs(**kwargs)
  1. See GetBatchPredictionJobsRequestRequestTypeDef

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

Method definition
def get_delete_events_by_event_type_status(
    self,
    *,
    eventTypeName: str,
) -> GetDeleteEventsByEventTypeStatusResultTypeDef:  # (1)
    ...
  1. See GetDeleteEventsByEventTypeStatusResultTypeDef
Usage example with kwargs
kwargs: GetDeleteEventsByEventTypeStatusRequestRequestTypeDef = {  # (1)
    "eventTypeName": ...,
}

parent.get_delete_events_by_event_type_status(**kwargs)
  1. See GetDeleteEventsByEventTypeStatusRequestRequestTypeDef

get_detector_version

Gets a particular detector version.

Type annotations and code completion for boto3.client("frauddetector").get_detector_version method. boto3 documentation

Method definition
def get_detector_version(
    self,
    *,
    detectorId: str,
    detectorVersionId: str,
) -> GetDetectorVersionResultTypeDef:  # (1)
    ...
  1. See GetDetectorVersionResultTypeDef
Usage example with kwargs
kwargs: GetDetectorVersionRequestRequestTypeDef = {  # (1)
    "detectorId": ...,
    "detectorVersionId": ...,
}

parent.get_detector_version(**kwargs)
  1. See GetDetectorVersionRequestRequestTypeDef

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

Method definition
def get_detectors(
    self,
    *,
    detectorId: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetDetectorsResultTypeDef:  # (1)
    ...
  1. See GetDetectorsResultTypeDef
Usage example with kwargs
kwargs: GetDetectorsRequestRequestTypeDef = {  # (1)
    "detectorId": ...,
}

parent.get_detectors(**kwargs)
  1. See GetDetectorsRequestRequestTypeDef

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

Method definition
def get_entity_types(
    self,
    *,
    name: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetEntityTypesResultTypeDef:  # (1)
    ...
  1. See GetEntityTypesResultTypeDef
Usage example with kwargs
kwargs: GetEntityTypesRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_entity_types(**kwargs)
  1. See GetEntityTypesRequestRequestTypeDef

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

Method definition
def get_event(
    self,
    *,
    eventId: str,
    eventTypeName: str,
) -> GetEventResultTypeDef:  # (1)
    ...
  1. See GetEventResultTypeDef
Usage example with kwargs
kwargs: GetEventRequestRequestTypeDef = {  # (1)
    "eventId": ...,
    "eventTypeName": ...,
}

parent.get_event(**kwargs)
  1. See GetEventRequestRequestTypeDef

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

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)
    ...
  1. See EntityTypeDef
  2. See ModelEndpointDataBlobTypeDef
  3. See GetEventPredictionResultTypeDef
Usage example with kwargs
kwargs: GetEventPredictionRequestRequestTypeDef = {  # (1)
    "detectorId": ...,
    "eventId": ...,
    "eventTypeName": ...,
    "entities": ...,
    "eventTimestamp": ...,
    "eventVariables": ...,
}

parent.get_event_prediction(**kwargs)
  1. See GetEventPredictionRequestRequestTypeDef

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

Method definition
def get_event_prediction_metadata(
    self,
    *,
    eventId: str,
    eventTypeName: str,
    detectorId: str,
    detectorVersionId: str,
    predictionTimestamp: str,
) -> GetEventPredictionMetadataResultTypeDef:  # (1)
    ...
  1. See GetEventPredictionMetadataResultTypeDef
Usage example with kwargs
kwargs: GetEventPredictionMetadataRequestRequestTypeDef = {  # (1)
    "eventId": ...,
    "eventTypeName": ...,
    "detectorId": ...,
    "detectorVersionId": ...,
    "predictionTimestamp": ...,
}

parent.get_event_prediction_metadata(**kwargs)
  1. See GetEventPredictionMetadataRequestRequestTypeDef

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

Method definition
def get_event_types(
    self,
    *,
    name: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetEventTypesResultTypeDef:  # (1)
    ...
  1. See GetEventTypesResultTypeDef
Usage example with kwargs
kwargs: GetEventTypesRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_event_types(**kwargs)
  1. See GetEventTypesRequestRequestTypeDef

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

Method definition
def get_external_models(
    self,
    *,
    modelEndpoint: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetExternalModelsResultTypeDef:  # (1)
    ...
  1. See GetExternalModelsResultTypeDef
Usage example with kwargs
kwargs: GetExternalModelsRequestRequestTypeDef = {  # (1)
    "modelEndpoint": ...,
}

parent.get_external_models(**kwargs)
  1. See GetExternalModelsRequestRequestTypeDef

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

Method definition
def get_kms_encryption_key(
    self,
) -> GetKMSEncryptionKeyResultTypeDef:  # (1)
    ...
  1. See GetKMSEncryptionKeyResultTypeDef

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

Method definition
def get_labels(
    self,
    *,
    name: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetLabelsResultTypeDef:  # (1)
    ...
  1. See GetLabelsResultTypeDef
Usage example with kwargs
kwargs: GetLabelsRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_labels(**kwargs)
  1. See GetLabelsRequestRequestTypeDef

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

Method definition
def get_model_version(
    self,
    *,
    modelId: str,
    modelType: ModelTypeEnumType,  # (1)
    modelVersionNumber: str,
) -> GetModelVersionResultTypeDef:  # (2)
    ...
  1. See ModelTypeEnumType
  2. See GetModelVersionResultTypeDef
Usage example with kwargs
kwargs: GetModelVersionRequestRequestTypeDef = {  # (1)
    "modelId": ...,
    "modelType": ...,
    "modelVersionNumber": ...,
}

parent.get_model_version(**kwargs)
  1. See GetModelVersionRequestRequestTypeDef

get_models

Gets one or more models.

Type annotations and code completion for boto3.client("frauddetector").get_models method. boto3 documentation

Method definition
def get_models(
    self,
    *,
    modelId: str = ...,
    modelType: ModelTypeEnumType = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetModelsResultTypeDef:  # (2)
    ...
  1. See ModelTypeEnumType
  2. See GetModelsResultTypeDef
Usage example with kwargs
kwargs: GetModelsRequestRequestTypeDef = {  # (1)
    "modelId": ...,
}

parent.get_models(**kwargs)
  1. See GetModelsRequestRequestTypeDef

get_outcomes

Gets one or more outcomes.

Type annotations and code completion for boto3.client("frauddetector").get_outcomes method. boto3 documentation

Method definition
def get_outcomes(
    self,
    *,
    name: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetOutcomesResultTypeDef:  # (1)
    ...
  1. See GetOutcomesResultTypeDef
Usage example with kwargs
kwargs: GetOutcomesRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_outcomes(**kwargs)
  1. See GetOutcomesRequestRequestTypeDef

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

Method definition
def get_rules(
    self,
    *,
    detectorId: str,
    ruleId: str = ...,
    ruleVersion: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetRulesResultTypeDef:  # (1)
    ...
  1. See GetRulesResultTypeDef
Usage example with kwargs
kwargs: GetRulesRequestRequestTypeDef = {  # (1)
    "detectorId": ...,
}

parent.get_rules(**kwargs)
  1. See GetRulesRequestRequestTypeDef

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

Method definition
def get_variables(
    self,
    *,
    name: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetVariablesResultTypeDef:  # (1)
    ...
  1. See GetVariablesResultTypeDef
Usage example with kwargs
kwargs: GetVariablesRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_variables(**kwargs)
  1. See GetVariablesRequestRequestTypeDef

list_event_predictions

Gets a list of past predictions.

Type annotations and code completion for boto3.client("frauddetector").list_event_predictions method. boto3 documentation

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)
    ...
  1. See FilterConditionTypeDef
  2. See FilterConditionTypeDef
  3. See FilterConditionTypeDef
  4. See FilterConditionTypeDef
  5. See PredictionTimeRangeTypeDef
  6. See ListEventPredictionsResultTypeDef
Usage example with kwargs
kwargs: ListEventPredictionsRequestRequestTypeDef = {  # (1)
    "eventId": ...,
}

parent.list_event_predictions(**kwargs)
  1. See ListEventPredictionsRequestRequestTypeDef

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

Method definition
def list_tags_for_resource(
    self,
    *,
    resourceARN: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListTagsForResourceResultTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResultTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

put_detector

Creates or updates a detector.

Type annotations and code completion for boto3.client("frauddetector").put_detector method. boto3 documentation

Method definition
def put_detector(
    self,
    *,
    detectorId: str,
    eventTypeName: str,
    description: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
Usage example with kwargs
kwargs: PutDetectorRequestRequestTypeDef = {  # (1)
    "detectorId": ...,
    "eventTypeName": ...,
}

parent.put_detector(**kwargs)
  1. See PutDetectorRequestRequestTypeDef

put_entity_type

Creates or updates an entity type.

Type annotations and code completion for boto3.client("frauddetector").put_entity_type method. boto3 documentation

Method definition
def put_entity_type(
    self,
    *,
    name: str,
    description: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
Usage example with kwargs
kwargs: PutEntityTypeRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.put_entity_type(**kwargs)
  1. See PutEntityTypeRequestRequestTypeDef

put_event_type

Creates or updates an event type.

Type annotations and code completion for boto3.client("frauddetector").put_event_type method. boto3 documentation

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)
) -> Dict[str, Any]:
    ...
  1. See EventIngestionType
  2. See TagTypeDef
Usage example with kwargs