entity_types

Creates, updates, deletes, gets or lists an entity_types resource.

Overview

Name	entity_types
Type	Resource
Id	aws.frauddetector.entity_types

Fields

The following fields are returned by SELECT queries:

get_entity_types

Name	Datatype	Description
entity_types	array	An array of entity types.
next_token	string	The next page token.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_entity_types	select	region		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.
put_entity_type	replace	region, name		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.
delete_entity_type	delete	region		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_entity_types

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.

SELECT
entity_types,
next_token
FROM aws.frauddetector.entity_types
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_entity_type

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.

REPLACE aws.frauddetector.entity_types
SET 
name = '{{ name }}',
description = '{{ description }}',
tags = '{{ tags }}'
WHERE 
region = '{{ region }}' --required
AND name = '{{ name }}' --required;

DELETE examples

delete_entity_type

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.

DELETE FROM aws.frauddetector.entity_types
WHERE region = '{{ region }}' --required
;