Appflow

import { Appflow } from "https://aws-api.deno.dev/v0.4/services/appflow.ts?docs=full";

class Appflow {

constructor(apiFactory: client.ApiFactory);

async createConnectorProfile(params: CreateConnectorProfileRequest, opts?: client.RequestOptions): Promise<CreateConnectorProfileResponse>;

async createFlow(params: CreateFlowRequest, opts?: client.RequestOptions): Promise<CreateFlowResponse>;

async deleteConnectorProfile(params: DeleteConnectorProfileRequest, opts?: client.RequestOptions): Promise<void>;

async deleteFlow(params: DeleteFlowRequest, opts?: client.RequestOptions): Promise<void>;

async describeConnector(params: DescribeConnectorRequest, opts?: client.RequestOptions): Promise<DescribeConnectorResponse>;

async describeConnectorEntity(params: DescribeConnectorEntityRequest, opts?: client.RequestOptions): Promise<DescribeConnectorEntityResponse>;

async describeConnectorProfiles(params?: DescribeConnectorProfilesRequest, opts?: client.RequestOptions): Promise<DescribeConnectorProfilesResponse>;

async describeConnectors(params?: DescribeConnectorsRequest, opts?: client.RequestOptions): Promise<DescribeConnectorsResponse>;

async describeFlow(params: DescribeFlowRequest, opts?: client.RequestOptions): Promise<DescribeFlowResponse>;

async describeFlowExecutionRecords(params: DescribeFlowExecutionRecordsRequest, opts?: client.RequestOptions): Promise<DescribeFlowExecutionRecordsResponse>;

async listConnectorEntities(params?: ListConnectorEntitiesRequest, opts?: client.RequestOptions): Promise<ListConnectorEntitiesResponse>;

async listConnectors(params?: ListConnectorsRequest, opts?: client.RequestOptions): Promise<ListConnectorsResponse>;

async listFlows(params?: ListFlowsRequest, opts?: client.RequestOptions): Promise<ListFlowsResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async registerConnector(params?: RegisterConnectorRequest, opts?: client.RequestOptions): Promise<RegisterConnectorResponse>;

async startFlow(params: StartFlowRequest, opts?: client.RequestOptions): Promise<StartFlowResponse>;

async stopFlow(params: StopFlowRequest, opts?: client.RequestOptions): Promise<StopFlowResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async unregisterConnector(params: UnregisterConnectorRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateConnectorProfile(params: UpdateConnectorProfileRequest, opts?: client.RequestOptions): Promise<UpdateConnectorProfileResponse>;

async updateConnectorRegistration(params: UpdateConnectorRegistrationRequest, opts?: client.RequestOptions): Promise<UpdateConnectorRegistrationResponse>;

async updateFlow(params: UpdateFlowRequest, opts?: client.RequestOptions): Promise<UpdateFlowResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new Appflow(apiFactory: client.ApiFactory)

[src]

§Methods

createConnectorProfile(params: CreateConnectorProfileRequest, opts?: client.RequestOptions): Promise<CreateConnectorProfileResponse>

[src]

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.

createFlow(params: CreateFlowRequest, opts?: client.RequestOptions): Promise<CreateFlowResponse>

[src]

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.

deleteConnectorProfile(params: DeleteConnectorProfileRequest, opts?: client.RequestOptions): Promise<void>

[src]

Enables you to delete an existing connector profile.

deleteFlow(params: DeleteFlowRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

describeConnector(params: DescribeConnectorRequest, opts?: client.RequestOptions): Promise<DescribeConnectorResponse>

[src]

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.

describeConnectorEntity(params: DescribeConnectorEntityRequest, opts?: client.RequestOptions): Promise<DescribeConnectorEntityResponse>

[src]

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

describeConnectorProfiles(params?: DescribeConnectorProfilesRequest, opts?: client.RequestOptions): Promise<DescribeConnectorProfilesResponse>

[src]

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.

describeConnectors(params?: DescribeConnectorsRequest, opts?: client.RequestOptions): Promise<DescribeConnectorsResponse>

[src]

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.

describeFlow(params: DescribeFlowRequest, opts?: client.RequestOptions): Promise<DescribeFlowResponse>

[src]

Provides a description of the specified flow.

describeFlowExecutionRecords(params: DescribeFlowExecutionRecordsRequest, opts?: client.RequestOptions): Promise<DescribeFlowExecutionRecordsResponse>

[src]

Fetches the execution history of the flow.

listConnectorEntities(params?: ListConnectorEntitiesRequest, opts?: client.RequestOptions): Promise<ListConnectorEntitiesResponse>

[src]

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.

listConnectors(params?: ListConnectorsRequest, opts?: client.RequestOptions): Promise<ListConnectorsResponse>

[src]

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.

listFlows(params?: ListFlowsRequest, opts?: client.RequestOptions): Promise<ListFlowsResponse>

[src]

Lists all of the flows associated with your account.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Retrieves the tags that are associated with a specified flow.

registerConnector(params?: RegisterConnectorRequest, opts?: client.RequestOptions): Promise<RegisterConnectorResponse>

[src]

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.

startFlow(params: StartFlowRequest, opts?: client.RequestOptions): Promise<StartFlowResponse>

[src]

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.

stopFlow(params: StopFlowRequest, opts?: client.RequestOptions): Promise<StopFlowResponse>

[src]

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.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Applies a tag to the specified flow.

unregisterConnector(params: UnregisterConnectorRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes a tag from the specified flow.

updateConnectorProfile(params: UpdateConnectorProfileRequest, opts?: client.RequestOptions): Promise<UpdateConnectorProfileResponse>

[src]

Updates a given connector profile associated with your account.

updateConnectorRegistration(params: UpdateConnectorRegistrationRequest, opts?: client.RequestOptions): Promise<UpdateConnectorRegistrationResponse>

[src]

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

updateFlow(params: UpdateFlowRequest, opts?: client.RequestOptions): Promise<UpdateFlowResponse>

[src]

Updates an existing flow.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]