Appflow
public struct Appflow
Client object for interacting with AWS Appflow service.
Welcome to the Amazon AppFlow API reference. This guide is for developers who need detailed information about the Amazon AppFlow API operations, data types, and errors. Amazon AppFlow is a fully managed integration service that enables you to securely transfer data between software as a service (SaaS) applications like Salesforce, Marketo, Slack, and ServiceNow, and AWS services like Amazon S3 and Amazon Redshift. Use the following links to get started on the Amazon AppFlow API: Actions: An alphabetical list of all Amazon AppFlow API operations. Data types: An alphabetical list of all Amazon AppFlow data types. Common parameters: Parameters that all Query operations can use. Common errors: Client and server errors that all operations can return. If you’re new to Amazon AppFlow, we recommend that you review the Amazon AppFlow User Guide. Amazon AppFlow API users can use vendor-specific mechanisms for OAuth, and include applicable OAuth attributes (such as auth-code and redirecturi) with the connector-specific ConnectorProfileProperties when creating a new connector profile using Amazon AppFlow API operations. For example, Salesforce users can refer to the Authorize Apps with OAuth documentation.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the Appflow client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)
Parameters
accessKeyId
Public access key provided by AWS
secretAccessKey
Private access key provided by AWS
sessionToken
Token provided by STS.AssumeRole() which allows access to another AWS account
region
Region of server you want to communicate with
endpoint
Custom endpoint URL to use instead of standard AWS servers
middlewares
Array of middlewares to apply to requests and responses
eventLoopGroupProvider
EventLoopGroup to use. Use
useAWSClientShared
if the client shall manage its own EventLoopGroup.
-
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.
Declaration
Swift
public func createConnectorProfile(_ input: CreateConnectorProfileRequest) -> EventLoopFuture<CreateConnectorProfileResponse>
-
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.
Declaration
Swift
public func createFlow(_ input: CreateFlowRequest) -> EventLoopFuture<CreateFlowResponse>
-
Enables you to delete an existing connector profile.
Declaration
Swift
public func deleteConnectorProfile(_ input: DeleteConnectorProfileRequest) -> EventLoopFuture<DeleteConnectorProfileResponse>
-
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.
Declaration
Swift
public func deleteFlow(_ input: DeleteFlowRequest) -> EventLoopFuture<DeleteFlowResponse>
-
Provides details regarding the entity used with the connector, with a description of the data model for each entity.
Declaration
Swift
public func describeConnectorEntity(_ input: DescribeConnectorEntityRequest) -> EventLoopFuture<DescribeConnectorEntityResponse>
-
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.
Declaration
Swift
public func describeConnectorProfiles(_ input: DescribeConnectorProfilesRequest) -> EventLoopFuture<DescribeConnectorProfilesResponse>
-
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.
Declaration
Swift
public func describeConnectors(_ input: DescribeConnectorsRequest) -> EventLoopFuture<DescribeConnectorsResponse>
-
Provides a description of the specified flow.
Declaration
Swift
public func describeFlow(_ input: DescribeFlowRequest) -> EventLoopFuture<DescribeFlowResponse>
-
Fetches the execution history of the flow.
Declaration
Swift
public func describeFlowExecutionRecords(_ input: DescribeFlowExecutionRecordsRequest) -> EventLoopFuture<DescribeFlowExecutionRecordsResponse>
-
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.
Declaration
Swift
public func listConnectorEntities(_ input: ListConnectorEntitiesRequest) -> EventLoopFuture<ListConnectorEntitiesResponse>
-
Lists all of the flows associated with your account.
Declaration
Swift
public func listFlows(_ input: ListFlowsRequest) -> EventLoopFuture<ListFlowsResponse>
-
Retrieves the tags that are associated with a specified flow.
Declaration
Swift
public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>
-
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.
Declaration
Swift
public func startFlow(_ input: StartFlowRequest) -> EventLoopFuture<StartFlowResponse>
-
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.
Declaration
Swift
public func stopFlow(_ input: StopFlowRequest) -> EventLoopFuture<StopFlowResponse>
-
Applies a tag to the specified flow.
Declaration
Swift
public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse>
-
Removes a tag from the specified flow.
Declaration
Swift
public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse>
-
Updates a given connector profile associated with your account.
Declaration
Swift
public func updateConnectorProfile(_ input: UpdateConnectorProfileRequest) -> EventLoopFuture<UpdateConnectorProfileResponse>
-
Updates an existing flow.
Declaration
Swift
public func updateFlow(_ input: UpdateFlowRequest) -> EventLoopFuture<UpdateFlowResponse>
-
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.
Declaration
Swift
public func describeConnectorProfilesPaginator(_ input: DescribeConnectorProfilesRequest, onPage: @escaping (DescribeConnectorProfilesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
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.
Declaration
Swift
public func describeConnectorsPaginator(_ input: DescribeConnectorsRequest, onPage: @escaping (DescribeConnectorsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Fetches the execution history of the flow.
Declaration
Swift
public func describeFlowExecutionRecordsPaginator(_ input: DescribeFlowExecutionRecordsRequest, onPage: @escaping (DescribeFlowExecutionRecordsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists all of the flows associated with your account.
Declaration
Swift
public func listFlowsPaginator(_ input: ListFlowsRequest, onPage: @escaping (ListFlowsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct DescribeConnectorProfilesRequest : AWSShape
extension Appflow.DescribeConnectorProfilesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct DescribeConnectorsRequest : AWSShape
extension Appflow.DescribeConnectorsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct DescribeFlowExecutionRecordsRequest : AWSShape
extension Appflow.DescribeFlowExecutionRecordsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListFlowsRequest : AWSShape
extension Appflow.ListFlowsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public enum AggregationType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum AmplitudeConnectorOperator : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ConnectionMode : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ConnectorType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum DataPullMode : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum DatadogConnectorOperator : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum DynatraceConnectorOperator : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ExecutionStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum FileType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum FlowStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum GoogleAnalyticsConnectorOperator : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum InforNexusConnectorOperator : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum MarketoConnectorOperator : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum Operator : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum OperatorPropertiesKeys : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum PrefixFormat : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum PrefixType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum S3ConnectorOperator : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum SalesforceConnectorOperator : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ScheduleFrequencyType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ServiceNowConnectorOperator : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum SingularConnectorOperator : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum SlackConnectorOperator : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum TaskType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum TrendmicroConnectorOperator : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum TriggerType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum VeevaConnectorOperator : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ZendeskConnectorOperator : String, CustomStringConvertible, Codable