external_models

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

Overview

Name	external_models
Type	Resource
Id	aws.frauddetector.external_models

Fields

The following fields are returned by SELECT queries:

get_external_models

Name	Datatype	Description
external_models	array	Gets the Amazon SageMaker models.
next_token	string	The next page token to be used in subsequent requests.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_external_models	select	region		Gets the details for one or more Amazon SageMaker models that have been imported into the service. This is a paginated API. If you provide a null maxResults, this actions retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetExternalModelsResult as part of your request. A null pagination token fetches the records from the beginning.
put_external_model	replace	region, modelEndpoint, modelSource, invokeModelEndpointRoleArn, inputConfiguration, outputConfiguration, modelEndpointStatus		Creates or updates an Amazon SageMaker model endpoint. You can also use this action to update the configuration of the model endpoint, including the IAM role and/or the mapped variables.
delete_external_model	delete	region		Removes a SageMaker model from Amazon Fraud Detector. You can remove an Amazon SageMaker model if it is not associated with a detector version. Removing a SageMaker model disconnects it from Amazon Fraud Detector, but the model remains available in SageMaker.

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_external_models

Gets the details for one or more Amazon SageMaker models that have been imported into the service. This is a paginated API. If you provide a null maxResults, this actions retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetExternalModelsResult as part of your request. A null pagination token fetches the records from the beginning.

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

REPLACE examples

put_external_model

Creates or updates an Amazon SageMaker model endpoint. You can also use this action to update the configuration of the model endpoint, including the IAM role and/or the mapped variables.

REPLACE aws.frauddetector.external_models
SET 
modelEndpoint = '{{ modelEndpoint }}',
modelSource = '{{ modelSource }}',
invokeModelEndpointRoleArn = '{{ invokeModelEndpointRoleArn }}',
inputConfiguration = '{{ inputConfiguration }}',
outputConfiguration = '{{ outputConfiguration }}',
modelEndpointStatus = '{{ modelEndpointStatus }}',
tags = '{{ tags }}'
WHERE 
region = '{{ region }}' --required
AND modelEndpoint = '{{ modelEndpoint }}' --required
AND modelSource = '{{ modelSource }}' --required
AND invokeModelEndpointRoleArn = '{{ invokeModelEndpointRoleArn }}' --required
AND inputConfiguration = '{{ inputConfiguration }}' --required
AND outputConfiguration = '{{ outputConfiguration }}' --required
AND modelEndpointStatus = '{{ modelEndpointStatus }}' --required;

DELETE examples

delete_external_model

Removes a SageMaker model from Amazon Fraud Detector. You can remove an Amazon SageMaker model if it is not associated with a detector version. Removing a SageMaker model disconnects it from Amazon Fraud Detector, but the model remains available in SageMaker.

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