Appflow

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 AWS account. There is a soft quota of 100 connector profiles per AWS 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.

Arguments

• connection_mode: Indicates the connection mode and specifies whether it is public or private. Private flows use AWS PrivateLink to route data over AWS 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 AWS 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:

• "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.

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:

• "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.
• "tags": The tags used to organize, track, or control access for your flow.

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.

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.

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 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:

• "connectorProfileName": The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account.
• "connectorType": The type of connector application, such as Salesforce, Amplitude, and so on.

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:

• "connectorProfileNames": The name of the connector profile. The name is unique for each ConnectorProfile in the AWS 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.

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.
• "nextToken": The pagination token for the next page of data.

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.

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.

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:

• "connectorProfileName": The name of the connector profile. The name is unique for each ConnectorProfile in the AWS 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.

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.

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.

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.

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.

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.

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.

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 AWS Account.

update_flow(destination_flow_config_list, flow_name, tasks, trigger_config)
update_flow(destination_flow_config_list, flow_name, 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.
• 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:

• "description": A description of the flow.
• "sourceFlowConfig":