workflows

Creates, updates, deletes, gets or lists a workflows resource.

Overview

Name	workflows
Type	Resource
Id	aws.customer_profiles.workflows

Fields

The following fields are returned by SELECT queries:

get_workflow

Name	Datatype	Description
attributes	object	Attributes provided for workflow execution.
error_description	string	Workflow error messages during execution (if any).
last_updated_at	string (date-time)	The timestamp that represents when workflow execution last updated.
metrics	object	Workflow specific execution metrics.
start_date	string (date-time)	The timestamp that represents when workflow execution started.
status	string	Status of workflow execution. (NOT_STARTED, IN_PROGRESS, COMPLETE, FAILED, SPLIT, RETRY, CANCELLED)
workflow_id	string	Unique identifier for the workflow. (pattern: <code>[a-f0-9]{32}</code>)
workflow_type	string	The type of workflow. The only supported value is APPFLOW_INTEGRATION. (APPFLOW_INTEGRATION)

list_workflows

Name	Datatype	Description
items	array	List containing workflow details.
next_token	string	If there are additional results, this is the token for the next set of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_workflow	select	domain_name, workflow_id, region		Get details of specified workflow.
list_workflows	select	domain_name, region	next-token, max-results	Query to list all workflows.
create_integration_workflow	insert	domain_name, region, WorkflowType, IntegrationConfig, ObjectTypeName, RoleArn		Creates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo.
delete_workflow	delete	domain_name, workflow_id, region		Deletes the specified workflow and all its corresponding resources. This is an async process.

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
domain_name	string	The unique name of the domain.
region	string	AWS region (default: us-east-1)
workflow_id	string	Unique identifier for the workflow.
max-results	integer	The maximum number of results to return per page.
next-token	string	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

SELECT examples

get_workflow

Get details of specified workflow.

SELECT
attributes,
error_description,
last_updated_at,
metrics,
start_date,
status,
workflow_id,
workflow_type
FROM aws.customer_profiles.workflows
WHERE domain_name = '{{ domain_name }}' -- required
AND workflow_id = '{{ workflow_id }}' -- required
AND region = '{{ region }}' -- required
;

list_workflows

Query to list all workflows.

SELECT
items,
next_token
FROM aws.customer_profiles.workflows
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_integration_workflow

Creates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo.

INSERT INTO aws.customer_profiles.workflows (
WorkflowType,
IntegrationConfig,
ObjectTypeName,
RoleArn,
Tags,
domain_name,
region
)
SELECT 
'{{ WorkflowType }}' /* required */,
'{{ IntegrationConfig }}' /* required */,
'{{ ObjectTypeName }}' /* required */,
'{{ RoleArn }}' /* required */,
'{{ Tags }}',
'{{ domain_name }}',
'{{ region }}'
RETURNING
message,
workflow_id
;

Manifest

# Description fields are for documentation purposes
- name: workflows
props:
  - name: domain_name
    value: "{{ domain_name }}"
    description: Required parameter for the workflows resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the workflows resource.
  - name: WorkflowType
    value: "{{ WorkflowType }}"
    valid_values: ['APPFLOW_INTEGRATION']
  - name: IntegrationConfig
    description: |
      Configuration data for integration workflow.
    value:
      AppflowIntegration:
        FlowDefinition:
          Description: "{{ Description }}"
          FlowName: "{{ FlowName }}"
          KmsArn: "{{ KmsArn }}"
          SourceFlowConfig:
            ConnectorProfileName: "{{ ConnectorProfileName }}"
            ConnectorType: "{{ ConnectorType }}"
            IncrementalPullConfig:
              DatetimeTypeFieldName: "{{ DatetimeTypeFieldName }}"
            SourceConnectorProperties:
              Marketo: "{{ Marketo }}"
              S3: "{{ S3 }}"
              Salesforce: "{{ Salesforce }}"
              ServiceNow: "{{ ServiceNow }}"
              Zendesk: "{{ Zendesk }}"
          Tasks:
            - ConnectorOperator:
                Marketo: "{{ Marketo }}"
                S3: "{{ S3 }}"
                Salesforce: "{{ Salesforce }}"
                ServiceNow: "{{ ServiceNow }}"
                Zendesk: "{{ Zendesk }}"
              DestinationField: "{{ DestinationField }}"
              SourceFields: "{{ SourceFields }}"
              TaskProperties: "{{ TaskProperties }}"
              TaskType: "{{ TaskType }}"
          TriggerConfig:
            TriggerType: "{{ TriggerType }}"
            TriggerProperties:
              Scheduled: "{{ Scheduled }}"
        Batches:
          - StartTime: "{{ StartTime }}"
            EndTime: "{{ EndTime }}"
  - name: ObjectTypeName
    value: "{{ ObjectTypeName }}"
  - name: RoleArn
    value: "{{ RoleArn }}"
  - name: Tags
    value: "{{ Tags }}"

DELETE examples

delete_workflow

Deletes the specified workflow and all its corresponding resources. This is an async process.

DELETE FROM aws.customer_profiles.workflows
WHERE domain_name = '{{ domain_name }}' --required
AND workflow_id = '{{ workflow_id }}' --required
AND region = '{{ region }}' --required
;