outcomes

Creates, updates, deletes or gets an outcome resource or lists outcomes in a region

Overview

Name	outcomes
Type	Resource
Description	An outcome for rule evaluation.
Id	aws.frauddetector.outcomes

Fields

Name	Datatype	Description
name	string	The name of the outcome.
tags	array	Tags associated with this outcome.
description	string	The outcome description.
arn	string	The outcome ARN.
created_time	string	The timestamp when the outcome was created.
last_updated_time	string	The timestamp when the outcome was last updated.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all outcomes in a region.

SELECT
region,
name,
tags,
description,
arn,
created_time,
last_updated_time
FROM aws.frauddetector.outcomes
WHERE region = 'us-east-1';

Gets all properties from an individual outcome.

SELECT
region,
name,
tags,
description,
arn,
created_time,
last_updated_time
FROM aws.frauddetector.outcomes
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

Use the following StackQL query and manifest file to create a new outcome resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.frauddetector.outcomes (
 Name,
 region
)
SELECT 
'{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.frauddetector.outcomes (
 Name,
 Tags,
 Description,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Tags }}',
 '{{ Description }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: outcome
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: Description
        value: '{{ Description }}'

DELETE example

/*+ delete */
DELETE FROM aws.frauddetector.outcomes
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

To operate on the outcomes resource, the following permissions are required:

Create

frauddetector:GetOutcomes,
frauddetector:PutOutcome,
frauddetector:ListTagsForResource,
frauddetector:TagResource

Read

frauddetector:GetOutcomes,
frauddetector:ListTagsForResource

Update

frauddetector:GetOutcomes,
frauddetector:PutOutcome,
frauddetector:ListTagsForResource,
frauddetector:TagResource,
frauddetector:UntagResource

Delete

frauddetector:GetOutcomes,
frauddetector:DeleteOutcome

List

frauddetector:GetOutcomes,
frauddetector:ListTagsForResource