openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 259 kB

JSON

{"openapi":"3.0.0","info":{"version":"2020-08-23","x-release":"v4","title":"Amazon Appflow","description":"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 Amazon Web Services like Amazon S3 and Amazon Redshift. Use the following links to get started on the Amazon AppFlow API: <ul> <li> <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. </li> <li> <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. </li> <li> <a href=\"https://docs.aws.amazon.com/appflow/1.0/APIReference/CommonParameters.html\">Common parameters</a>: Parameters that all Query operations can use. </li> <li> <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. </li> </ul> 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>. 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\"> Authorize Apps with OAuth </a> documentation.","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"appflow","x-aws-signingName":"appflow","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/appflow-2020-08-23.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/appflow/"},"servers":[{"url":"http://appflow.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon Appflow multi-region endpoint"},{"url":"https://appflow.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon Appflow multi-region endpoint"},{"url":"http://appflow.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon Appflow endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://appflow.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon Appflow endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/cancel-flow-executions":{"post":{"operationId":"CancelFlowExecutions","description":"Cancels active runs for a flow. You can cancel all of the active runs for a flow, or you can cancel specific runs by providing their IDs. You can cancel a flow run only when the run is in progress. You can't cancel a run that has already completed or failed. You also can't cancel a run that's scheduled to occur but hasn't started yet. To prevent a scheduled run, you can deactivate the flow with the <code>StopFlow</code> action. You cannot resume a run after you cancel it. When you send your request, the status for each run becomes <code>CancelStarted</code>. When the cancellation completes, the status becomes <code>Canceled</code>. <note> When you cancel a run, you still incur charges for any data that the run already processed before the cancellation. If the run had already written some data to the flow destination, then that data remains in the destination. If you configured the flow to use a batch API (such as the Salesforce Bulk API 2.0), then the run will finish reading or writing its entire batch of data after the cancellation. For these operations, the data processing charges for Amazon AppFlow apply. For the pricing information, see <a href=\"http://aws.amazon.com/appflow/pricing/\">Amazon AppFlow pricing</a>. </note>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelFlowExecutionsResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["flowName"],"properties":{"flowName":{"description":"The name of a flow with active runs that you want to cancel.","type":"string","pattern":"[a-zA-Z0-9][\\w!@#.-]+","maxLength":256},"executionIds":{"description":"The ID of each active run to cancel. These runs must belong to the flow you specify in your request. If you omit this parameter, your request ends all active runs that belong to the flow.","type":"array","items":{"$ref":"#/components/schemas/ExecutionId"},"minItems":0,"maxItems":100}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/create-connector-profile":{"post":{"operationId":"CreateConnectorProfile","description":" 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.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConnectorProfileResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"483":{"description":"ConnectorAuthenticationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorAuthenticationException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["connectorProfileName","connectorType","connectionMode","connectorProfileConfig"],"properties":{"connectorProfileName":{"description":" The name of the connector profile. The name is unique for each <code>ConnectorProfile</code> in your Amazon Web Services account. ","type":"string","pattern":"[\\w/!@#+=.-]+","maxLength":256},"kmsArn":{"description":" 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. ","type":"string","pattern":"arn:aws:kms:.*:[0-9]+:.*","minLength":20,"maxLength":2048},"connectorType":{"description":" The type of connector, such as Salesforce, Amplitude, and so on. ","type":"string","enum":["Salesforce","Singular","Slack","Redshift","S3","Marketo","Googleanalytics","Zendesk","Servicenow","Datadog","Trendmicro","Snowflake","Dynatrace","Infornexus","Amplitude","Veeva","EventBridge","LookoutMetrics","Upsolver","Honeycode","CustomerProfiles","SAPOData","CustomConnector","Pardot"]},"connectorLabel":{"description":"The label of the connector. The label is unique for each <code>ConnectorRegistration</code> in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.","type":"string","pattern":"[a-zA-Z0-9][\\w!@#.-]+","maxLength":256},"connectionMode":{"description":" Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the public internet. ","type":"string","enum":["Public","Private"]},"connectorProfileConfig":{"description":" Defines the connector-specific configuration and credentials for the connector profile. ","type":"object","properties":{"connectorProfileProperties":{"allOf":[{"$ref":"#/components/schemas/ConnectorProfileProperties"},{"description":" The connector-specific properties of the profile configuration. "}]},"connectorProfileCredentials":{"allOf":[{"$ref":"#/components/schemas/ConnectorProfileCredentials"},{"description":" The connector-specific credentials required by each connector. "}]}}},"clientToken":{"description":"The <code>clientToken</code> parameter is an idempotency token. It ensures that your <code>CreateConnectorProfile</code> request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same <code>clientToken</code> parameter value. If you omit a <code>clientToken</code> value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases. If you specify input parameters that differ from your first request, an error occurs. If you use a different value for <code>clientToken</code>, Amazon AppFlow considers it a new call to <code>CreateConnectorProfile</code>. The token is active for 8 hours.","type":"string","pattern":"[ -~]+","minLength":1,"maxLength":256}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/create-flow":{"post":{"operationId":"CreateFlow","description":" 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. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFlowResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"484":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"485":{"description":"ConnectorAuthenticationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorAuthenticationException"}}}},"486":{"description":"ConnectorServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorServerException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["flowName","triggerConfig","sourceFlowConfig","destinationFlowConfigList","tasks"],"properties":{"flowName":{"description":" The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. ","type":"string","pattern":"[a-zA-Z0-9][\\w!@#.-]+","maxLength":256},"description":{"description":" A description of the flow you want to create. ","type":"string","pattern":"[\\w!@#\\-.?,\\s]*","maxLength":2048},"kmsArn":{"description":" 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. ","type":"string","pattern":"arn:aws:kms:.*:[0-9]+:.*","minLength":20,"maxLength":2048},"triggerConfig":{"description":" The trigger settings that determine how and when Amazon AppFlow runs the specified flow. ","type":"object","properties":{"triggerType":{"allOf":[{"$ref":"#/components/schemas/TriggerType"},{"description":" Specifies the type of flow trigger. This can be <code>OnDemand</code>, <code>Scheduled</code>, or <code>Event</code>. "}]},"triggerProperties":{"allOf":[{"$ref":"#/components/schemas/TriggerProperties"},{"description":" Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the <code>Scheduled</code> trigger type. "}]}}},"sourceFlowConfig":{"description":" Contains information about the configuration of the source connector used in the flow. ","type":"object","properties":{"connectorType":{"allOf":[{"$ref":"#/components/schemas/ConnectorType"},{"description":" The type of connector, such as Salesforce, Amplitude, and so on. "}]},"apiVersion":{"allOf":[{"$ref":"#/components/schemas/ApiVersion"},{"description":"The API version of the connector when it's used as a source in the flow."}]},"connectorProfileName":{"allOf":[{"$ref":"#/components/schemas/ConnectorProfileName"},{"description":" The name of the connector profile. This name must be unique for each connector profile in the Amazon Web Services account. "}]},"sourceConnectorProperties":{"allOf":[{"$ref":"#/components/schemas/SourceConnectorProperties"},{"description":" Specifies the information that is required to query a particular source connector. "}]},"incrementalPullConfig":{"allOf":[{"$ref":"#/components/schemas/IncrementalPullConfig"},{"description":" Defines the configuration for a scheduled incremental data pull. If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull. "}]}}},"destinationFlowConfigList":{"description":" The configuration that controls how Amazon AppFlow places data in the destination connector. ","type":"array","items":{"$ref":"#/components/schemas/DestinationFlowConfig"}},"tasks":{"description":" A list of tasks that Amazon AppFlow performs while transferring the data in the flow run. ","type":"array","items":{"$ref":"#/components/schemas/Task"}},"tags":{"description":" The tags used to organize, track, or control access for your flow. ","type":"object","minProperties":0,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}},"metadataCatalogConfig":{"description":"Specifies the configuration that Amazon AppFlow uses when it catalogs your data. When Amazon AppFlow catalogs your data, it stores metadata in a data catalog.","type":"object","properties":{"glueDataCatalog":{"allOf":[{"$ref":"#/components/schemas/GlueDataCatalogConfig"},{"description":"Specifies the configuration that Amazon AppFlow uses when it catalogs your data with the Glue Data Catalog."}]}}},"clientToken":{"description":"The <code>clientToken</code> parameter is an idempotency token. It ensures that your <code>CreateFlow</code> request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same <code>clientToken</code> parameter value. If you omit a <code>clientToken</code> value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases. If you specify input parameters that differ from your first request, an error occurs. If you use a different value for <code>clientToken</code>, Amazon AppFlow considers it a new call to <code>CreateFlow</code>. The token is active for 8 hours.","type":"string","pattern":"[ -~]+","minLength":1,"maxLength":256}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/delete-connector-profile":{"post":{"operationId":"DeleteConnectorProfile","description":" Enables you to delete an existing connector profile. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteConnectorProfileResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["connectorProfileName"],"properties":{"connectorProfileName":{"description":" The name of the connector profile. The name is unique for each <code>ConnectorProfile</code> in your account. ","type":"string","pattern":"[\\w/!@#+=.-]+","maxLength":256},"forceDelete":{"description":" Indicates whether Amazon AppFlow should delete the profile, even if it is currently in use in one or more flows. ","type":"boolean"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/delete-flow":{"post":{"operationId":"DeleteFlow","description":" 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. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFlowResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["flowName"],"properties":{"flowName":{"description":" The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. ","type":"string","pattern":"[a-zA-Z0-9][\\w!@#.-]+","maxLength":256},"forceDelete":{"description":" Indicates whether Amazon AppFlow should delete the flow, even if it is currently in use. ","type":"boolean"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/describe-connector":{"post":{"operationId":"DescribeConnector","description":"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.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeConnectorResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["connectorType"],"properties":{"connectorType":{"description":"The connector type, such as CUSTOMCONNECTOR, Saleforce, Marketo. Please choose CUSTOMCONNECTOR for Lambda based custom connectors.","type":"string","enum":["Salesforce","Singular","Slack","Redshift","S3","Marketo","Googleanalytics","Zendesk","Servicenow","Datadog","Trendmicro","Snowflake","Dynatrace","Infornexus","Amplitude","Veeva","EventBridge","LookoutMetrics","Upsolver","Honeycode","CustomerProfiles","SAPOData","CustomConnector","Pardot"]},"connectorLabel":{"description":"The label of the connector. The label is unique for each <code>ConnectorRegistration</code> in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.","type":"string","pattern":"[a-zA-Z0-9][\\w!@#.-]+","maxLength":256}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/describe-connector-entity":{"post":{"operationId":"DescribeConnectorEntity","description":" Provides details regarding the entity used with the connector, with a description of the data model for each field in that entity. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeConnectorEntityResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ConnectorAuthenticationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorAuthenticationException"}}}},"483":{"description":"ConnectorServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorServerException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["connectorEntityName"],"properties":{"connectorEntityName":{"description":" The entity name for that connector. ","type":"string","pattern":"\\S+","maxLength":1024},"connectorType":{"description":" The type of connector application, such as Salesforce, Amplitude, and so on. ","type":"string","enum":["Salesforce","Singular","Slack","Redshift","S3","Marketo","Googleanalytics","Zendesk","Servicenow","Datadog","Trendmicro","Snowflake","Dynatrace","Infornexus","Amplitude","Veeva","EventBridge","LookoutMetrics","Upsolver","Honeycode","CustomerProfiles","SAPOData","CustomConnector","Pardot"]},"connectorProfileName":{"description":" The name of the connector profile. The name is unique for each <code>ConnectorProfile</code> in the Amazon Web Services account. ","type":"string","pattern":"[\\w/!@#+=.-]+","maxLength":256},"apiVersion":{"description":"The version of the API that's used by the connector.","type":"string","pattern":"\\S+","maxLength":256}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/describe-connector-profiles":{"post":{"operationId":"DescribeConnectorProfiles","description":" 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. 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.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeConnectorProfilesResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"maxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"nextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"connectorProfileNames":{"description":" The name of the connector profile. The name is unique for each <code>ConnectorProfile</code> in the Amazon Web Services account. ","type":"array","items":{"$ref":"#/components/schemas/ConnectorProfileName"},"minItems":0,"maxItems":100},"connectorType":{"description":" The type of connector, such as Salesforce, Amplitude, and so on. ","type":"string","enum":["Salesforce","Singular","Slack","Redshift","S3","Marketo","Googleanalytics","Zendesk","Servicenow","Datadog","Trendmicro","Snowflake","Dynatrace","Infornexus","Amplitude","Veeva","EventBridge","LookoutMetrics","Upsolver","Honeycode","CustomerProfiles","SAPOData","CustomConnector","Pardot"]},"connectorLabel":{"description":"The name of the connector. The name is unique for each <code>ConnectorRegistration</code> in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.","type":"string","pattern":"[a-zA-Z0-9][\\w!@#.-]+","maxLength":256},"maxResults":{"description":" Specifies the maximum number of items that should be returned in the result set. The default for <code>maxResults</code> is 20 (for all paginated API operations). ","type":"integer","minimum":1,"maximum":100},"nextToken":{"description":" The pagination token for the next page of data. ","type":"string","pattern":"\\S+","maxLength":2048}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/describe-connectors":{"post":{"operationId":"DescribeConnectors","description":" 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. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeConnectorsResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"maxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"nextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"connectorTypes":{"description":" The type of connector, such as Salesforce, Amplitude, and so on. ","type":"array","items":{"$ref":"#/components/schemas/ConnectorType"},"minItems":0,"maxItems":100},"maxResults":{"description":"The maximum number of items that should be returned in the result set. The default is 20.","type":"integer","minimum":1,"maximum":100},"nextToken":{"description":" The pagination token for the next page of data. ","type":"string","pattern":"\\S+","maxLength":2048}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/describe-flow":{"post":{"operationId":"DescribeFlow","description":" Provides a description of the specified flow. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeFlowResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["flowName"],"properties":{"flowName":{"description":" The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. ","type":"string","pattern":"[a-zA-Z0-9][\\w!@#.-]+","maxLength":256}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/describe-flow-execution-records":{"post":{"operationId":"DescribeFlowExecutionRecords","description":" Fetches the execution history of the flow. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeFlowExecutionRecordsResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"maxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"nextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["flowName"],"properties":{"flowName":{"description":" The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. ","type":"string","pattern":"[a-zA-Z0-9][\\w!@#.-]+","maxLength":256},"maxResults":{"description":" Specifies the maximum number of items that should be returned in the result set. The default for <code>maxResults</code> is 20 (for all paginated API operations). ","type":"integer","minimum":1,"maximum":100},"nextToken":{"description":" The pagination token for the next page of data. ","type":"string","pattern":"\\S+","maxLength":2048}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/list-connector-entities":{"post":{"operationId":"ListConnectorEntities","description":" 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. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectorEntitiesResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ConnectorAuthenticationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorAuthenticationException"}}}},"483":{"description":"ConnectorServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorServerException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"connectorProfileName":{"description":" The name of the connector profile. The name is unique for each <code>ConnectorProfile</code> in the Amazon Web Services account, and is used to query the downstream connector. ","type":"string","pattern":"[\\w/!@#+=.-]+","maxLength":256},"connectorType":{"description":" The type of connector, such as Salesforce, Amplitude, and so on. ","type":"string","enum":["Salesforce","Singular","Slack","Redshift","S3","Marketo","Googleanalytics","Zendesk","Servicenow","Datadog","Trendmicro","Snowflake","Dynatrace","Infornexus","Amplitude","Veeva","EventBridge","LookoutMetrics","Upsolver","Honeycode","CustomerProfiles","SAPOData","CustomConnector","Pardot"]},"entitiesPath":{"description":" 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 <code>entitiesPath</code> 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. ","type":"string","pattern":"[\\s\\w/!@#+=,.-]*","maxLength":256},"apiVersion":{"description":"The version of the API that's used by the connector.","type":"string","pattern":"\\S+","maxLength":256},"maxResults":{"description":"The maximum number of items that the operation returns in the response.","type":"integer","minimum":1,"maximum":10000},"nextToken":{"description":"A token that was provided by your prior <code>ListConnectorEntities</code> operation if the response was too big for the page size. You specify this token to get the next page of results in paginated response.","type":"string","pattern":"\\S+","maxLength":2048}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/list-connectors":{"post":{"operationId":"ListConnectors","description":"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. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectorsResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"maxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"nextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"maxResults":{"description":"Specifies the maximum number of items that should be returned in the result set. The default for <code>maxResults</code> is 20 (for all paginated API operations).","type":"integer","minimum":1,"maximum":100},"nextToken":{"description":"The pagination token for the next page of data.","type":"string","pattern":"\\S+","maxLength":2048}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/list-flows":{"post":{"operationId":"ListFlows","description":" Lists all of the flows associated with your account. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFlowsResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"maxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"nextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"maxResults":{"description":" Specifies the maximum number of items that should be returned in the result set. ","type":"integer","minimum":1,"maximum":100},"nextToken":{"description":" The pagination token for next page of data. ","type":"string","pattern":"\\S+","maxLength":2048}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/tags/{resourceArn}":{"get":{"operationId":"ListTagsForResource","description":" Retrieves the tags that are associated with a specified flow. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTagsForResourceResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"resourceArn","in":"path","required":true,"description":" The Amazon Resource Name (ARN) of the specified flow. ","schema":{"type":"string","pattern":"arn:aws:.*:.*:[0-9]+:.*","maxLength":512}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"operationId":"TagResource","description":" Applies a tag to the specified flow. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagResourceResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"resourceArn","in":"path","required":true,"description":" The Amazon Resource Name (ARN) of the flow that you want to tag. ","schema":{"type":"string","pattern":"arn:aws:.*:.*:[0-9]+:.*","maxLength":512}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tags"],"properties":{"tags":{"description":" The tags used to organize, track, or control access for your flow. ","type":"object","minProperties":0,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}}},"/register-connector":{"post":{"operationId":"RegisterConnector","description":"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.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterConnectorResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"485":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"486":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"487":{"description":"ConnectorServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorServerException"}}}},"488":{"description":"ConnectorAuthenticationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorAuthenticationException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"connectorLabel":{"description":" The name of the connector. The name is unique for each <code>ConnectorRegistration</code> in your Amazon Web Services account.","type":"string","pattern":"[a-zA-Z0-9][\\w!@#.-]+","maxLength":256},"description":{"description":"A description about the connector that's being registered.","type":"string","pattern":"[\\s\\w/!@#+=.-]*","maxLength":1024},"connectorProvisioningType":{"description":"The type of provisioning that the connector supports, such as Lambda.","type":"string","enum":["LAMBDA"]},"connectorProvisioningConfig":{"description":"Contains information about the configuration of the connector being registered.","type":"object","properties":{"lambda":{"allOf":[{"$ref":"#/components/schemas/LambdaConnectorProvisioningConfig"},{"description":"Contains information about the configuration of the lambda which is being registered as the connector."}]}}},"clientToken":{"description":"The <code>clientToken</code> parameter is an idempotency token. It ensures that your <code>RegisterConnector</code> request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same <code>clientToken</code> parameter value. If you omit a <code>clientToken</code> value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases. If you specify input parameters that differ from your first request, an error occurs. If you use a different value for <code>clientToken</code>, Amazon AppFlow considers it a new call to <code>RegisterConnector</code>. The token is active for 8 hours.","type":"string","pattern":"[ -~]+","minLength":1,"maxLength":256}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/reset-connector-metadata-cache":{"post":{"operation