|
2 | 2 | "version": "2.0", |
3 | 3 | "service": "<p>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. </p> <p>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 Amazon Web Services like Amazon S3 and Amazon Redshift. </p> <p>Use the following links to get started on the Amazon AppFlow API:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/appflow/1.0/APIReference/API_Operations.html\">Actions</a>: An alphabetical list of all Amazon AppFlow API operations.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/appflow/1.0/APIReference/API_Types.html\">Data types</a>: An alphabetical list of all Amazon AppFlow data types.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/appflow/1.0/APIReference/CommonParameters.html\">Common parameters</a>: Parameters that all Query operations can use.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/appflow/1.0/APIReference/CommonErrors.html\">Common errors</a>: Client and server errors that all operations can return.</p> </li> </ul> <p>If you're new to Amazon AppFlow, we recommend that you review the <a href=\"https://docs.aws.amazon.com/appflow/latest/userguide/what-is-appflow.html\">Amazon AppFlow User Guide</a>.</p> <p>Amazon AppFlow API users can use vendor-specific mechanisms for OAuth, and include applicable OAuth attributes (such as <code>auth-code</code> and <code>redirecturi</code>) with the connector-specific <code>ConnectorProfileProperties</code> when creating a new connector profile using Amazon AppFlow API operations. For example, Salesforce users can refer to the <a href=\"https://help.salesforce.com/articleView?id=remoteaccess_authenticate.htm\"> <i>Authorize Apps with OAuth</i> </a> documentation.</p>", |
4 | 4 | "operations": { |
5 | | - "CreateConnectorProfile": "<p> 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. </p>", |
| 5 | + "CreateConnectorProfile": "<p> 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.</p>", |
6 | 6 | "CreateFlow": "<p> 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. </p>", |
7 | 7 | "DeleteConnectorProfile": "<p> Enables you to delete an existing connector profile. </p>", |
8 | 8 | "DeleteFlow": "<p> 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. </p>", |
9 | 9 | "DescribeConnector": "<p>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.</p>", |
10 | | - "DescribeConnectorEntity": "<p> Provides details regarding the entity used with the connector, with a description of the data model for each entity. </p>", |
| 10 | + "DescribeConnectorEntity": "<p> Provides details regarding the entity used with the connector, with a description of the data model for each field in that entity. </p>", |
11 | 11 | "DescribeConnectorProfiles": "<p> Returns a list of <code>connector-profile</code> details matching the provided <code>connector-profile</code> names and <code>connector-types</code>. Both input lists are optional, and you can use them to filter the result. </p> <p>If no names or <code>connector-types</code> are provided, returns all connector profiles in a paginated form. If there is no match, this operation returns an empty list.</p>", |
12 | 12 | "DescribeConnectors": "<p> 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 <code>nextToken</code> object, which can be be passed in to the next call to the <code>DescribeConnectors</code> API operation to retrieve the next page. </p>", |
13 | 13 | "DescribeFlow": "<p> Provides a description of the specified flow. </p>", |
|
813 | 813 | "ExecutionRecord$dataPullEndTime": "<p> The timestamp that indicates the last new or updated record to be transferred in the flow run. </p>", |
814 | 814 | "FlowDefinition$createdAt": "<p> Specifies when the flow was created. </p>", |
815 | 815 | "FlowDefinition$lastUpdatedAt": "<p> Specifies when the flow was last updated. </p>", |
816 | | - "ScheduledTriggerProperties$scheduleStartTime": "<p> Specifies the scheduled start time for a schedule-triggered flow. </p>", |
817 | | - "ScheduledTriggerProperties$scheduleEndTime": "<p> Specifies the scheduled end time for a schedule-triggered flow. </p>", |
| 816 | + "ScheduledTriggerProperties$scheduleStartTime": "<p>The time at which the scheduled flow starts. The time is formatted as a timestamp that follows the ISO 8601 standard, such as <code>2022-04-26T13:00:00-07:00</code>.</p>", |
| 817 | + "ScheduledTriggerProperties$scheduleEndTime": "<p>The time at which the scheduled flow ends. The time is formatted as a timestamp that follows the ISO 8601 standard, such as <code>2022-04-27T13:00:00-07:00</code>.</p>", |
818 | 818 | "ScheduledTriggerProperties$firstExecutionFrom": "<p> Specifies the date range for the records to import from the connector in the first flow run. </p>" |
819 | 819 | } |
820 | 820 | }, |
|
1145 | 1145 | "UpdateFlowRequest$description": "<p> A description of the flow. </p>" |
1146 | 1146 | } |
1147 | 1147 | }, |
| 1148 | + "FlowErrorDeactivationThreshold": { |
| 1149 | + "base": null, |
| 1150 | + "refs": { |
| 1151 | + "ScheduledTriggerProperties$flowErrorDeactivationThreshold": "<p>Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.</p>" |
| 1152 | + } |
| 1153 | + }, |
1148 | 1154 | "FlowExecutionList": { |
1149 | 1155 | "base": null, |
1150 | 1156 | "refs": { |
|
1319 | 1325 | "refs": { |
1320 | 1326 | } |
1321 | 1327 | }, |
| 1328 | + "JavaBoolean": { |
| 1329 | + "base": null, |
| 1330 | + "refs": { |
| 1331 | + "S3OutputFormatConfig$preserveSourceDataTyping": "<p>If your file output format is Parquet, use this parameter to set whether Amazon AppFlow preserves the data types in your source data when it writes the output to Amazon S3. </p> <ul> <li> <p> <code>true</code>: Amazon AppFlow preserves the data types when it writes to Amazon S3. For example, an integer or <code>1</code> in your source data is still an integer in your output.</p> </li> <li> <p> <code>false</code>: Amazon AppFlow converts all of the source data into strings when it writes to Amazon S3. For example, an integer of <code>1</code> in your source data becomes the string <code>\"1\"</code> in the output.</p> </li> </ul>" |
| 1332 | + } |
| 1333 | + }, |
1322 | 1334 | "KMSArn": { |
1323 | 1335 | "base": null, |
1324 | 1336 | "refs": { |
|
2249 | 2261 | "Timezone": { |
2250 | 2262 | "base": null, |
2251 | 2263 | "refs": { |
2252 | | - "ScheduledTriggerProperties$timezone": "<p> Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as <code>America/New_York</code>. </p>" |
| 2264 | + "ScheduledTriggerProperties$timezone": "<p>Specifies the time zone used when referring to the dates and times of a scheduled flow, such as <code>America/New_York</code>. This time zone is only a descriptive label. It doesn't affect how Amazon AppFlow interprets the timestamps that you specify to schedule the flow.</p> <p>If you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC offset in your timestamps. For example, the UTC offsets for the <code>America/New_York</code> timezone are <code>-04:00</code> EDT and <code>-05:00 EST</code>.</p>" |
2253 | 2265 | } |
2254 | 2266 | }, |
2255 | 2267 | "TokenUrl": { |
|
0 commit comments