Appflow

This page documents function available when using the Appflow module, created with @service Appflow.

Index

Documentation

Main.Appflow.cancel_flow_executionsMethod
cancel_flow_executions(flow_name)
cancel_flow_executions(flow_name, params::Dict{String,<:Any})

Cancels active runs for a flow. You can cancel all of the active runs for a flow, or you can cancel specific runs by providing their IDs. You can cancel a flow run only when the run is in progress. You can't cancel a run that has already completed or failed. You also can't cancel a run that's scheduled to occur but hasn't started yet. To prevent a scheduled run, you can deactivate the flow with the StopFlow action. You cannot resume a run after you cancel it. When you send your request, the status for each run becomes CancelStarted. When the cancellation completes, the status becomes Canceled. When you cancel a run, you still incur charges for any data that the run already processed before the cancellation. If the run had already written some data to the flow destination, then that data remains in the destination. If you configured the flow to use a batch API (such as the Salesforce Bulk API 2.0), then the run will finish reading or writing its entire batch of data after the cancellation. For these operations, the data processing charges for Amazon AppFlow apply. For the pricing information, see Amazon AppFlow pricing.

Arguments

  • flow_name: The name of a flow with active runs that you want to cancel.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "executionIds": The ID of each active run to cancel. These runs must belong to the flow you specify in your request. If you omit this parameter, your request ends all active runs that belong to the flow.
Main.Appflow.create_connector_profileMethod
create_connector_profile(connection_mode, connector_profile_config, connector_profile_name, connector_type)
create_connector_profile(connection_mode, connector_profile_config, connector_profile_name, connector_type, params::Dict{String,<:Any})

Creates a new connector profile associated with your Amazon Web Services account. There is a soft quota of 100 connector profiles per Amazon Web Services account. If you need more connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel. In each connector profile that you create, you can provide the credentials and properties for only one connector.

Arguments

  • connection_mode: Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the public internet.
  • connector_profile_config: Defines the connector-specific configuration and credentials.
  • connector_profile_name: The name of the connector profile. The name is unique for each ConnectorProfile in your Amazon Web Services account.
  • connector_type: The type of connector, such as Salesforce, Amplitude, and so on.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": The clientToken parameter is an idempotency token. It ensures that your CreateConnectorProfile request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value. If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases. If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to CreateConnectorProfile. The token is active for 8 hours.
  • "connectorLabel": The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
  • "kmsArn": The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
Main.Appflow.create_flowMethod
create_flow(destination_flow_config_list, flow_name, source_flow_config, tasks, trigger_config)
create_flow(destination_flow_config_list, flow_name, source_flow_config, tasks, trigger_config, params::Dict{String,<:Any})

Enables your application to create a new flow using Amazon AppFlow. You must create a connector profile before calling this API. Please note that the Request Syntax below shows syntax for multiple destinations, however, you can only transfer data to one item in this list at a time. Amazon AppFlow does not currently support flows to multiple destinations at once.

Arguments

  • destination_flow_config_list: The configuration that controls how Amazon AppFlow places data in the destination connector.
  • flow_name: The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
  • source_flow_config: The configuration that controls how Amazon AppFlow retrieves data from the source connector.
  • tasks: A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
  • trigger_config: The trigger settings that determine how and when the flow runs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": The clientToken parameter is an idempotency token. It ensures that your CreateFlow request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value. If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases. If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to CreateFlow. The token is active for 8 hours.
  • "description": A description of the flow you want to create.
  • "kmsArn": The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
  • "metadataCatalogConfig": Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
  • "tags": The tags used to organize, track, or control access for your flow.
Main.Appflow.delete_connector_profileMethod
delete_connector_profile(connector_profile_name)
delete_connector_profile(connector_profile_name, params::Dict{String,<:Any})

Enables you to delete an existing connector profile.

Arguments

  • connector_profile_name: The name of the connector profile. The name is unique for each ConnectorProfile in your account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "forceDelete": Indicates whether Amazon AppFlow should delete the profile, even if it is currently in use in one or more flows.
Main.Appflow.delete_flowMethod
delete_flow(flow_name)
delete_flow(flow_name, params::Dict{String,<:Any})

Enables your application to delete an existing flow. Before deleting the flow, Amazon AppFlow validates the request by checking the flow configuration and status. You can delete flows one at a time.

Arguments

  • flow_name: The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "forceDelete": Indicates whether Amazon AppFlow should delete the flow, even if it is currently in use.
Main.Appflow.describe_connectorMethod
describe_connector(connector_type)
describe_connector(connector_type, params::Dict{String,<:Any})

Describes the given custom connector registered in your Amazon Web Services account. This API can be used for custom connectors that are registered in your account and also for Amazon authored connectors.

Arguments

  • connector_type: The connector type, such as CUSTOMCONNECTOR, Saleforce, Marketo. Please choose CUSTOMCONNECTOR for Lambda based custom connectors.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "connectorLabel": The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
Main.Appflow.describe_connector_entityMethod
describe_connector_entity(connector_entity_name)
describe_connector_entity(connector_entity_name, params::Dict{String,<:Any})

Provides details regarding the entity used with the connector, with a description of the data model for each field in that entity.

Arguments

  • connector_entity_name: The entity name for that connector.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "apiVersion": The version of the API that's used by the connector.
  • "connectorProfileName": The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account.
  • "connectorType": The type of connector application, such as Salesforce, Amplitude, and so on.
Main.Appflow.describe_connector_profilesMethod
describe_connector_profiles()
describe_connector_profiles(params::Dict{String,<:Any})

Returns a list of connector-profile details matching the provided connector-profile names and connector-types. Both input lists are optional, and you can use them to filter the result. If no names or connector-types are provided, returns all connector profiles in a paginated form. If there is no match, this operation returns an empty list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "connectorLabel": The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
  • "connectorProfileNames": The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account.
  • "connectorType": The type of connector, such as Salesforce, Amplitude, and so on.
  • "maxResults": Specifies the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations).
  • "nextToken": The pagination token for the next page of data.
Main.Appflow.describe_connectorsMethod
describe_connectors()
describe_connectors(params::Dict{String,<:Any})

Describes the connectors vended by Amazon AppFlow for specified connector types. If you don't specify a connector type, this operation describes all connectors vended by Amazon AppFlow. If there are more connectors than can be returned in one page, the response contains a nextToken object, which can be be passed in to the next call to the DescribeConnectors API operation to retrieve the next page.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "connectorTypes": The type of connector, such as Salesforce, Amplitude, and so on.
  • "maxResults": The maximum number of items that should be returned in the result set. The default is 20.
  • "nextToken": The pagination token for the next page of data.
Main.Appflow.describe_flowMethod
describe_flow(flow_name)
describe_flow(flow_name, params::Dict{String,<:Any})

Provides a description of the specified flow.

Arguments

  • flow_name: The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
Main.Appflow.describe_flow_execution_recordsMethod
describe_flow_execution_records(flow_name)
describe_flow_execution_records(flow_name, params::Dict{String,<:Any})

Fetches the execution history of the flow.

Arguments

  • flow_name: The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": Specifies the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations).
  • "nextToken": The pagination token for the next page of data.
Main.Appflow.list_connector_entitiesMethod
list_connector_entities()
list_connector_entities(params::Dict{String,<:Any})

Returns the list of available connector entities supported by Amazon AppFlow. For example, you can query Salesforce for Account and Opportunity entities, or query ServiceNow for the Incident entity.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "apiVersion": The version of the API that's used by the connector.
  • "connectorProfileName": The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account, and is used to query the downstream connector.
  • "connectorType": The type of connector, such as Salesforce, Amplitude, and so on.
  • "entitiesPath": This optional parameter is specific to connector implementation. Some connectors support multiple levels or categories of entities. You can find out the list of roots for such providers by sending a request without the entitiesPath parameter. If the connector supports entities at different roots, this initial request returns the list of roots. Otherwise, this request returns all entities supported by the provider.
  • "maxResults": The maximum number of items that the operation returns in the response.
  • "nextToken": A token that was provided by your prior ListConnectorEntities operation if the response was too big for the page size. You specify this token to get the next page of results in paginated response.
Main.Appflow.list_connectorsMethod
list_connectors()
list_connectors(params::Dict{String,<:Any})

Returns the list of all registered custom connectors in your Amazon Web Services account. This API lists only custom connectors registered in this account, not the Amazon Web Services authored connectors.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": Specifies the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations).
  • "nextToken": The pagination token for the next page of data.
Main.Appflow.list_flowsMethod
list_flows()
list_flows(params::Dict{String,<:Any})

Lists all of the flows associated with your account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": Specifies the maximum number of items that should be returned in the result set.
  • "nextToken": The pagination token for next page of data.
Main.Appflow.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Retrieves the tags that are associated with a specified flow.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the specified flow.
Main.Appflow.register_connectorMethod
register_connector()
register_connector(params::Dict{String,<:Any})

Registers a new custom connector with your Amazon Web Services account. Before you can register the connector, you must deploy the associated AWS lambda function in your account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": The clientToken parameter is an idempotency token. It ensures that your RegisterConnector request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value. If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases. If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to RegisterConnector. The token is active for 8 hours.
  • "connectorLabel": The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web Services account.
  • "connectorProvisioningConfig": The provisioning type of the connector. Currently the only supported value is LAMBDA.
  • "connectorProvisioningType": The provisioning type of the connector. Currently the only supported value is LAMBDA.
  • "description": A description about the connector that's being registered.
Main.Appflow.start_flowMethod
start_flow(flow_name)
start_flow(flow_name, params::Dict{String,<:Any})

Activates an existing flow. For on-demand flows, this operation runs the flow immediately. For schedule and event-triggered flows, this operation activates the flow.

Arguments

  • flow_name: The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": The clientToken parameter is an idempotency token. It ensures that your StartFlow request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value. If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases. If you specify input parameters that differ from your first request, an error occurs for flows that run on a schedule or based on an event. However, the error doesn't occur for flows that run on demand. You set the conditions that initiate your flow for the triggerConfig parameter. If you use a different value for clientToken, Amazon AppFlow considers it a new call to StartFlow. The token is active for 8 hours.
Main.Appflow.stop_flowMethod
stop_flow(flow_name)
stop_flow(flow_name, params::Dict{String,<:Any})

Deactivates the existing flow. For on-demand flows, this operation returns an unsupportedOperationException error message. For schedule and event-triggered flows, this operation deactivates the flow.

Arguments

  • flow_name: The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
Main.Appflow.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Applies a tag to the specified flow.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the flow that you want to tag.
  • tags: The tags used to organize, track, or control access for your flow.
Main.Appflow.unregister_connectorMethod
unregister_connector(connector_label)
unregister_connector(connector_label, params::Dict{String,<:Any})

Unregisters the custom connector registered in your account that matches the connector label provided in the request.

Arguments

  • connector_label: The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web Services account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "forceDelete": Indicates whether Amazon AppFlow should unregister the connector, even if it is currently in use in one or more connector profiles. The default value is false.
Main.Appflow.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes a tag from the specified flow.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the flow that you want to untag.
  • tag_keys: The tag keys associated with the tag that you want to remove from your flow.
Main.Appflow.update_connector_profileMethod
update_connector_profile(connection_mode, connector_profile_config, connector_profile_name)
update_connector_profile(connection_mode, connector_profile_config, connector_profile_name, params::Dict{String,<:Any})

Updates a given connector profile associated with your account.

Arguments

  • connection_mode: Indicates the connection mode and if it is public or private.
  • connector_profile_config: Defines the connector-specific profile configuration and credentials.
  • connector_profile_name: The name of the connector profile and is unique for each ConnectorProfile in the Amazon Web Services account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": The clientToken parameter is an idempotency token. It ensures that your UpdateConnectorProfile request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value. If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases. If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to UpdateConnectorProfile. The token is active for 8 hours.
Main.Appflow.update_connector_registrationMethod
update_connector_registration(connector_label)
update_connector_registration(connector_label, params::Dict{String,<:Any})

Updates a custom connector that you've previously registered. This operation updates the connector with one of the following: The latest version of the AWS Lambda function that's assigned to the connector A new AWS Lambda function that you specify

Arguments

  • connector_label: The name of the connector. The name is unique for each connector registration in your AWS account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": The clientToken parameter is an idempotency token. It ensures that your UpdateConnectorRegistration request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value. If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases. If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to UpdateConnectorRegistration. The token is active for 8 hours.
  • "connectorProvisioningConfig":
  • "description": A description about the update that you're applying to the connector.
Main.Appflow.update_flowMethod
update_flow(destination_flow_config_list, flow_name, source_flow_config, tasks, trigger_config)
update_flow(destination_flow_config_list, flow_name, source_flow_config, tasks, trigger_config, params::Dict{String,<:Any})

Updates an existing flow.

Arguments

  • destination_flow_config_list: The configuration that controls how Amazon AppFlow transfers data to the destination connector.
  • flow_name: The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
  • source_flow_config:
  • tasks: A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
  • trigger_config: The trigger settings that determine how and when the flow runs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": The clientToken parameter is an idempotency token. It ensures that your UpdateFlow request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value. If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases. If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to UpdateFlow. The token is active for 8 hours.
  • "description": A description of the flow.
  • "metadataCatalogConfig": Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.