From d0594b9dafa5e5efdd06ea5ec14165c3e99d8acc Mon Sep 17 00:00:00 2001
From: awstools Resets metadata about your connector entities that Amazon AppFlow stored in its
+ * cache. Use this action when you want Amazon AppFlow to return the latest information
+ * about the data that you have in a source application. Amazon AppFlow returns metadata about your entities when you use the
+ * ListConnectorEntities or DescribeConnectorEntities actions. Following these actions, Amazon AppFlow caches the metadata to reduce the number of API requests that it must send to
+ * the source application. Amazon AppFlow automatically resets the cache once every hour,
+ * but you can use this action when you want to get the latest metadata right away. There was a conflict when processing the request (for example, a flow with the given name
+ * already exists within the account. Check for conflicting resource names and try again. An internal service error occurred during the processing of your request. Try again
+ * later. The resource specified in the request (such as the source or destination connector
+ * profile) is not found. The request has invalid or missing parameters. Base exception class for all service exceptions from Appflow service. The default. Optimizes a flow for datasets that fluctuate in size from small to
- * large. For each flow run, Amazon AppFlow chooses to use the SYNC or ASYNC API type based on
- * the amount of data that the run transfers.
+ResetConnectorMetadataCache
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-appflow/classes/resetconnectormetadatacachecommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-appflow/interfaces/resetconnectormetadatacachecommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-appflow/interfaces/resetconnectormetadatacachecommandoutput.html)
+
diff --git a/clients/client-appflow/src/Appflow.ts b/clients/client-appflow/src/Appflow.ts
index 36b7d0e45587..c6b1b067bab4 100644
--- a/clients/client-appflow/src/Appflow.ts
+++ b/clients/client-appflow/src/Appflow.ts
@@ -71,6 +71,11 @@ import {
RegisterConnectorCommandInput,
RegisterConnectorCommandOutput,
} from "./commands/RegisterConnectorCommand";
+import {
+ ResetConnectorMetadataCacheCommand,
+ ResetConnectorMetadataCacheCommandInput,
+ ResetConnectorMetadataCacheCommandOutput,
+} from "./commands/ResetConnectorMetadataCacheCommand";
import { StartFlowCommand, StartFlowCommandInput, StartFlowCommandOutput } from "./commands/StartFlowCommand";
import { StopFlowCommand, StopFlowCommandInput, StopFlowCommandOutput } from "./commands/StopFlowCommand";
import { TagResourceCommand, TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
@@ -113,6 +118,7 @@ const commands = {
ListFlowsCommand,
ListTagsForResourceCommand,
RegisterConnectorCommand,
+ ResetConnectorMetadataCacheCommand,
StartFlowCommand,
StopFlowCommand,
TagResourceCommand,
@@ -369,6 +375,23 @@ export interface Appflow {
cb: (err: any, data?: RegisterConnectorCommandOutput) => void
): void;
+ /**
+ * @see {@link ResetConnectorMetadataCacheCommand}
+ */
+ resetConnectorMetadataCache(
+ args: ResetConnectorMetadataCacheCommandInput,
+ options?: __HttpHandlerOptions
+ ): Promise
A synchronous API. This type of API optimizes a flow for small to medium-sized datasets.
+ *A synchronous API. This type of API optimizes a flow for small to medium-sized + * datasets.
*The name of the connector profile that you want to reset cached metadata for.
+ *You can omit this parameter if you're resetting the cache for any of the following + * connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you must include this + * parameter in your request.
+ */ + connectorProfileName?: string; + + /** + *The type of connector to reset cached metadata for.
+ *You must include this parameter in your request if you're resetting the cache for any of + * the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, + * Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you + * can omit this parameter from your request.
+ */ + connectorType?: ConnectorType | string; + + /** + *Use this parameter if you want to reset cached metadata about the details for an + * individual entity.
+ *If you don't include this parameter in your request, Amazon AppFlow only resets + * cached metadata about entity names, not entity details.
+ */ + connectorEntityName?: string; + + /** + *Use this parameter only if you’re resetting the cached metadata about a nested entity. + * Only some connectors support nested entities. A nested entity is one that has another entity + * as a parent. To use this parameter, specify the name of the parent entity.
+ *To look up the parent-child relationship of entities, you can send a ListConnectorEntities + * request that omits the entitiesPath parameter. Amazon AppFlow will return a list of + * top-level entities. For each one, it indicates whether the entity has nested entities. Then, + * in a subsequent ListConnectorEntities request, you can specify a parent entity name for the + * entitiesPath parameter. Amazon AppFlow will return a list of the child entities for that + * parent.
+ */ + entitiesPath?: string; + + /** + *The API version that you specified in the connector profile that you’re resetting cached + * metadata for. You must use this parameter only if the connector supports multiple API versions + * or if the connector type is CustomConnector.
+ *To look up how many versions a connector supports, use the DescribeConnectors action. In + * the response, find the value that Amazon AppFlow returns for the connectorVersion + * parameter.
+ *To look up the connector type, use the DescribeConnectorProfiles action. In the response, + * find the value that Amazon AppFlow returns for the connectorType parameter.
+ *To look up the API version that you specified in a connector profile, use the + * DescribeConnectorProfiles action.
+ */ + apiVersion?: string; +} + +/** + * @public + */ +export interface ResetConnectorMetadataCacheResponse {} + /** * @public */ diff --git a/clients/client-appflow/src/protocols/Aws_restJson1.ts b/clients/client-appflow/src/protocols/Aws_restJson1.ts index 17dc67a91147..500038d40b24 100644 --- a/clients/client-appflow/src/protocols/Aws_restJson1.ts +++ b/clients/client-appflow/src/protocols/Aws_restJson1.ts @@ -62,6 +62,10 @@ import { ListTagsForResourceCommandOutput, } from "../commands/ListTagsForResourceCommand"; import { RegisterConnectorCommandInput, RegisterConnectorCommandOutput } from "../commands/RegisterConnectorCommand"; +import { + ResetConnectorMetadataCacheCommandInput, + ResetConnectorMetadataCacheCommandOutput, +} from "../commands/ResetConnectorMetadataCacheCommand"; import { StartFlowCommandInput, StartFlowCommandOutput } from "../commands/StartFlowCommand"; import { StopFlowCommandInput, StopFlowCommandOutput } from "../commands/StopFlowCommand"; import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand"; @@ -712,6 +716,40 @@ export const se_RegisterConnectorCommand = async ( }); }; +/** + * serializeAws_restJson1ResetConnectorMetadataCacheCommand + */ +export const se_ResetConnectorMetadataCacheCommand = async ( + input: ResetConnectorMetadataCacheCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = { + "content-type": "application/json", + }; + const resolvedPath = + `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/reset-connector-metadata-cache"; + let body: any; + body = JSON.stringify( + take(input, { + apiVersion: [], + connectorEntityName: [], + connectorProfileName: [], + connectorType: [], + entitiesPath: [], + }) + ); + return new __HttpRequest({ + protocol, + hostname, + port, + method: "POST", + headers, + path: resolvedPath, + body, + }); +}; + /** * serializeAws_restJson1StartFlowCommand */ @@ -1868,6 +1906,58 @@ const de_RegisterConnectorCommandError = async ( } }; +/** + * deserializeAws_restJson1ResetConnectorMetadataCacheCommand + */ +export const de_ResetConnectorMetadataCacheCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): PromiseYou can specify one of the following types:
\nThe default. Optimizes a flow for datasets that fluctuate in size from small to\n large. For each flow run, Amazon AppFlow chooses to use the SYNC or ASYNC API type based on\n the amount of data that the run transfers.
\nA synchronous API. This type of API optimizes a flow for small to medium-sized datasets.
\nAn asynchronous API. This type of API optimizes a flow for large datasets.
\nYou can specify one of the following types:
\nThe default. Optimizes a flow for datasets that fluctuate in size from small to\n large. For each flow run, Amazon AppFlow chooses to use the SYNC or ASYNC API type\n based on the amount of data that the run transfers.
\nA synchronous API. This type of API optimizes a flow for small to medium-sized\n datasets.
\nAn asynchronous API. This type of API optimizes a flow for large datasets.
\nDescribes the status of an attempt from Amazon AppFlow to register a resource.
\nWhen you run a flow that you've configured to use a metadata catalog, Amazon AppFlow\n registers a metadata table and data partitions with that catalog. This operation provides the\n status of that registration attempt. The operation also indicates how many related resources\n Amazon AppFlow created or updated.
" } }, + "com.amazonaws.appflow#ResetConnectorMetadataCache": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#ResetConnectorMetadataCacheRequest" + }, + "output": { + "target": "com.amazonaws.appflow#ResetConnectorMetadataCacheResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#ConflictException" + }, + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appflow#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Resets metadata about your connector entities that Amazon AppFlow stored in its\n cache. Use this action when you want Amazon AppFlow to return the latest information\n about the data that you have in a source application.
\nAmazon AppFlow returns metadata about your entities when you use the\n ListConnectorEntities or DescribeConnectorEntities actions. Following these actions, Amazon AppFlow caches the metadata to reduce the number of API requests that it must send to\n the source application. Amazon AppFlow automatically resets the cache once every hour,\n but you can use this action when you want to get the latest metadata right away.
", + "smithy.api#http": { + "method": "POST", + "uri": "/reset-connector-metadata-cache", + "code": 200 + } + } + }, + "com.amazonaws.appflow#ResetConnectorMetadataCacheRequest": { + "type": "structure", + "members": { + "connectorProfileName": { + "target": "com.amazonaws.appflow#ConnectorProfileName", + "traits": { + "smithy.api#documentation": "The name of the connector profile that you want to reset cached metadata for.
\nYou can omit this parameter if you're resetting the cache for any of the following\n connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you must include this\n parameter in your request.
" + } + }, + "connectorType": { + "target": "com.amazonaws.appflow#ConnectorType", + "traits": { + "smithy.api#documentation": "The type of connector to reset cached metadata for.
\nYou must include this parameter in your request if you're resetting the cache for any of\n the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics,\n Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you\n can omit this parameter from your request.
" + } + }, + "connectorEntityName": { + "target": "com.amazonaws.appflow#EntityName", + "traits": { + "smithy.api#documentation": "Use this parameter if you want to reset cached metadata about the details for an\n individual entity.
\nIf you don't include this parameter in your request, Amazon AppFlow only resets\n cached metadata about entity names, not entity details.
" + } + }, + "entitiesPath": { + "target": "com.amazonaws.appflow#EntitiesPath", + "traits": { + "smithy.api#documentation": "Use this parameter only if you’re resetting the cached metadata about a nested entity.\n Only some connectors support nested entities. A nested entity is one that has another entity\n as a parent. To use this parameter, specify the name of the parent entity.
\nTo look up the parent-child relationship of entities, you can send a ListConnectorEntities\n request that omits the entitiesPath parameter. Amazon AppFlow will return a list of\n top-level entities. For each one, it indicates whether the entity has nested entities. Then,\n in a subsequent ListConnectorEntities request, you can specify a parent entity name for the\n entitiesPath parameter. Amazon AppFlow will return a list of the child entities for that\n parent.
" + } + }, + "apiVersion": { + "target": "com.amazonaws.appflow#ApiVersion", + "traits": { + "smithy.api#documentation": "The API version that you specified in the connector profile that you’re resetting cached\n metadata for. You must use this parameter only if the connector supports multiple API versions\n or if the connector type is CustomConnector.
\nTo look up how many versions a connector supports, use the DescribeConnectors action. In\n the response, find the value that Amazon AppFlow returns for the connectorVersion\n parameter.
\nTo look up the connector type, use the DescribeConnectorProfiles action. In the response,\n find the value that Amazon AppFlow returns for the connectorType parameter.
\nTo look up the API version that you specified in a connector profile, use the\n DescribeConnectorProfiles action.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appflow#ResetConnectorMetadataCacheResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.appflow#ResourceNotFoundException": { "type": "structure", "members": { @@ -7954,6 +8030,9 @@ { "target": "com.amazonaws.appflow#RegisterConnector" }, + { + "target": "com.amazonaws.appflow#ResetConnectorMetadataCache" + }, { "target": "com.amazonaws.appflow#StartFlow" },