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:
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.
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 StopFlow action.
You cannot resume a run after you cancel it.
When you send your request, the status for each run becomes CancelStarted. When the cancellation completes, the status becomes Canceled.
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 Amazon AppFlow pricing.
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' => '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' => 'Enables you to delete an existing connector profile.
', 'DeleteFlow' => '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' => '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' => 'Provides details regarding the entity used with the connector, with a description of the data model for each field in that entity.
', 'DescribeConnectorProfiles' => ' 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.
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.
Provides a description of the specified flow.
', 'DescribeFlowExecutionRecords' => 'Fetches the execution history of the flow.
', 'ListConnectorEntities' => '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' => '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' => 'Lists all of the flows associated with your account.
', 'ListTagsForResource' => 'Retrieves the tags that are associated with a specified flow.
', 'RegisterConnector' => '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.
', 'ResetConnectorMetadataCache' => '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.
', 'StartFlow' => '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' => ' 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.
Applies a tag to the specified flow.
', 'UnregisterConnector' => 'Unregisters the custom connector registered in your account that matches the connector label provided in the request.
', 'UntagResource' => 'Removes a tag from the specified flow.
', 'UpdateConnectorProfile' => 'Updates a given connector profile associated with your account.
', 'UpdateConnectorRegistration' => '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
Updates an existing flow.
', ], 'shapes' => [ 'ARN' => [ 'base' => NULL, 'refs' => [ 'ConnectorConfiguration$connectorArn' => 'The Amazon Resource Name (ARN) for the registered connector.
', 'ConnectorProfile$credentialsArn' => 'The Amazon Resource Name (ARN) of the connector profile credentials.
', 'LambdaConnectorProvisioningConfig$lambdaArn' => 'Lambda ARN of the connector being registered.
', 'ListTagsForResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the specified flow.
', 'RegisterConnectorResponse$connectorArn' => 'The ARN of the connector being registered.
', 'TagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the flow that you want to tag.
', 'UntagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the flow that you want to untag.
', 'UpdateConnectorRegistrationResponse$connectorArn' => 'The ARN of the connector being updated.
', ], ], 'AccessDeniedException' => [ 'base' => 'AppFlow/Requester has invalid or missing permissions.
', 'refs' => [], ], 'AccessKeyId' => [ 'base' => NULL, 'refs' => [ 'InforNexusConnectorProfileCredentials$accessKeyId' => 'The Access Key portion of the credentials.
', ], ], 'AccessToken' => [ 'base' => NULL, 'refs' => [ 'GoogleAnalyticsConnectorProfileCredentials$accessToken' => 'The credentials used to access protected Google Analytics resources.
', 'HoneycodeConnectorProfileCredentials$accessToken' => 'The credentials used to access protected Amazon Honeycode resources.
', 'MarketoConnectorProfileCredentials$accessToken' => 'The credentials used to access protected Marketo resources.
', 'OAuth2Credentials$accessToken' => 'The access token used to access the connector on your behalf.
', 'OAuthCredentials$accessToken' => 'The access token used to access protected SAPOData resources.
', 'PardotConnectorProfileCredentials$accessToken' => 'The credentials used to access protected Salesforce Pardot resources.
', 'SalesforceConnectorProfileCredentials$accessToken' => 'The credentials used to access protected Salesforce resources.
', 'SlackConnectorProfileCredentials$accessToken' => 'The credentials used to access protected Slack resources.
', 'ZendeskConnectorProfileCredentials$accessToken' => 'The credentials used to access protected Zendesk resources.
', ], ], 'AccountName' => [ 'base' => NULL, 'refs' => [ 'SnowflakeConnectorProfileProperties$accountName' => 'The name of the account.
', ], ], 'AggregationConfig' => [ 'base' => 'The aggregation settings that you can use to customize the output format of your flow data.
', 'refs' => [ 'S3OutputFormatConfig$aggregationConfig' => NULL, 'UpsolverS3OutputFormatConfig$aggregationConfig' => NULL, ], ], 'AggregationType' => [ 'base' => NULL, 'refs' => [ 'AggregationConfig$aggregationType' => 'Specifies whether Amazon AppFlow aggregates the flow records into a single file, or leave them unaggregated.
', ], ], 'AmplitudeConnectorOperator' => [ 'base' => NULL, 'refs' => [ 'ConnectorOperator$Amplitude' => 'The operation to be performed on the provided Amplitude source fields.
', ], ], 'AmplitudeConnectorProfileCredentials' => [ 'base' => 'The connector-specific credentials required when using Amplitude.
', 'refs' => [ 'ConnectorProfileCredentials$Amplitude' => 'The connector-specific credentials required when using Amplitude.
', ], ], 'AmplitudeConnectorProfileProperties' => [ 'base' => 'The connector-specific profile properties required when using Amplitude.
', 'refs' => [ 'ConnectorProfileProperties$Amplitude' => 'The connector-specific properties required by Amplitude.
', ], ], 'AmplitudeMetadata' => [ 'base' => 'The connector metadata specific to Amplitude.
', 'refs' => [ 'ConnectorMetadata$Amplitude' => 'The connector metadata specific to Amplitude.
', ], ], 'AmplitudeSourceProperties' => [ 'base' => 'The properties that are applied when Amplitude is being used as a source.
', 'refs' => [ 'SourceConnectorProperties$Amplitude' => 'Specifies the information that is required for querying Amplitude.
', ], ], 'ApiKey' => [ 'base' => NULL, 'refs' => [ 'AmplitudeConnectorProfileCredentials$apiKey' => 'A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
', 'ApiKeyCredentials$apiKey' => 'The API key required for API key authentication.
', 'DatadogConnectorProfileCredentials$apiKey' => 'A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
', 'SingularConnectorProfileCredentials$apiKey' => 'A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
', ], ], 'ApiKeyCredentials' => [ 'base' => 'The API key credentials required for API key authentication.
', 'refs' => [ 'CustomConnectorProfileCredentials$apiKey' => 'The API keys required for the authentication of the user.
', ], ], 'ApiSecretKey' => [ 'base' => NULL, 'refs' => [ 'ApiKeyCredentials$apiSecretKey' => 'The API secret key required for API key authentication.
', 'TrendmicroConnectorProfileCredentials$apiSecretKey' => 'The Secret Access Key portion of the credentials.
', ], ], 'ApiToken' => [ 'base' => NULL, 'refs' => [ 'DynatraceConnectorProfileCredentials$apiToken' => 'The API tokens used by Dynatrace API to authenticate various API calls.
', ], ], 'ApiVersion' => [ 'base' => NULL, 'refs' => [ 'DescribeConnectorEntityRequest$apiVersion' => 'The version of the API that\'s used by the connector.
', 'DestinationFlowConfig$apiVersion' => 'The API version that the destination connector uses.
', 'ListConnectorEntitiesRequest$apiVersion' => 'The version of the API that\'s used by the connector.
', 'ResetConnectorMetadataCacheRequest$apiVersion' => '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.
', 'SourceFlowConfig$apiVersion' => 'The API version of the connector when it\'s used as a source in the flow.
', ], ], 'ApplicationHostUrl' => [ 'base' => NULL, 'refs' => [ 'SAPODataConnectorProfileProperties$applicationHostUrl' => 'The location of the SAPOData resource.
', ], ], 'ApplicationKey' => [ 'base' => NULL, 'refs' => [ 'DatadogConnectorProfileCredentials$applicationKey' => 'Application keys, in conjunction with your API key, give you full access to Datadog’s programmatic API. Application keys are associated with the user account that created them. The application key is used to log all requests made to the API.
', ], ], 'ApplicationServicePath' => [ 'base' => NULL, 'refs' => [ 'SAPODataConnectorProfileProperties$applicationServicePath' => 'The application path to catalog service.
', ], ], 'ApplicationType' => [ 'base' => NULL, 'refs' => [ 'ConnectorDetail$applicationType' => 'The application type of the connector.
', ], ], 'AuthCode' => [ 'base' => NULL, 'refs' => [ 'ConnectorOAuthRequest$authCode' => 'The code provided by the connector when it has been authenticated via the connected app.
', ], ], 'AuthCodeUrl' => [ 'base' => NULL, 'refs' => [ 'AuthCodeUrlList$member' => NULL, 'OAuthProperties$authCodeUrl' => 'The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type authentication.
', ], ], 'AuthCodeUrlList' => [ 'base' => NULL, 'refs' => [ 'OAuth2Defaults$authCodeUrls' => 'Auth code URLs that can be used for OAuth 2.0 authentication.
', ], ], 'AuthParameter' => [ 'base' => 'Information about required authentication parameters.
', 'refs' => [ 'AuthParameterList$member' => NULL, ], ], 'AuthParameterList' => [ 'base' => NULL, 'refs' => [ 'CustomAuthConfig$authParameters' => 'Information about authentication parameters required for authentication.
', ], ], 'AuthenticationConfig' => [ 'base' => 'Contains information about the authentication config that the connector supports.
', 'refs' => [ 'ConnectorConfiguration$authenticationConfig' => 'The authentication config required for the connector.
', ], ], 'AuthenticationType' => [ 'base' => NULL, 'refs' => [ 'CustomConnectorProfileCredentials$authenticationType' => 'The authentication type that the custom connector uses for authenticating while creating a connector profile.
', ], ], 'BasicAuthCredentials' => [ 'base' => 'The basic auth credentials required for basic authentication.
', 'refs' => [ 'CustomConnectorProfileCredentials$basic' => 'The basic credentials that are required for the authentication of the user.
', 'SAPODataConnectorProfileCredentials$basicAuthCredentials' => 'The SAPOData basic authentication credentials.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AuthParameter$isRequired' => 'Indicates whether this authentication parameter is required.
', 'AuthParameter$isSensitiveField' => 'Indicates whether this authentication parameter is a sensitive field.
', 'AuthenticationConfig$isBasicAuthSupported' => 'Indicates whether basic authentication is supported by the connector.
', 'AuthenticationConfig$isApiKeyAuthSupported' => 'Indicates whether API key authentication is supported by the connector
', 'AuthenticationConfig$isOAuth2Supported' => 'Indicates whether OAuth 2.0 authentication is supported by the connector.
', 'AuthenticationConfig$isCustomAuthSupported' => 'Indicates whether custom authentication is supported by the connector
', 'ConnectorConfiguration$canUseAsSource' => 'Specifies whether the connector can be used as a source.
', 'ConnectorConfiguration$canUseAsDestination' => 'Specifies whether the connector can be used as a destination.
', 'ConnectorConfiguration$isPrivateLinkEnabled' => 'Specifies if PrivateLink is enabled for that connector.
', 'ConnectorConfiguration$isPrivateLinkEndpointUrlRequired' => 'Specifies if a PrivateLink endpoint URL is required.
', 'ConnectorEntity$hasNestedEntities' => ' Specifies whether the connector entity is a parent or a category and has more entities nested underneath it. If another call is made with entitiesPath = "the_current_entity_name_with_hasNestedEntities_true", then it returns the nested entities underneath it. This provides a way to retrieve all supported entities in a recursive fashion.
Booelan value that indicates whether this field can be used as a primary key.
', 'ConnectorEntityField$isDeprecated' => 'Booelan value that indicates whether this field is deprecated or not.
', 'ConnectorRuntimeSetting$isRequired' => 'Indicates whether this connector runtime setting is required.
', 'DeleteConnectorProfileRequest$forceDelete' => 'Indicates whether Amazon AppFlow should delete the profile, even if it is currently in use in one or more flows.
', 'DeleteFlowRequest$forceDelete' => 'Indicates whether Amazon AppFlow should delete the flow, even if it is currently in use.
', 'DestinationFieldProperties$isCreatable' => 'Specifies if the destination field can be created by the current user.
', 'DestinationFieldProperties$isNullable' => 'Specifies if the destination field can have a null value.
', 'DestinationFieldProperties$isUpsertable' => 'Specifies if the flow run can either insert new rows in the destination field if they do not already exist, or update them if they do.
', 'DestinationFieldProperties$isUpdatable' => ' Specifies whether the field can be updated during an UPDATE or UPSERT write operation.
Specifies whether the field can use the default value during a Create operation.
', 'ErrorHandlingConfig$failOnFirstDestinationError' => 'Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination.
', 'OAuth2CustomParameter$isRequired' => 'Indicates whether the custom parameter for OAuth 2.0 authentication is required.
', 'OAuth2CustomParameter$isSensitiveField' => 'Indicates whether this authentication custom parameter is a sensitive field.
', 'PardotConnectorProfileProperties$isSandboxEnvironment' => 'Indicates whether the connector profile applies to a sandbox or production environment.
', 'RedshiftConnectorProfileProperties$isRedshiftServerless' => 'Indicates whether the connector profile defines a connection to an Amazon Redshift Serverless data warehouse.
', 'SAPODataConnectorProfileProperties$disableSSO' => 'If you set this parameter to true, Amazon AppFlow bypasses the single sign-on (SSO) settings in your SAP account when it accesses your SAP OData instance.
Whether you need this option depends on the types of credentials that you applied to your SAP OData connection profile. If your profile uses basic authentication credentials, SAP SSO can prevent Amazon AppFlow from connecting to your account with your username and password. In this case, bypassing SSO makes it possible for Amazon AppFlow to connect successfully. However, if your profile uses OAuth credentials, this parameter has no affect.
', 'SalesforceConnectorProfileProperties$isSandboxEnvironment' => 'Indicates whether the connector profile applies to a sandbox or production environment.
', 'SalesforceConnectorProfileProperties$usePrivateLinkForMetadataAndAuthorization' => 'If the connection mode for the connector profile is private, this parameter sets whether Amazon AppFlow uses the private network to send metadata and authorization calls to Salesforce. Amazon AppFlow sends private calls through Amazon Web Services PrivateLink. These calls travel through Amazon Web Services infrastructure without being exposed to the public internet.
Set either of the following values:
Amazon AppFlow sends all calls to Salesforce over the private network.
These private calls are:
Calls to get metadata about your Salesforce records. This metadata describes your Salesforce objects and their fields.
Calls to get or refresh access tokens that allow Amazon AppFlow to access your Salesforce records.
Calls to transfer your Salesforce records as part of a flow run.
The default value. Amazon AppFlow sends some calls to Salesforce privately and other calls over the public internet.
The public calls are:
Calls to get metadata about your Salesforce records.
Calls to get or refresh access tokens.
The private calls are:
Calls to transfer your Salesforce records as part of a flow run.
The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.
', 'SalesforceSourceProperties$includeDeletedRecords' => 'Indicates whether Amazon AppFlow includes deleted files in the flow run.
', 'SourceFieldProperties$isRetrievable' => 'Indicates whether the field can be returned in a search result.
', 'SourceFieldProperties$isQueryable' => 'Indicates if the field can be queried.
', 'SourceFieldProperties$isTimestampFieldForIncrementalQueries' => 'Indicates if this timestamp field can be used for incremental queries.
', 'UnregisterConnectorRequest$forceDelete' => 'Indicates whether Amazon AppFlow should unregister the connector, even if it is currently in use in one or more connector profiles. The default value is false.
', 'VeevaSourceProperties$includeSourceFiles' => 'Boolean value to include source files in Veeva document extract flow.
', 'VeevaSourceProperties$includeRenditions' => 'Boolean value to include file renditions in Veeva document extract flow.
', 'VeevaSourceProperties$includeAllVersions' => 'Boolean value to include All Versions of files in Veeva document extract flow.
', ], ], 'BucketName' => [ 'base' => NULL, 'refs' => [ 'ErrorHandlingConfig$bucketName' => 'Specifies the name of the Amazon S3 bucket.
', 'RedshiftConnectorProfileProperties$bucketName' => 'A name for the associated Amazon S3 bucket.
', 'RedshiftDestinationProperties$intermediateBucketName' => 'The intermediate bucket that Amazon AppFlow uses when moving data into Amazon Redshift.
', 'S3DestinationProperties$bucketName' => 'The Amazon S3 bucket name in which Amazon AppFlow places the transferred data.
', 'S3SourceProperties$bucketName' => 'The Amazon S3 bucket name where the source files are stored.
', 'SnowflakeConnectorProfileProperties$bucketName' => 'The name of the Amazon S3 bucket associated with Snowflake.
', 'SnowflakeDestinationProperties$intermediateBucketName' => 'The intermediate bucket that Amazon AppFlow uses when moving data into Snowflake.
', 'SuccessResponseHandlingConfig$bucketName' => 'The name of the Amazon S3 bucket.
', ], ], 'BucketPrefix' => [ 'base' => NULL, 'refs' => [ 'ErrorHandlingConfig$bucketPrefix' => 'Specifies the Amazon S3 bucket prefix.
', 'RedshiftConnectorProfileProperties$bucketPrefix' => 'The object key for the destination bucket in which Amazon AppFlow places the files.
', 'RedshiftDestinationProperties$bucketPrefix' => 'The object key for the bucket in which Amazon AppFlow places the destination files.
', 'S3DestinationProperties$bucketPrefix' => 'The object key for the destination bucket in which Amazon AppFlow places the files.
', 'S3SourceProperties$bucketPrefix' => 'The object key for the Amazon S3 bucket in which the source files are stored.
', 'SnowflakeConnectorProfileProperties$bucketPrefix' => 'The bucket path that refers to the Amazon S3 bucket associated with Snowflake.
', 'SnowflakeDestinationProperties$bucketPrefix' => 'The object key for the destination bucket in which Amazon AppFlow places the files.
', 'SuccessResponseHandlingConfig$bucketPrefix' => 'The Amazon S3 bucket prefix.
', 'UpsolverDestinationProperties$bucketPrefix' => 'The object key for the destination Upsolver Amazon S3 bucket in which Amazon AppFlow places the files.
', ], ], 'BusinessUnitId' => [ 'base' => NULL, 'refs' => [ 'PardotConnectorProfileProperties$businessUnitId' => 'The business unit id of Salesforce Pardot instance.
', ], ], 'CancelFlowExecutionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelFlowExecutionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'CatalogType' => [ 'base' => NULL, 'refs' => [ 'MetadataCatalogDetail$catalogType' => 'The type of metadata catalog that Amazon AppFlow used for the associated flow run. This parameter returns the following value:
The metadata catalog is provided by the Glue Data Catalog. Glue includes the Glue Data Catalog as a component.
The secret manager ARN, which contains the client ID and client secret of the connected app.
', 'SalesforceConnectorProfileCredentials$clientCredentialsArn' => 'The secret manager ARN, which contains the client ID and client secret of the connected app.
', ], ], 'ClientId' => [ 'base' => NULL, 'refs' => [ 'GoogleAnalyticsConnectorProfileCredentials$clientId' => 'The identifier for the desired client.
', 'MarketoConnectorProfileCredentials$clientId' => 'The identifier for the desired client.
', 'OAuth2Credentials$clientId' => 'The identifier for the desired client.
', 'OAuthCredentials$clientId' => 'The identifier for the desired client.
', 'SlackConnectorProfileCredentials$clientId' => 'The identifier for the client.
', 'ZendeskConnectorProfileCredentials$clientId' => 'The identifier for the desired client.
', ], ], 'ClientNumber' => [ 'base' => NULL, 'refs' => [ 'SAPODataConnectorProfileProperties$clientNumber' => 'The client number for the client creating the connection.
', ], ], 'ClientSecret' => [ 'base' => NULL, 'refs' => [ 'GoogleAnalyticsConnectorProfileCredentials$clientSecret' => 'The client secret used by the OAuth client to authenticate to the authorization server.
', 'MarketoConnectorProfileCredentials$clientSecret' => 'The client secret used by the OAuth client to authenticate to the authorization server.
', 'OAuth2Credentials$clientSecret' => 'The client secret used by the OAuth client to authenticate to the authorization server.
', 'OAuthCredentials$clientSecret' => 'The client secret used by the OAuth client to authenticate to the authorization server.
', 'SlackConnectorProfileCredentials$clientSecret' => 'The client secret used by the OAuth client to authenticate to the authorization server.
', 'ZendeskConnectorProfileCredentials$clientSecret' => 'The client secret used by the OAuth client to authenticate to the authorization server.
', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateConnectorProfileRequest$clientToken' => 'The clientToken parameter is an idempotency token. It ensures that your CreateConnectorProfile 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 clientToken parameter value.
If you omit a clientToken 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 clientToken, Amazon AppFlow considers it a new call to CreateConnectorProfile. The token is active for 8 hours.
The clientToken parameter is an idempotency token. It ensures that your CreateFlow 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 clientToken parameter value.
If you omit a clientToken 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 clientToken, Amazon AppFlow considers it a new call to CreateFlow. The token is active for 8 hours.
The clientToken parameter is an idempotency token. It ensures that your RegisterConnector 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 clientToken parameter value.
If you omit a clientToken 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 clientToken, Amazon AppFlow considers it a new call to RegisterConnector. The token is active for 8 hours.
The clientToken parameter is an idempotency token. It ensures that your StartFlow 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 clientToken parameter value.
If you omit a clientToken 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 for flows that run on a schedule or based on an event. However, the error doesn\'t occur for flows that run on demand. You set the conditions that initiate your flow for the triggerConfig parameter.
If you use a different value for clientToken, Amazon AppFlow considers it a new call to StartFlow. The token is active for 8 hours.
The clientToken parameter is an idempotency token. It ensures that your UpdateConnectorProfile 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 clientToken parameter value.
If you omit a clientToken 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 clientToken, Amazon AppFlow considers it a new call to UpdateConnectorProfile. The token is active for 8 hours.
The clientToken parameter is an idempotency token. It ensures that your UpdateConnectorRegistration 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 clientToken parameter value.
If you omit a clientToken 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 clientToken, Amazon AppFlow considers it a new call to UpdateConnectorRegistration. The token is active for 8 hours.
The clientToken parameter is an idempotency token. It ensures that your UpdateFlow 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 clientToken parameter value.
If you omit a clientToken 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 clientToken, Amazon AppFlow considers it a new call to UpdateFlow. The token is active for 8 hours.
The unique ID that\'s assigned to an Amazon Redshift cluster.
', ], ], 'ConflictException' => [ 'base' => '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.
', 'refs' => [], ], 'ConnectionMode' => [ 'base' => NULL, 'refs' => [ 'ConnectorProfile$connectionMode' => 'Indicates the connection mode and if it is public or private.
', 'CreateConnectorProfileRequest$connectionMode' => '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.
', 'UpdateConnectorProfileRequest$connectionMode' => 'Indicates the connection mode and if it is public or private.
', ], ], 'ConnectorAuthenticationException' => [ 'base' => 'An error occurred when authenticating with the connector endpoint.
', 'refs' => [], ], 'ConnectorConfiguration' => [ 'base' => 'The configuration settings related to a given connector.
', 'refs' => [ 'ConnectorConfigurationsMap$value' => NULL, 'DescribeConnectorResponse$connectorConfiguration' => 'Configuration info of all the connectors that the user requested.
', ], ], 'ConnectorConfigurationsMap' => [ 'base' => NULL, 'refs' => [ 'DescribeConnectorsResponse$connectorConfigurations' => 'The configuration that is applied to the connectors used in the flow.
', ], ], 'ConnectorDescription' => [ 'base' => NULL, 'refs' => [ 'ConnectorConfiguration$connectorDescription' => 'A description about the connector.
', 'ConnectorDetail$connectorDescription' => 'A description about the registered connector.
', ], ], 'ConnectorDetail' => [ 'base' => 'Information about the registered connector.
', 'refs' => [ 'ConnectorList$member' => NULL, ], ], 'ConnectorEntity' => [ 'base' => 'The high-level entity that can be queried in Amazon AppFlow. For example, a Salesforce entity might be an Account or Opportunity, whereas a ServiceNow entity might be an Incident.
', 'refs' => [ 'ConnectorEntityList$member' => NULL, ], ], 'ConnectorEntityField' => [ 'base' => 'Describes the data model of a connector field. For example, for an account entity, the fields would be account name, account ID, and so on.
', 'refs' => [ 'ConnectorEntityFieldList$member' => NULL, ], ], 'ConnectorEntityFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeConnectorEntityResponse$connectorEntityFields' => 'Describes the fields for that connector entity. For example, for an account entity, the fields would be account name, account ID, and so on.
', ], ], 'ConnectorEntityList' => [ 'base' => NULL, 'refs' => [ 'ConnectorEntityMap$value' => NULL, ], ], 'ConnectorEntityMap' => [ 'base' => NULL, 'refs' => [ 'ListConnectorEntitiesResponse$connectorEntityMap' => ' The response of ListConnectorEntities lists entities grouped by category. This map\'s key represents the group name, and its value contains the list of entities belonging to that group.
The label used for registering the connector.
', 'ConnectorDetail$connectorLabel' => 'A label used for the connector.
', 'ConnectorProfile$connectorLabel' => 'The label for the connector profile being created.
', 'CreateConnectorProfileRequest$connectorLabel' => 'The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
The label of the source connector in the flow.
', 'FlowDefinition$destinationConnectorLabel' => 'The label of the destination connector in the flow.
', 'RegisterConnectorRequest$connectorLabel' => ' The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web Services account.
The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web Services account.
The name of the connector. The name is unique for each connector registration in your AWS account.
', ], ], 'ConnectorList' => [ 'base' => NULL, 'refs' => [ 'DescribeConnectorsResponse$connectors' => 'Information about the connectors supported in Amazon AppFlow.
', 'ListConnectorsResponse$connectors' => 'Contains information about the connectors supported by Amazon AppFlow.
', ], ], 'ConnectorMetadata' => [ 'base' => ' A structure to specify connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on.
Specifies connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on.
The connection modes that the connector supports.
', 'ConnectorDetail$connectorModes' => 'The connection mode that the connector supports.
', ], ], 'ConnectorName' => [ 'base' => NULL, 'refs' => [ 'ConnectorConfiguration$connectorName' => 'The connector name.
', 'ConnectorDetail$connectorName' => 'The name of the connector.
', ], ], 'ConnectorOAuthRequest' => [ 'base' => 'Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
', 'refs' => [ 'GoogleAnalyticsConnectorProfileCredentials$oAuthRequest' => 'The OAuth requirement needed to request security tokens from the connector endpoint.
', 'HoneycodeConnectorProfileCredentials$oAuthRequest' => NULL, 'MarketoConnectorProfileCredentials$oAuthRequest' => 'The OAuth requirement needed to request security tokens from the connector endpoint.
', 'OAuth2Credentials$oAuthRequest' => NULL, 'OAuthCredentials$oAuthRequest' => 'The OAuth requirement needed to request security tokens from the connector endpoint.
', 'PardotConnectorProfileCredentials$oAuthRequest' => NULL, 'SalesforceConnectorProfileCredentials$oAuthRequest' => 'The OAuth requirement needed to request security tokens from the connector endpoint.
', 'SlackConnectorProfileCredentials$oAuthRequest' => 'The OAuth requirement needed to request security tokens from the connector endpoint.
', 'ZendeskConnectorProfileCredentials$oAuthRequest' => 'The OAuth requirement needed to request security tokens from the connector endpoint.
', ], ], 'ConnectorOperator' => [ 'base' => 'The operation to be performed on the provided source fields.
', 'refs' => [ 'Task$connectorOperator' => 'The operation to be performed on the provided source fields.
', ], ], 'ConnectorOwner' => [ 'base' => NULL, 'refs' => [ 'ConnectorConfiguration$connectorOwner' => 'The owner who developed the connector.
', 'ConnectorDetail$connectorOwner' => 'The owner of the connector.
', ], ], 'ConnectorProfile' => [ 'base' => ' Describes an instance of a connector. This includes the provided name, credentials ARN, connection-mode, and so on. To keep the API intuitive and extensible, the fields that are common to all types of connector profiles are explicitly specified at the top level. The rest of the connector-specific properties are available via the connectorProfileProperties field.
The Amazon Resource Name (ARN) of the connector profile.
', 'CreateConnectorProfileResponse$connectorProfileArn' => 'The Amazon Resource Name (ARN) of the connector profile.
', 'UpdateConnectorProfileResponse$connectorProfileArn' => 'The Amazon Resource Name (ARN) of the connector profile.
', ], ], 'ConnectorProfileConfig' => [ 'base' => 'Defines the connector-specific configuration and credentials for the connector profile.
', 'refs' => [ 'CreateConnectorProfileRequest$connectorProfileConfig' => 'Defines the connector-specific configuration and credentials.
', 'UpdateConnectorProfileRequest$connectorProfileConfig' => 'Defines the connector-specific profile configuration and credentials.
', ], ], 'ConnectorProfileCredentials' => [ 'base' => 'The connector-specific credentials required by a connector.
', 'refs' => [ 'ConnectorProfileConfig$connectorProfileCredentials' => 'The connector-specific credentials required by each connector.
', ], ], 'ConnectorProfileDetailList' => [ 'base' => NULL, 'refs' => [ 'DescribeConnectorProfilesResponse$connectorProfileDetails' => 'Returns information about the connector profiles associated with the flow.
', ], ], 'ConnectorProfileName' => [ 'base' => NULL, 'refs' => [ 'ConnectorProfile$connectorProfileName' => ' The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account.
The name of the connector profile. The name is unique for each ConnectorProfile in your Amazon Web Services account.
The name of the connector profile. The name is unique for each ConnectorProfile in your account.
The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account.
The name of the connector profile. This name must be unique for each connector profile in the Amazon Web Services account.
', 'ListConnectorEntitiesRequest$connectorProfileName' => ' The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account, and is used to query the downstream connector.
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.
', 'SourceFlowConfig$connectorProfileName' => 'The name of the connector profile. This name must be unique for each connector profile in the Amazon Web Services account.
', 'UpdateConnectorProfileRequest$connectorProfileName' => ' The name of the connector profile and is unique for each ConnectorProfile in the Amazon Web Services account.
The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account.
The connector-specific profile properties required by each connector.
', 'refs' => [ 'ConnectorProfile$connectorProfileProperties' => 'The connector-specific properties of the profile configuration.
', 'ConnectorProfileConfig$connectorProfileProperties' => 'The connector-specific properties of the profile configuration.
', ], ], 'ConnectorProvisioningConfig' => [ 'base' => 'Contains information about the configuration of the connector being registered.
', 'refs' => [ 'ConnectorConfiguration$connectorProvisioningConfig' => 'The configuration required for registering the connector.
', 'RegisterConnectorRequest$connectorProvisioningConfig' => 'The provisioning type of the connector. Currently the only supported value is LAMBDA.
', 'UpdateConnectorRegistrationRequest$connectorProvisioningConfig' => NULL, ], ], 'ConnectorProvisioningType' => [ 'base' => 'The type of provisioning that the connector supports, such as Lambda.
', 'refs' => [ 'ConnectorConfiguration$connectorProvisioningType' => 'The provisioning type used to register the connector.
', 'ConnectorDetail$connectorProvisioningType' => 'The provisioning type that the connector uses.
', 'RegisterConnectorRequest$connectorProvisioningType' => 'The provisioning type of the connector. Currently the only supported value is LAMBDA.
', ], ], 'ConnectorRuntimeSetting' => [ 'base' => 'Contains information about the connector runtime settings that are required for flow execution.
', 'refs' => [ 'ConnectorRuntimeSettingList$member' => NULL, ], ], 'ConnectorRuntimeSettingDataType' => [ 'base' => NULL, 'refs' => [ 'ConnectorRuntimeSetting$dataType' => 'Data type of the connector runtime setting.
', ], ], 'ConnectorRuntimeSettingList' => [ 'base' => NULL, 'refs' => [ 'ConnectorConfiguration$connectorRuntimeSettings' => 'The required connector runtime settings.
', ], ], 'ConnectorRuntimeSettingScope' => [ 'base' => NULL, 'refs' => [ 'ConnectorRuntimeSetting$scope' => 'Indicates the scope of the connector runtime setting.
', ], ], 'ConnectorServerException' => [ 'base' => 'An error occurred when retrieving data from the connector endpoint.
', 'refs' => [], ], 'ConnectorSuppliedValue' => [ 'base' => NULL, 'refs' => [ 'ConnectorSuppliedValueList$member' => NULL, 'ConnectorSuppliedValueOptionList$member' => NULL, ], ], 'ConnectorSuppliedValueList' => [ 'base' => NULL, 'refs' => [ 'AuthParameter$connectorSuppliedValues' => 'Contains default values for this authentication parameter that are supplied by the connector.
', 'OAuth2CustomParameter$connectorSuppliedValues' => 'Contains default values for this authentication parameter that are supplied by the connector.
', ], ], 'ConnectorSuppliedValueOptionList' => [ 'base' => NULL, 'refs' => [ 'ConnectorRuntimeSetting$connectorSuppliedValueOptions' => 'Contains default values for the connector runtime setting that are supplied by the connector.
', ], ], 'ConnectorType' => [ 'base' => NULL, 'refs' => [ 'ConnectorConfiguration$connectorType' => 'The connector type.
', 'ConnectorConfigurationsMap$key' => NULL, 'ConnectorDetail$connectorType' => 'The connector type.
', 'ConnectorProfile$connectorType' => 'The type of connector, such as Salesforce, Amplitude, and so on.
', 'ConnectorTypeList$member' => NULL, 'CreateConnectorProfileRequest$connectorType' => 'The type of connector, such as Salesforce, Amplitude, and so on.
', 'DescribeConnectorEntityRequest$connectorType' => 'The type of connector application, such as Salesforce, Amplitude, and so on.
', 'DescribeConnectorProfilesRequest$connectorType' => 'The type of connector, such as Salesforce, Amplitude, and so on.
', 'DescribeConnectorRequest$connectorType' => 'The connector type, such as CUSTOMCONNECTOR, Saleforce, Marketo. Please choose CUSTOMCONNECTOR for Lambda based custom connectors.
', 'DestinationFlowConfig$connectorType' => 'The type of connector, such as Salesforce, Amplitude, and so on.
', 'FlowDefinition$sourceConnectorType' => 'Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
', 'FlowDefinition$destinationConnectorType' => 'Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
', 'ListConnectorEntitiesRequest$connectorType' => 'The type of connector, such as Salesforce, Amplitude, and so on.
', 'ResetConnectorMetadataCacheRequest$connectorType' => '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.
', 'SourceFlowConfig$connectorType' => 'The type of connector, such as Salesforce, Amplitude, and so on.
', ], ], 'ConnectorTypeList' => [ 'base' => NULL, 'refs' => [ 'ConnectorConfiguration$supportedDestinationConnectors' => 'Lists the connectors that are available for use as destinations.
', 'DescribeConnectorsRequest$connectorTypes' => 'The type of connector, such as Salesforce, Amplitude, and so on.
', ], ], 'ConnectorVersion' => [ 'base' => NULL, 'refs' => [ 'ConnectorConfiguration$connectorVersion' => 'The connector version.
', 'ConnectorDetail$connectorVersion' => 'The connector version.
', ], ], 'CreateConnectorProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateConnectorProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateFlowRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateFlowResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreatedBy' => [ 'base' => NULL, 'refs' => [ 'DescribeFlowResponse$createdBy' => 'The ARN of the user who created the flow.
', 'FlowDefinition$createdBy' => 'The ARN of the user who created the flow.
', ], ], 'CredentialsMap' => [ 'base' => NULL, 'refs' => [ 'CustomAuthCredentials$credentialsMap' => 'A map that holds custom authentication credentials.
', ], ], 'CredentialsMapKey' => [ 'base' => NULL, 'refs' => [ 'CredentialsMap$key' => NULL, ], ], 'CredentialsMapValue' => [ 'base' => NULL, 'refs' => [ 'CredentialsMap$value' => NULL, ], ], 'CustomAuthConfig' => [ 'base' => 'Configuration information required for custom authentication.
', 'refs' => [ 'CustomAuthConfigList$member' => NULL, ], ], 'CustomAuthConfigList' => [ 'base' => NULL, 'refs' => [ 'AuthenticationConfig$customAuthConfigs' => 'Contains information required for custom authentication.
', ], ], 'CustomAuthCredentials' => [ 'base' => 'The custom credentials required for custom authentication.
', 'refs' => [ 'CustomConnectorProfileCredentials$custom' => 'If the connector uses the custom authentication mechanism, this holds the required credentials.
', ], ], 'CustomAuthenticationType' => [ 'base' => NULL, 'refs' => [ 'CustomAuthConfig$customAuthenticationType' => 'The authentication type that the custom connector uses.
', 'CustomAuthCredentials$customAuthenticationType' => 'The custom authentication type that the connector uses.
', ], ], 'CustomConnectorDestinationProperties' => [ 'base' => 'The properties that are applied when the custom connector is being used as a destination.
', 'refs' => [ 'DestinationConnectorProperties$CustomConnector' => 'The properties that are required to query the custom Connector.
', ], ], 'CustomConnectorProfileCredentials' => [ 'base' => 'The connector-specific profile credentials that are required when using the custom connector.
', 'refs' => [ 'ConnectorProfileCredentials$CustomConnector' => NULL, ], ], 'CustomConnectorProfileProperties' => [ 'base' => 'The profile properties required by the custom connector.
', 'refs' => [ 'ConnectorProfileProperties$CustomConnector' => 'The properties required by the custom connector.
', ], ], 'CustomConnectorSourceProperties' => [ 'base' => 'The properties that are applied when the custom connector is being used as a source.
', 'refs' => [ 'SourceConnectorProperties$CustomConnector' => NULL, ], ], 'CustomProperties' => [ 'base' => NULL, 'refs' => [ 'ConnectorEntityField$customProperties' => 'A map that has specific properties related to the ConnectorEntityField.
', 'CustomConnectorDestinationProperties$customProperties' => 'The custom properties that are specific to the connector when it\'s used as a destination in the flow.
', 'CustomConnectorSourceProperties$customProperties' => 'Custom properties that are required to use the custom connector as a source.
', ], ], 'CustomPropertyKey' => [ 'base' => NULL, 'refs' => [ 'CustomProperties$key' => NULL, 'TokenUrlCustomProperties$key' => NULL, ], ], 'CustomPropertyValue' => [ 'base' => NULL, 'refs' => [ 'CustomProperties$value' => NULL, 'TokenUrlCustomProperties$value' => NULL, ], ], 'CustomerProfilesDestinationProperties' => [ 'base' => 'The properties that are applied when Amazon Connect Customer Profiles is used as a destination.
', 'refs' => [ 'DestinationConnectorProperties$CustomerProfiles' => 'The properties required to query Amazon Connect Customer Profiles.
', ], ], 'CustomerProfilesMetadata' => [ 'base' => 'The connector metadata specific to Amazon Connect Customer Profiles.
', 'refs' => [ 'ConnectorMetadata$CustomerProfiles' => 'The connector metadata specific to Amazon Connect Customer Profiles.
', ], ], 'DataApiRoleArn' => [ 'base' => NULL, 'refs' => [ 'RedshiftConnectorProfileProperties$dataApiRoleArn' => 'The Amazon Resource Name (ARN) of an IAM role that permits Amazon AppFlow to access your Amazon Redshift database through the Data API. For more information, and for the polices that you attach to this role, see Allow Amazon AppFlow to access Amazon Redshift databases with the Data API.
', ], ], 'DataPullMode' => [ 'base' => NULL, 'refs' => [ 'ScheduledTriggerProperties$dataPullMode' => 'Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
', ], ], 'DataTransferApi' => [ 'base' => 'The API of the connector application that Amazon AppFlow uses to transfer your data.
', 'refs' => [ 'CustomConnectorSourceProperties$dataTransferApi' => 'The API of the connector application that Amazon AppFlow uses to transfer your data.
', 'SupportedDataTransferApis$member' => NULL, ], ], 'DataTransferApiType' => [ 'base' => NULL, 'refs' => [ 'DataTransferApi$Type' => 'You can specify one of the following types:
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.
A synchronous API. This type of API optimizes a flow for small to medium-sized datasets.
An asynchronous API. This type of API optimizes a flow for large datasets.
The name of the connector application API.
', ], ], 'DatabaseName' => [ 'base' => NULL, 'refs' => [ 'RedshiftConnectorProfileProperties$databaseName' => 'The name of an Amazon Redshift database.
', ], ], 'DatabaseUrl' => [ 'base' => NULL, 'refs' => [ 'RedshiftConnectorProfileProperties$databaseUrl' => 'The JDBC URL of the Amazon Redshift cluster.
', ], ], 'DatadogConnectorOperator' => [ 'base' => NULL, 'refs' => [ 'ConnectorOperator$Datadog' => 'The operation to be performed on the provided Datadog source fields.
', ], ], 'DatadogConnectorProfileCredentials' => [ 'base' => 'The connector-specific credentials required by Datadog.
', 'refs' => [ 'ConnectorProfileCredentials$Datadog' => 'The connector-specific credentials required when using Datadog.
', ], ], 'DatadogConnectorProfileProperties' => [ 'base' => 'The connector-specific profile properties required by Datadog.
', 'refs' => [ 'ConnectorProfileProperties$Datadog' => 'The connector-specific properties required by Datadog.
', ], ], 'DatadogMetadata' => [ 'base' => 'The connector metadata specific to Datadog.
', 'refs' => [ 'ConnectorMetadata$Datadog' => 'The connector metadata specific to Datadog.
', ], ], 'DatadogSourceProperties' => [ 'base' => 'The properties that are applied when Datadog is being used as a source.
', 'refs' => [ 'SourceConnectorProperties$Datadog' => 'Specifies the information that is required for querying Datadog.
', ], ], 'Date' => [ 'base' => NULL, 'refs' => [ 'ConnectorConfiguration$registeredAt' => 'The date on which the connector was registered.
', 'ConnectorDetail$registeredAt' => 'The time at which the connector was registered.
', 'ConnectorProfile$createdAt' => 'Specifies when the connector profile was created.
', 'ConnectorProfile$lastUpdatedAt' => 'Specifies when the connector profile was last updated.
', 'DescribeFlowResponse$createdAt' => 'Specifies when the flow was created.
', 'DescribeFlowResponse$lastUpdatedAt' => 'Specifies when the flow was last updated.
', 'ExecutionDetails$mostRecentExecutionTime' => 'Specifies the time of the most recent flow run.
', 'ExecutionRecord$startedAt' => 'Specifies the start time of the flow run.
', 'ExecutionRecord$lastUpdatedAt' => 'Specifies the time of the most recent update.
', 'ExecutionRecord$dataPullStartTime' => 'The timestamp that determines the first new or updated record to be transferred in the flow run.
', 'ExecutionRecord$dataPullEndTime' => 'The timestamp that indicates the last new or updated record to be transferred in the flow run.
', 'FlowDefinition$createdAt' => 'Specifies when the flow was created.
', 'FlowDefinition$lastUpdatedAt' => 'Specifies when the flow was last updated.
', 'ScheduledTriggerProperties$scheduleStartTime' => 'The time at which the scheduled flow starts. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-26T13:00:00-07:00.
The time at which the scheduled flow ends. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-27T13:00:00-07:00.
Specifies the date range for the records to import from the connector in the first flow run.
', ], ], 'DatetimeTypeFieldName' => [ 'base' => NULL, 'refs' => [ 'IncrementalPullConfig$datetimeTypeFieldName' => 'A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.
', ], ], 'DeleteConnectorProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConnectorProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFlowRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFlowResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConnectorEntityRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConnectorEntityResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConnectorProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConnectorProfilesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConnectorResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConnectorsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConnectorsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFlowExecutionRecordsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFlowExecutionRecordsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFlowRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeFlowResponse' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'AuthParameter$description' => 'A description about the authentication parameter.
', 'ConnectorEntityField$description' => 'A description of the connector entity field.
', 'ConnectorRuntimeSetting$description' => 'A description about the connector runtime setting.
', 'OAuth2CustomParameter$description' => 'A description about the custom parameter used for OAuth 2.0 authentication.
', 'RegisterConnectorRequest$description' => 'A description about the connector that\'s being registered.
', 'UpdateConnectorRegistrationRequest$description' => 'A description about the update that you\'re applying to the connector.
', ], ], 'DestinationConnectorProperties' => [ 'base' => 'This stores the information that is required to query a particular connector.
', 'refs' => [ 'DestinationFlowConfig$destinationConnectorProperties' => 'This stores the information that is required to query a particular connector.
', ], ], 'DestinationField' => [ 'base' => NULL, 'refs' => [ 'Task$destinationField' => 'A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.
', ], ], 'DestinationFieldProperties' => [ 'base' => 'The properties that can be applied to a field when connector is being used as a destination.
', 'refs' => [ 'ConnectorEntityField$destinationProperties' => 'The properties applied to a field when the connector is being used as a destination.
', ], ], 'DestinationFlowConfig' => [ 'base' => 'Contains information about the configuration of destination connectors present in the flow.
', 'refs' => [ 'DestinationFlowConfigList$member' => NULL, ], ], 'DestinationFlowConfigList' => [ 'base' => NULL, 'refs' => [ 'CreateFlowRequest$destinationFlowConfigList' => 'The configuration that controls how Amazon AppFlow places data in the destination connector.
', 'DescribeFlowResponse$destinationFlowConfigList' => 'The configuration that controls how Amazon AppFlow transfers data to the destination connector.
', 'UpdateFlowRequest$destinationFlowConfigList' => 'The configuration that controls how Amazon AppFlow transfers data to the destination connector.
', ], ], 'DocumentType' => [ 'base' => NULL, 'refs' => [ 'VeevaSourceProperties$documentType' => 'The document type specified in the Veeva document extract flow.
', ], ], 'DomainName' => [ 'base' => NULL, 'refs' => [ 'CustomerProfilesDestinationProperties$domainName' => 'The unique name of the Amazon Connect Customer Profiles domain.
', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'Range$maximum' => 'Maximum value supported by the field.
', 'Range$minimum' => 'Minimum value supported by the field.
', ], ], 'DynatraceConnectorOperator' => [ 'base' => NULL, 'refs' => [ 'ConnectorOperator$Dynatrace' => 'The operation to be performed on the provided Dynatrace source fields.
', ], ], 'DynatraceConnectorProfileCredentials' => [ 'base' => 'The connector-specific profile credentials required by Dynatrace.
', 'refs' => [ 'ConnectorProfileCredentials$Dynatrace' => 'The connector-specific credentials required when using Dynatrace.
', ], ], 'DynatraceConnectorProfileProperties' => [ 'base' => 'The connector-specific profile properties required by Dynatrace.
', 'refs' => [ 'ConnectorProfileProperties$Dynatrace' => 'The connector-specific properties required by Dynatrace.
', ], ], 'DynatraceMetadata' => [ 'base' => 'The connector metadata specific to Dynatrace.
', 'refs' => [ 'ConnectorMetadata$Dynatrace' => 'The connector metadata specific to Dynatrace.
', ], ], 'DynatraceSourceProperties' => [ 'base' => 'The properties that are applied when Dynatrace is being used as a source.
', 'refs' => [ 'SourceConnectorProperties$Dynatrace' => 'Specifies the information that is required for querying Dynatrace.
', ], ], 'EntitiesPath' => [ 'base' => NULL, 'refs' => [ 'ListConnectorEntitiesRequest$entitiesPath' => ' 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 entitiesPath 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.
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.
', ], ], 'EntityName' => [ 'base' => NULL, 'refs' => [ 'CustomConnectorDestinationProperties$entityName' => 'The entity specified in the custom connector as a destination in the flow.
', 'CustomConnectorSourceProperties$entityName' => 'The entity specified in the custom connector as a source in the flow.
', 'DescribeConnectorEntityRequest$connectorEntityName' => 'The entity name for that connector.
', 'ResetConnectorMetadataCacheRequest$connectorEntityName' => '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.
', ], ], 'ErrorHandlingConfig' => [ 'base' => ' The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.
The settings that determine how Amazon AppFlow handles an error when placing data in the custom connector as destination.
', 'EventBridgeDestinationProperties$errorHandlingConfig' => NULL, 'HoneycodeDestinationProperties$errorHandlingConfig' => NULL, 'MarketoDestinationProperties$errorHandlingConfig' => NULL, 'RedshiftDestinationProperties$errorHandlingConfig' => ' The settings that determine how Amazon AppFlow handles an error when placing data in the Amazon Redshift destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.
The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.
The settings that determine how Amazon AppFlow handles an error when placing data in the Snowflake destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.
Provides details in the event of a failed flow, including the failure count and the related error messages.
', 'refs' => [ 'ExecutionResult$errorInfo' => 'Provides any error message information related to the flow run.
', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'ConflictException$message' => NULL, 'ConnectorAuthenticationException$message' => NULL, 'ConnectorServerException$message' => NULL, 'InternalServerException$message' => NULL, 'ResourceNotFoundException$message' => NULL, 'ServiceQuotaExceededException$message' => NULL, 'ThrottlingException$message' => NULL, 'UnsupportedOperationException$message' => NULL, 'ValidationException$message' => NULL, ], ], 'EventBridgeDestinationProperties' => [ 'base' => 'The properties that are applied when Amazon EventBridge is being used as a destination.
', 'refs' => [ 'DestinationConnectorProperties$EventBridge' => 'The properties required to query Amazon EventBridge.
', ], ], 'EventBridgeMetadata' => [ 'base' => 'The connector metadata specific to Amazon EventBridge.
', 'refs' => [ 'ConnectorMetadata$EventBridge' => 'The connector metadata specific to Amazon EventBridge.
', ], ], 'ExecutionDetails' => [ 'base' => 'Describes the details of the flow run, including the timestamp, status, and message.
', 'refs' => [ 'DescribeFlowResponse$lastRunExecutionDetails' => 'Describes the details of the most recent flow run.
', 'FlowDefinition$lastRunExecutionDetails' => 'Describes the details of the most recent flow run.
', ], ], 'ExecutionId' => [ 'base' => NULL, 'refs' => [ 'ExecutionIds$member' => NULL, 'ExecutionRecord$executionId' => 'Specifies the identifier of the given flow run.
', 'StartFlowResponse$executionId' => 'Returns the internal execution ID of an on-demand flow when the flow is started. For scheduled or event-triggered flows, this value is null.
', ], ], 'ExecutionIds' => [ 'base' => NULL, 'refs' => [ 'CancelFlowExecutionsRequest$executionIds' => '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.
', 'CancelFlowExecutionsResponse$invalidExecutions' => 'The IDs of runs that Amazon AppFlow couldn\'t cancel. These runs might be ineligible for canceling because they haven\'t started yet or have already completed.
', ], ], 'ExecutionMessage' => [ 'base' => NULL, 'refs' => [ 'ErrorInfo$executionMessage' => 'Specifies the error message that appears if a flow fails.
', ], ], 'ExecutionRecord' => [ 'base' => 'Specifies information about the past flow run instances for a given flow.
', 'refs' => [ 'FlowExecutionList$member' => NULL, ], ], 'ExecutionResult' => [ 'base' => 'Specifies the end result of the flow run.
', 'refs' => [ 'ExecutionRecord$executionResult' => 'Describes the result of the given flow run.
', ], ], 'ExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'ExecutionDetails$mostRecentExecutionStatus' => 'Specifies the status of the most recent flow run.
', 'ExecutionRecord$executionStatus' => 'Specifies the flow run status and whether it is in progress, has completed successfully, or has failed.
', 'RegistrationOutput$status' => 'Indicates the status of the registration attempt from Amazon AppFlow.
', ], ], 'FieldType' => [ 'base' => NULL, 'refs' => [ 'FieldTypeDetails$fieldType' => 'The type of field, such as string, integer, date, and so on.
', ], ], 'FieldTypeDetails' => [ 'base' => 'Contains details regarding the supported field type and the operators that can be applied for filtering.
', 'refs' => [ 'SupportedFieldTypeDetails$v1' => ' The initial supported version for fieldType. If this is later changed to a different version, v2 will be introduced.
Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket.
', 'UpsolverS3OutputFormatConfig$fileType' => 'Indicates the file type that Amazon AppFlow places in the Upsolver Amazon S3 bucket.
', ], ], 'FilterOperatorList' => [ 'base' => NULL, 'refs' => [ 'FieldTypeDetails$filterOperators' => 'The list of operators supported by a field.
', ], ], 'FlowArn' => [ 'base' => NULL, 'refs' => [ 'CreateFlowResponse$flowArn' => 'The flow\'s Amazon Resource Name (ARN).
', 'DescribeFlowResponse$flowArn' => 'The flow\'s Amazon Resource Name (ARN).
', 'FlowDefinition$flowArn' => 'The flow\'s Amazon Resource Name (ARN).
', 'StartFlowResponse$flowArn' => 'The flow\'s Amazon Resource Name (ARN).
', 'StopFlowResponse$flowArn' => 'The flow\'s Amazon Resource Name (ARN).
', ], ], 'FlowDefinition' => [ 'base' => 'The properties of the flow, such as its source, destination, trigger type, and so on.
', 'refs' => [ 'FlowList$member' => NULL, ], ], 'FlowDescription' => [ 'base' => NULL, 'refs' => [ 'CreateFlowRequest$description' => 'A description of the flow you want to create.
', 'DescribeFlowResponse$description' => 'A description of the flow.
', 'FlowDefinition$description' => 'A user-entered description of the flow.
', 'UpdateFlowRequest$description' => 'A description of the flow.
', ], ], 'FlowErrorDeactivationThreshold' => [ 'base' => NULL, 'refs' => [ 'ScheduledTriggerProperties$flowErrorDeactivationThreshold' => 'Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.
', ], ], 'FlowExecutionList' => [ 'base' => NULL, 'refs' => [ 'DescribeFlowExecutionRecordsResponse$flowExecutions' => 'Returns a list of all instances when this flow was run.
', ], ], 'FlowList' => [ 'base' => NULL, 'refs' => [ 'ListFlowsResponse$flows' => 'The list of flows associated with your account.
', ], ], 'FlowName' => [ 'base' => NULL, 'refs' => [ 'CancelFlowExecutionsRequest$flowName' => 'The name of a flow with active runs that you want to cancel.
', 'CreateFlowRequest$flowName' => 'The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
', 'DeleteFlowRequest$flowName' => 'The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
', 'DescribeFlowExecutionRecordsRequest$flowName' => 'The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
', 'DescribeFlowRequest$flowName' => 'The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
', 'DescribeFlowResponse$flowName' => 'The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
', 'FlowDefinition$flowName' => 'The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
', 'StartFlowRequest$flowName' => 'The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
', 'StopFlowRequest$flowName' => 'The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
', 'UpdateFlowRequest$flowName' => 'The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
', ], ], 'FlowStatus' => [ 'base' => NULL, 'refs' => [ 'CreateFlowResponse$flowStatus' => 'Indicates the current status of the flow.
', 'DescribeFlowResponse$flowStatus' => 'Indicates the current status of the flow.
', 'FlowDefinition$flowStatus' => 'Indicates the current status of the flow.
', 'StartFlowResponse$flowStatus' => 'Indicates the current status of the flow.
', 'StopFlowResponse$flowStatus' => 'Indicates the current status of the flow.
', 'UpdateFlowResponse$flowStatus' => 'Indicates the current status of the flow.
', ], ], 'FlowStatusMessage' => [ 'base' => NULL, 'refs' => [ 'DescribeFlowResponse$flowStatusMessage' => 'Contains an error message if the flow status is in a suspended or error state. This applies only to scheduled or event-triggered flows.
', ], ], 'GlueDataCatalogConfig' => [ 'base' => 'Specifies the configuration that Amazon AppFlow uses when it catalogs your data with the Glue Data Catalog. When Amazon AppFlow catalogs your data, it stores metadata in Data Catalog tables. This metadata represents the data that\'s transferred by the flow that you configure with these settings.
You can configure a flow with these settings only when the flow destination is Amazon S3.
Specifies the configuration that Amazon AppFlow uses when it catalogs your data with the Glue Data Catalog.
', ], ], 'GlueDataCatalogDatabaseName' => [ 'base' => NULL, 'refs' => [ 'GlueDataCatalogConfig$databaseName' => 'The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your Amazon Web Services account. These tables contain metadata for the data that\'s transferred by the flow that you configure with this parameter.
When you configure a new flow with this parameter, you must specify an existing database.
The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to create Data Catalog tables, databases, and partitions.
For an example IAM policy that has the required permissions, see Identity-based policy examples for Amazon AppFlow.
', ], ], 'GlueDataCatalogTablePrefix' => [ 'base' => NULL, 'refs' => [ 'GlueDataCatalogConfig$tablePrefix' => 'A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure with this setting. Amazon AppFlow adds the prefix to the beginning of the each table name.
', ], ], 'GoogleAnalyticsConnectorOperator' => [ 'base' => NULL, 'refs' => [ 'ConnectorOperator$GoogleAnalytics' => 'The operation to be performed on the provided Google Analytics source fields.
', ], ], 'GoogleAnalyticsConnectorProfileCredentials' => [ 'base' => 'The connector-specific profile credentials required by Google Analytics.
', 'refs' => [ 'ConnectorProfileCredentials$GoogleAnalytics' => 'The connector-specific credentials required when using Google Analytics.
', ], ], 'GoogleAnalyticsConnectorProfileProperties' => [ 'base' => 'The connector-specific profile properties required by Google Analytics.
', 'refs' => [ 'ConnectorProfileProperties$GoogleAnalytics' => 'The connector-specific properties required Google Analytics.
', ], ], 'GoogleAnalyticsMetadata' => [ 'base' => 'The connector metadata specific to Google Analytics.
', 'refs' => [ 'ConnectorMetadata$GoogleAnalytics' => 'The connector metadata specific to Google Analytics.
', ], ], 'GoogleAnalyticsSourceProperties' => [ 'base' => 'The properties that are applied when Google Analytics is being used as a source.
', 'refs' => [ 'SourceConnectorProperties$GoogleAnalytics' => 'Specifies the information that is required for querying Google Analytics.
', ], ], 'Group' => [ 'base' => NULL, 'refs' => [ 'ConnectorEntityMap$key' => NULL, ], ], 'HoneycodeConnectorProfileCredentials' => [ 'base' => 'The connector-specific credentials required when using Amazon Honeycode.
', 'refs' => [ 'ConnectorProfileCredentials$Honeycode' => 'The connector-specific credentials required when using Amazon Honeycode.
', ], ], 'HoneycodeConnectorProfileProperties' => [ 'base' => 'The connector-specific properties required when using Amazon Honeycode.
', 'refs' => [ 'ConnectorProfileProperties$Honeycode' => 'The connector-specific properties required by Amazon Honeycode.
', ], ], 'HoneycodeDestinationProperties' => [ 'base' => 'The properties that are applied when Amazon Honeycode is used as a destination.
', 'refs' => [ 'DestinationConnectorProperties$Honeycode' => 'The properties required to query Amazon Honeycode.
', ], ], 'HoneycodeMetadata' => [ 'base' => 'The connector metadata specific to Amazon Honeycode.
', 'refs' => [ 'ConnectorMetadata$Honeycode' => 'The connector metadata specific to Amazon Honeycode.
', ], ], 'IdFieldNameList' => [ 'base' => 'A list of field names that can be used as an ID field when performing a write operation.
', 'refs' => [ 'CustomConnectorDestinationProperties$idFieldNames' => 'The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update, delete, or upsert.
', 'SAPODataDestinationProperties$idFieldNames' => NULL, 'SalesforceDestinationProperties$idFieldNames' => 'The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update or delete.
', 'ZendeskDestinationProperties$idFieldNames' => NULL, ], ], 'Identifier' => [ 'base' => NULL, 'refs' => [ 'ConnectorEntityField$identifier' => 'The unique identifier of the connector field.
', 'ConnectorEntityField$parentIdentifier' => 'The parent identifier of the connector field.
', ], ], 'IncrementalPullConfig' => [ 'base' => 'Specifies the configuration used when importing incremental records from the source.
', 'refs' => [ 'SourceFlowConfig$incrementalPullConfig' => '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.
', ], ], 'InforNexusConnectorOperator' => [ 'base' => NULL, 'refs' => [ 'ConnectorOperator$InforNexus' => 'The operation to be performed on the provided Infor Nexus source fields.
', ], ], 'InforNexusConnectorProfileCredentials' => [ 'base' => 'The connector-specific profile credentials required by Infor Nexus.
', 'refs' => [ 'ConnectorProfileCredentials$InforNexus' => 'The connector-specific credentials required when using Infor Nexus.
', ], ], 'InforNexusConnectorProfileProperties' => [ 'base' => 'The connector-specific profile properties required by Infor Nexus.
', 'refs' => [ 'ConnectorProfileProperties$InforNexus' => 'The connector-specific properties required by Infor Nexus.
', ], ], 'InforNexusMetadata' => [ 'base' => 'The connector metadata specific to Infor Nexus.
', 'refs' => [ 'ConnectorMetadata$InforNexus' => 'The connector metadata specific to Infor Nexus.
', ], ], 'InforNexusSourceProperties' => [ 'base' => 'The properties that are applied when Infor Nexus is being used as a source.
', 'refs' => [ 'SourceConnectorProperties$InforNexus' => 'Specifies the information that is required for querying Infor Nexus.
', ], ], 'InstanceUrl' => [ 'base' => NULL, 'refs' => [ 'DatadogConnectorProfileProperties$instanceUrl' => 'The location of the Datadog resource.
', 'DynatraceConnectorProfileProperties$instanceUrl' => 'The location of the Dynatrace resource.
', 'InforNexusConnectorProfileProperties$instanceUrl' => 'The location of the Infor Nexus resource.
', 'MarketoConnectorProfileProperties$instanceUrl' => 'The location of the Marketo resource.
', 'PardotConnectorProfileProperties$instanceUrl' => 'The location of the Salesforce Pardot resource.
', 'SalesforceConnectorProfileProperties$instanceUrl' => 'The location of the Salesforce resource.
', 'ServiceNowConnectorProfileProperties$instanceUrl' => 'The location of the ServiceNow resource.
', 'SlackConnectorProfileProperties$instanceUrl' => 'The location of the Slack resource.
', 'VeevaConnectorProfileProperties$instanceUrl' => 'The location of the Veeva resource.
', 'ZendeskConnectorProfileProperties$instanceUrl' => 'The location of the Zendesk resource.
', ], ], 'InternalServerException' => [ 'base' => 'An internal service error occurred during the processing of your request. Try again later.
', 'refs' => [], ], 'JavaBoolean' => [ 'base' => NULL, 'refs' => [ 'S3OutputFormatConfig$preserveSourceDataTyping' => '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.
true: Amazon AppFlow preserves the data types when it writes to Amazon S3. For example, an integer or 1 in your source data is still an integer in your output.
false: Amazon AppFlow converts all of the source data into strings when it writes to Amazon S3. For example, an integer of 1 in your source data becomes the string "1" in the output.
A JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce records.
', ], ], 'KMSArn' => [ 'base' => NULL, 'refs' => [ 'CreateConnectorProfileRequest$kmsArn' => '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.
', 'CreateFlowRequest$kmsArn' => '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.
', 'DescribeFlowResponse$kmsArn' => '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.
', ], ], 'Key' => [ 'base' => NULL, 'refs' => [ 'AuthParameter$key' => 'The authentication key required to authenticate with the connector.
', 'ConnectorRuntimeSetting$key' => 'Contains value information about the connector runtime setting.
', 'InforNexusConnectorProfileCredentials$secretAccessKey' => 'The secret key used to sign requests.
', 'InforNexusConnectorProfileCredentials$datakey' => 'The encryption keys used to encrypt data.
', 'OAuth2CustomParameter$key' => 'The key of the custom parameter required for OAuth 2.0 authentication.
', ], ], 'Label' => [ 'base' => NULL, 'refs' => [ 'AuthParameter$label' => 'Label used for authentication parameter.
', 'ConnectorEntity$label' => 'The label applied to the connector entity.
', 'ConnectorEntityField$label' => 'The label applied to a connector entity field.
', 'ConnectorRuntimeSetting$label' => 'A label used for connector runtime setting.
', 'OAuth2CustomParameter$label' => 'The label of the custom parameter used for OAuth 2.0 authentication.
', ], ], 'LambdaConnectorProvisioningConfig' => [ 'base' => 'Contains information about the configuration of the lambda which is being registered as the connector.
', 'refs' => [ 'ConnectorProvisioningConfig$lambda' => 'Contains information about the configuration of the lambda which is being registered as the connector.
', ], ], 'ListConnectorEntitiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListConnectorEntitiesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListConnectorsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListConnectorsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListEntitiesMaxResults' => [ 'base' => NULL, 'refs' => [ 'ListConnectorEntitiesRequest$maxResults' => 'The maximum number of items that the operation returns in the response.
', ], ], 'ListFlowsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFlowsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'LogoURL' => [ 'base' => NULL, 'refs' => [ 'ConnectorConfiguration$logoURL' => 'Logo URL of the connector.
', ], ], 'LogonLanguage' => [ 'base' => NULL, 'refs' => [ 'SAPODataConnectorProfileProperties$logonLanguage' => 'The logon language of SAPOData instance.
', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'AggregationConfig$targetFileSize' => 'The desired file size, in MB, for each output file that Amazon AppFlow writes to the flow destination. For each file, Amazon AppFlow attempts to achieve the size that you specify. The actual file sizes might differ from this target based on the number and size of the records that each file contains.
', 'DescribeFlowResponse$schemaVersion' => 'The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:
Source-to-destination field mappings
Field data types
Partition keys
Specifies the failure count for the attempted flow.
', 'ExecutionResult$bytesProcessed' => 'The total number of bytes processed by the flow run.
', 'ExecutionResult$bytesWritten' => 'The total number of bytes written as a result of the flow run.
', 'ExecutionResult$recordsProcessed' => 'The number of records processed in the flow run.
', ], ], 'LookoutMetricsDestinationProperties' => [ 'base' => 'The properties that are applied when Amazon Lookout for Metrics is used as a destination.
', 'refs' => [ 'DestinationConnectorProperties$LookoutMetrics' => 'The properties required to query Amazon Lookout for Metrics.
', ], ], 'MarketoConnectorOperator' => [ 'base' => NULL, 'refs' => [ 'ConnectorOperator$Marketo' => 'The operation to be performed on the provided Marketo source fields.
', ], ], 'MarketoConnectorProfileCredentials' => [ 'base' => 'The connector-specific profile credentials required by Marketo.
', 'refs' => [ 'ConnectorProfileCredentials$Marketo' => 'The connector-specific credentials required when using Marketo.
', ], ], 'MarketoConnectorProfileProperties' => [ 'base' => 'The connector-specific profile properties required when using Marketo.
', 'refs' => [ 'ConnectorProfileProperties$Marketo' => 'The connector-specific properties required by Marketo.
', ], ], 'MarketoDestinationProperties' => [ 'base' => 'The properties that Amazon AppFlow applies when you use Marketo as a flow destination.
', 'refs' => [ 'DestinationConnectorProperties$Marketo' => 'The properties required to query Marketo.
', ], ], 'MarketoMetadata' => [ 'base' => 'The connector metadata specific to Marketo.
', 'refs' => [ 'ConnectorMetadata$Marketo' => 'The connector metadata specific to Marketo.
', ], ], 'MarketoSourceProperties' => [ 'base' => 'The properties that are applied when Marketo is being used as a source.
', 'refs' => [ 'SourceConnectorProperties$Marketo' => 'Specifies the information that is required for querying Marketo.
', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'DescribeConnectorProfilesRequest$maxResults' => ' Specifies the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations).
The maximum number of items that should be returned in the result set. The default is 20.
', 'DescribeFlowExecutionRecordsRequest$maxResults' => ' Specifies the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations).
Specifies the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations).
Specifies the maximum number of items that should be returned in the result set.
', ], ], 'MetadataCatalogConfig' => [ 'base' => '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.
', 'refs' => [ 'CreateFlowRequest$metadataCatalogConfig' => 'Specifies the configuration that Amazon AppFlow uses when it catalogs the data that\'s transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
', 'DescribeFlowResponse$metadataCatalogConfig' => 'Specifies the configuration that Amazon AppFlow uses when it catalogs the data that\'s transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
', 'UpdateFlowRequest$metadataCatalogConfig' => 'Specifies the configuration that Amazon AppFlow uses when it catalogs the data that\'s transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
', ], ], 'MetadataCatalogDetail' => [ 'base' => 'Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.
', 'refs' => [ 'MetadataCatalogDetails$member' => NULL, ], ], 'MetadataCatalogDetails' => [ 'base' => NULL, 'refs' => [ 'DescribeFlowResponse$lastRunMetadataCatalogDetails' => 'Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.
', 'ExecutionRecord$metadataCatalogDetails' => 'Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.
', ], ], 'MostRecentExecutionMessage' => [ 'base' => NULL, 'refs' => [ 'ExecutionDetails$mostRecentExecutionMessage' => 'Describes the details of the most recent flow run.
', ], ], 'Name' => [ 'base' => NULL, 'refs' => [ 'ConnectorEntity$name' => 'The name of the connector entity.
', 'IdFieldNameList$member' => NULL, ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'DescribeConnectorProfilesRequest$nextToken' => 'The pagination token for the next page of data.
', 'DescribeConnectorProfilesResponse$nextToken' => ' The pagination token for the next page of data. If nextToken=null, this means that all records have been fetched.
The pagination token for the next page of data.
', 'DescribeConnectorsResponse$nextToken' => 'The pagination token for the next page of data.
', 'DescribeFlowExecutionRecordsRequest$nextToken' => 'The pagination token for the next page of data.
', 'DescribeFlowExecutionRecordsResponse$nextToken' => 'The pagination token for the next page of data.
', 'ListConnectorEntitiesRequest$nextToken' => 'A token that was provided by your prior ListConnectorEntities 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.
A token that you specify in your next ListConnectorEntities operation to get the next page of results in paginated response. The ListConnectorEntities operation provides this token if the response is too big for the page size.
The pagination token for the next page of data.
', 'ListConnectorsResponse$nextToken' => 'The pagination token for the next page of data. If nextToken=null, this means that all records have been fetched.
', 'ListFlowsRequest$nextToken' => 'The pagination token for next page of data.
', 'ListFlowsResponse$nextToken' => 'The pagination token for next page of data.
', ], ], 'OAuth2Credentials' => [ 'base' => 'The OAuth 2.0 credentials required for OAuth 2.0 authentication.
', 'refs' => [ 'CustomConnectorProfileCredentials$oauth2' => 'The OAuth 2.0 credentials required for the authentication of the user.
', ], ], 'OAuth2CustomParameter' => [ 'base' => 'Custom parameter required for OAuth 2.0 authentication.
', 'refs' => [ 'OAuth2CustomPropertiesList$member' => NULL, ], ], 'OAuth2CustomPropType' => [ 'base' => NULL, 'refs' => [ 'OAuth2CustomParameter$type' => 'Indicates whether custom parameter is used with TokenUrl or AuthUrl.
', ], ], 'OAuth2CustomPropertiesList' => [ 'base' => NULL, 'refs' => [ 'OAuth2Defaults$oauth2CustomProperties' => 'List of custom parameters required for OAuth 2.0 authentication.
', ], ], 'OAuth2Defaults' => [ 'base' => 'Contains the default values required for OAuth 2.0 authentication.
', 'refs' => [ 'AuthenticationConfig$oAuth2Defaults' => 'Contains the default values required for OAuth 2.0 authentication.
', ], ], 'OAuth2GrantType' => [ 'base' => NULL, 'refs' => [ 'OAuth2GrantTypeSupportedList$member' => NULL, 'OAuth2Properties$oAuth2GrantType' => 'The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.
', 'SalesforceConnectorProfileCredentials$oAuth2GrantType' => 'Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.
You can specify one of the following values:
Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records.
Amazon AppFlow passes client credentials (a client ID and client secret) when it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.
Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don\'t need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.
OAuth 2.0 grant types supported by the connector.
', 'SalesforceMetadata$oauth2GrantTypesSupported' => 'The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.
Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records.
Amazon AppFlow passes client credentials (a client ID and client secret) when it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.
Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don\'t need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.
The OAuth 2.0 properties required for OAuth 2.0 authentication.
', 'refs' => [ 'CustomConnectorProfileProperties$oAuth2Properties' => NULL, ], ], 'OAuthCredentials' => [ 'base' => 'The OAuth credentials required for OAuth type authentication.
', 'refs' => [ 'SAPODataConnectorProfileCredentials$oAuthCredentials' => 'The SAPOData OAuth type authentication credentials.
', ], ], 'OAuthProperties' => [ 'base' => 'The OAuth properties required for OAuth type authentication.
', 'refs' => [ 'SAPODataConnectorProfileProperties$oAuthProperties' => 'The SAPOData OAuth properties required for OAuth type authentication.
', ], ], 'OAuthScope' => [ 'base' => NULL, 'refs' => [ 'OAuthScopeList$member' => NULL, ], ], 'OAuthScopeList' => [ 'base' => NULL, 'refs' => [ 'GoogleAnalyticsMetadata$oAuthScopes' => 'The desired authorization scope for the Google Analytics account.
', 'HoneycodeMetadata$oAuthScopes' => 'The desired authorization scope for the Amazon Honeycode account.
', 'OAuth2Defaults$oauthScopes' => 'OAuth 2.0 scopes that the connector supports.
', 'OAuthProperties$oAuthScopes' => 'The OAuth scopes required for OAuth type authentication.
', 'SalesforceMetadata$oAuthScopes' => 'The desired authorization scope for the Salesforce account.
', 'SlackMetadata$oAuthScopes' => 'The desired authorization scope for the Slack account.
', 'ZendeskMetadata$oAuthScopes' => 'The desired authorization scope for the Zendesk account.
', ], ], 'Object' => [ 'base' => NULL, 'refs' => [ 'AmplitudeSourceProperties$object' => 'The object specified in the Amplitude flow source.
', 'DatadogSourceProperties$object' => 'The object specified in the Datadog flow source.
', 'DynatraceSourceProperties$object' => 'The object specified in the Dynatrace flow source.
', 'EventBridgeDestinationProperties$object' => 'The object specified in the Amazon EventBridge flow destination.
', 'GoogleAnalyticsSourceProperties$object' => 'The object specified in the Google Analytics flow source.
', 'HoneycodeDestinationProperties$object' => 'The object specified in the Amazon Honeycode flow destination.
', 'InforNexusSourceProperties$object' => 'The object specified in the Infor Nexus flow source.
', 'MarketoDestinationProperties$object' => 'The object specified in the Marketo flow destination.
', 'MarketoSourceProperties$object' => 'The object specified in the Marketo flow source.
', 'PardotSourceProperties$object' => 'The object specified in the Salesforce Pardot flow source.
', 'RedshiftDestinationProperties$object' => 'The object specified in the Amazon Redshift flow destination.
', 'SAPODataDestinationProperties$objectPath' => 'The object path specified in the SAPOData flow destination.
', 'SAPODataSourceProperties$objectPath' => 'The object path specified in the SAPOData flow source.
', 'SalesforceDestinationProperties$object' => 'The object specified in the Salesforce flow destination.
', 'SalesforceSourceProperties$object' => 'The object specified in the Salesforce flow source.
', 'ServiceNowSourceProperties$object' => 'The object specified in the ServiceNow flow source.
', 'SingularSourceProperties$object' => 'The object specified in the Singular flow source.
', 'SlackSourceProperties$object' => 'The object specified in the Slack flow source.
', 'SnowflakeDestinationProperties$object' => 'The object specified in the Snowflake flow destination.
', 'TrendmicroSourceProperties$object' => 'The object specified in the Trend Micro flow source.
', 'VeevaSourceProperties$object' => 'The object specified in the Veeva flow source.
', 'ZendeskDestinationProperties$object' => 'The object specified in the Zendesk flow destination.
', 'ZendeskSourceProperties$object' => 'The object specified in the Zendesk flow source.
', ], ], 'ObjectTypeName' => [ 'base' => NULL, 'refs' => [ 'CustomerProfilesDestinationProperties$objectTypeName' => 'The object specified in the Amazon Connect Customer Profiles flow destination.
', ], ], 'Operator' => [ 'base' => NULL, 'refs' => [ 'ConnectorOperator$CustomConnector' => 'Operators supported by the custom connector.
', 'FilterOperatorList$member' => NULL, ], ], 'OperatorPropertiesKeys' => [ 'base' => NULL, 'refs' => [ 'TaskPropertiesMap$key' => NULL, ], ], 'Operators' => [ 'base' => NULL, 'refs' => [ 'SupportedOperatorList$member' => NULL, ], ], 'PardotConnectorOperator' => [ 'base' => NULL, 'refs' => [ 'ConnectorOperator$Pardot' => 'The operation to be performed on the provided Salesforce Pardot source fields.
', ], ], 'PardotConnectorProfileCredentials' => [ 'base' => 'The connector-specific profile credentials required when using Salesforce Pardot.
', 'refs' => [ 'ConnectorProfileCredentials$Pardot' => 'The connector-specific credentials required when using Salesforce Pardot.
', ], ], 'PardotConnectorProfileProperties' => [ 'base' => 'The connector-specific profile properties required when using Salesforce Pardot.
', 'refs' => [ 'ConnectorProfileProperties$Pardot' => 'The connector-specific properties required by Salesforce Pardot.
', ], ], 'PardotMetadata' => [ 'base' => 'The connector metadata specific to Salesforce Pardot.
', 'refs' => [ 'ConnectorMetadata$Pardot' => 'The connector metadata specific to Salesforce Pardot.
', ], ], 'PardotSourceProperties' => [ 'base' => 'The properties that are applied when Salesforce Pardot is being used as a source.
', 'refs' => [ 'SourceConnectorProperties$Pardot' => 'Specifies the information that is required for querying Salesforce Pardot.
', ], ], 'Password' => [ 'base' => NULL, 'refs' => [ 'BasicAuthCredentials$password' => 'The password to use to connect to a resource.
', 'RedshiftConnectorProfileCredentials$password' => 'The password that corresponds to the user name.
', 'ServiceNowConnectorProfileCredentials$password' => 'The password that corresponds to the user name.
', 'SnowflakeConnectorProfileCredentials$password' => 'The password that corresponds to the user name.
', 'VeevaConnectorProfileCredentials$password' => 'The password that corresponds to the user name.
', ], ], 'PathPrefix' => [ 'base' => NULL, 'refs' => [ 'PathPrefixHierarchy$member' => NULL, ], ], 'PathPrefixHierarchy' => [ 'base' => NULL, 'refs' => [ 'PrefixConfig$pathPrefixHierarchy' => 'Specifies whether the destination file path includes either or both of the following elements:
The ID that Amazon AppFlow assigns to the flow run.
The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:
Source-to-destination field mappings
Field data types
Partition keys
The port number of the SAPOData instance.
', ], ], 'PrefixConfig' => [ 'base' => 'Specifies elements that Amazon AppFlow includes in the file and folder names in the flow destination.
', 'refs' => [ 'S3OutputFormatConfig$prefixConfig' => 'Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket. You can name folders according to the flow frequency and date.
', 'UpsolverS3OutputFormatConfig$prefixConfig' => NULL, ], ], 'PrefixFormat' => [ 'base' => NULL, 'refs' => [ 'PrefixConfig$prefixFormat' => 'Determines the level of granularity for the date and time that\'s included in the prefix.
', ], ], 'PrefixType' => [ 'base' => NULL, 'refs' => [ 'PrefixConfig$prefixType' => 'Determines the format of the prefix, and whether it applies to the file name, file path, or both.
', ], ], 'PrivateConnectionProvisioningFailureCause' => [ 'base' => NULL, 'refs' => [ 'PrivateConnectionProvisioningState$failureCause' => 'Specifies the private connection provisioning failure cause.
', ], ], 'PrivateConnectionProvisioningFailureMessage' => [ 'base' => NULL, 'refs' => [ 'PrivateConnectionProvisioningState$failureMessage' => 'Specifies the private connection provisioning failure reason.
', ], ], 'PrivateConnectionProvisioningState' => [ 'base' => 'Specifies the private connection provisioning state.
', 'refs' => [ 'ConnectorProfile$privateConnectionProvisioningState' => 'Specifies the private connection provisioning state.
', ], ], 'PrivateConnectionProvisioningStatus' => [ 'base' => NULL, 'refs' => [ 'PrivateConnectionProvisioningState$status' => 'Specifies the private connection provisioning status.
', ], ], 'PrivateLinkServiceName' => [ 'base' => NULL, 'refs' => [ 'SAPODataConnectorProfileProperties$privateLinkServiceName' => 'The SAPOData Private Link service name to be used for private data transfers.
', 'SnowflakeConnectorProfileProperties$privateLinkServiceName' => 'The Snowflake Private Link service name to be used for private data transfers.
', ], ], 'ProfilePropertiesMap' => [ 'base' => NULL, 'refs' => [ 'CustomConnectorProfileProperties$profileProperties' => 'A map of properties that are required to create a profile for the custom connector.
', ], ], 'ProfilePropertyKey' => [ 'base' => NULL, 'refs' => [ 'ProfilePropertiesMap$key' => NULL, ], ], 'ProfilePropertyValue' => [ 'base' => NULL, 'refs' => [ 'ProfilePropertiesMap$value' => NULL, ], ], 'Property' => [ 'base' => NULL, 'refs' => [ 'TaskPropertiesMap$value' => NULL, ], ], 'Range' => [ 'base' => 'The range of values that the property supports.
', 'refs' => [ 'FieldTypeDetails$fieldValueRange' => 'The range of values this field can hold.
', 'FieldTypeDetails$fieldLengthRange' => 'This is the allowable length range for this field\'s value.
', ], ], 'RedirectUri' => [ 'base' => NULL, 'refs' => [ 'ConnectorOAuthRequest$redirectUri' => 'The URL to which the authentication server redirects the browser after authorization has been granted.
', ], ], 'RedshiftConnectorProfileCredentials' => [ 'base' => 'The connector-specific profile credentials required when using Amazon Redshift.
', 'refs' => [ 'ConnectorProfileCredentials$Redshift' => 'The connector-specific credentials required when using Amazon Redshift.
', ], ], 'RedshiftConnectorProfileProperties' => [ 'base' => 'The connector-specific profile properties when using Amazon Redshift.
', 'refs' => [ 'ConnectorProfileProperties$Redshift' => 'The connector-specific properties required by Amazon Redshift.
', ], ], 'RedshiftDestinationProperties' => [ 'base' => 'The properties that are applied when Amazon Redshift is being used as a destination.
', 'refs' => [ 'DestinationConnectorProperties$Redshift' => 'The properties required to query Amazon Redshift.
', ], ], 'RedshiftMetadata' => [ 'base' => 'The connector metadata specific to Amazon Redshift.
', 'refs' => [ 'ConnectorMetadata$Redshift' => 'The connector metadata specific to Amazon Redshift.
', ], ], 'RefreshToken' => [ 'base' => NULL, 'refs' => [ 'GoogleAnalyticsConnectorProfileCredentials$refreshToken' => 'The credentials used to acquire new access tokens. This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens.
', 'HoneycodeConnectorProfileCredentials$refreshToken' => 'The credentials used to acquire new access tokens.
', 'OAuth2Credentials$refreshToken' => 'The refresh token used to refresh an expired access token.
', 'OAuthCredentials$refreshToken' => 'The refresh token used to refresh expired access token.
', 'PardotConnectorProfileCredentials$refreshToken' => 'The credentials used to acquire new access tokens.
', 'SalesforceConnectorProfileCredentials$refreshToken' => 'The credentials used to acquire new access tokens.
', ], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'RegionList$member' => NULL, 'SnowflakeConnectorProfileProperties$region' => 'The Amazon Web Services Region of the Snowflake account.
', ], ], 'RegionList' => [ 'base' => NULL, 'refs' => [ 'SnowflakeMetadata$supportedRegions' => 'Specifies the supported Amazon Web Services Regions when using Snowflake.
', ], ], 'RegisterConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterConnectorResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegisteredBy' => [ 'base' => NULL, 'refs' => [ 'ConnectorConfiguration$registeredBy' => 'Information about who registered the connector.
', 'ConnectorDetail$registeredBy' => 'The user who registered the connector.
', ], ], 'RegistrationOutput' => [ 'base' => 'Describes the status of an attempt from Amazon AppFlow to register a resource.
When you run a flow that you\'ve configured to use a metadata catalog, Amazon AppFlow registers a metadata table and data partitions with that catalog. This operation provides the status of that registration attempt. The operation also indicates how many related resources Amazon AppFlow created or updated.
', 'refs' => [ 'MetadataCatalogDetail$tableRegistrationOutput' => 'Describes the status of the attempt from Amazon AppFlow to register the metadata table with the metadata catalog. Amazon AppFlow creates or updates this table for the associated flow run.
', 'MetadataCatalogDetail$partitionRegistrationOutput' => 'Describes the status of the attempt from Amazon AppFlow to register the data partitions with the metadata catalog. The data partitions organize the flow output into a hierarchical path, such as a folder path in an S3 bucket. Amazon AppFlow creates the partitions (if they don\'t already exist) based on your flow configuration.
', ], ], 'ResetConnectorMetadataCacheRequest' => [ 'base' => NULL, 'refs' => [], ], 'ResetConnectorMetadataCacheResponse' => [ 'base' => NULL, 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'The resource specified in the request (such as the source or destination connector profile) is not found.
', 'refs' => [], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'RedshiftConnectorProfileProperties$roleArn' => 'The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift read-only access to Amazon S3. For more information, and for the polices that you attach to this role, see Allow Amazon Redshift to access your Amazon AppFlow data in Amazon S3.
', ], ], 'S3ConnectorOperator' => [ 'base' => NULL, 'refs' => [ 'ConnectorOperator$S3' => 'The operation to be performed on the provided Amazon S3 source fields.
', ], ], 'S3DestinationProperties' => [ 'base' => 'The properties that are applied when Amazon S3 is used as a destination.
', 'refs' => [ 'DestinationConnectorProperties$S3' => 'The properties required to query Amazon S3.
', ], ], 'S3InputFileType' => [ 'base' => NULL, 'refs' => [ 'S3InputFormatConfig$s3InputFileType' => 'The file type that Amazon AppFlow gets from your Amazon S3 bucket.
', ], ], 'S3InputFormatConfig' => [ 'base' => 'When you use Amazon S3 as the source, the configuration format that you provide the flow input data.
', 'refs' => [ 'S3SourceProperties$s3InputFormatConfig' => NULL, ], ], 'S3Metadata' => [ 'base' => 'The connector metadata specific to Amazon S3.
', 'refs' => [ 'ConnectorMetadata$S3' => 'The connector metadata specific to Amazon S3.
', ], ], 'S3OutputFormatConfig' => [ 'base' => 'The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination.
', 'refs' => [ 'S3DestinationProperties$s3OutputFormatConfig' => NULL, ], ], 'S3SourceProperties' => [ 'base' => 'The properties that are applied when Amazon S3 is being used as the flow source.
', 'refs' => [ 'SourceConnectorProperties$S3' => 'Specifies the information that is required for querying Amazon S3.
', ], ], 'SAPODataConnectorOperator' => [ 'base' => NULL, 'refs' => [ 'ConnectorOperator$SAPOData' => 'The operation to be performed on the provided SAPOData source fields.
', ], ], 'SAPODataConnectorProfileCredentials' => [ 'base' => 'The connector-specific profile credentials required when using SAPOData.
', 'refs' => [ 'ConnectorProfileCredentials$SAPOData' => NULL, ], ], 'SAPODataConnectorProfileProperties' => [ 'base' => 'The connector-specific profile properties required when using SAPOData.
', 'refs' => [ 'ConnectorProfileProperties$SAPOData' => NULL, ], ], 'SAPODataDestinationProperties' => [ 'base' => 'The properties that are applied when using SAPOData as a flow destination
', 'refs' => [ 'DestinationConnectorProperties$SAPOData' => 'The properties required to query SAPOData.
', ], ], 'SAPODataMetadata' => [ 'base' => 'The connector metadata specific to SAPOData.
', 'refs' => [ 'ConnectorMetadata$SAPOData' => NULL, ], ], 'SAPODataSourceProperties' => [ 'base' => 'The properties that are applied when using SAPOData as a flow source.
', 'refs' => [ 'SourceConnectorProperties$SAPOData' => NULL, ], ], 'SalesforceConnectorOperator' => [ 'base' => NULL, 'refs' => [ 'ConnectorOperator$Salesforce' => 'The operation to be performed on the provided Salesforce source fields.
', ], ], 'SalesforceConnectorProfileCredentials' => [ 'base' => 'The connector-specific profile credentials required when using Salesforce.
', 'refs' => [ 'ConnectorProfileCredentials$Salesforce' => 'The connector-specific credentials required when using Salesforce.
', ], ], 'SalesforceConnectorProfileProperties' => [ 'base' => 'The connector-specific profile properties required when using Salesforce.
', 'refs' => [ 'ConnectorProfileProperties$Salesforce' => 'The connector-specific properties required by Salesforce.
', ], ], 'SalesforceDataTransferApi' => [ 'base' => NULL, 'refs' => [ 'SalesforceDataTransferApiList$member' => NULL, 'SalesforceDestinationProperties$dataTransferApi' => 'Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to Salesforce.
The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers to Salesforce. If your flow transfers fewer than 1,000 records, Amazon AppFlow uses Salesforce REST API. If your flow transfers 1,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0.
Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow runs daily, it might use REST API on one day to transfer 900 records, and it might use Bulk API 2.0 on the next day to transfer 1,100 records. For each of these flow runs, the respective Salesforce API formats the data differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn\'t transfer Salesforce compound fields.
By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output.
Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it\'s optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers.
Note that Bulk API 2.0 does not transfer Salesforce compound fields.
Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail with a timed out error.
Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce.
The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers from Salesforce. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses Salesforce REST API. If your flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0.
Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow runs daily, it might use REST API on one day to transfer 900,000 records, and it might use Bulk API 2.0 on the next day to transfer 1,100,000 records. For each of these flow runs, the respective Salesforce API formats the data differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn\'t transfer Salesforce compound fields.
By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output.
Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it\'s optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers.
Note that Bulk API 2.0 does not transfer Salesforce compound fields.
Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a timed out error.
The Salesforce APIs that you can have Amazon AppFlow use when your flows transfers data to or from Salesforce.
', ], ], 'SalesforceDestinationProperties' => [ 'base' => 'The properties that are applied when Salesforce is being used as a destination.
', 'refs' => [ 'DestinationConnectorProperties$Salesforce' => 'The properties required to query Salesforce.
', ], ], 'SalesforceMetadata' => [ 'base' => 'The connector metadata specific to Salesforce.
', 'refs' => [ 'ConnectorMetadata$Salesforce' => 'The connector metadata specific to Salesforce.
', ], ], 'SalesforceSourceProperties' => [ 'base' => 'The properties that are applied when Salesforce is being used as a source.
', 'refs' => [ 'SourceConnectorProperties$Salesforce' => 'Specifies the information that is required for querying Salesforce.
', ], ], 'ScheduleExpression' => [ 'base' => NULL, 'refs' => [ 'ScheduledTriggerProperties$scheduleExpression' => ' The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes).
Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
', ], ], 'ScheduledTriggerProperties' => [ 'base' => ' Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the Scheduled trigger type.
Specifies the configuration details of a schedule-triggered flow as defined by the user.
', ], ], 'SchedulingFrequencyTypeList' => [ 'base' => NULL, 'refs' => [ 'ConnectorConfiguration$supportedSchedulingFrequencies' => 'Specifies the supported flow frequency for that connector.
', ], ], 'SecretKey' => [ 'base' => NULL, 'refs' => [ 'AmplitudeConnectorProfileCredentials$secretKey' => 'The Secret Access Key portion of the credentials.
', ], ], 'ServiceNowConnectorOperator' => [ 'base' => NULL, 'refs' => [ 'ConnectorOperator$ServiceNow' => 'The operation to be performed on the provided ServiceNow source fields.
', ], ], 'ServiceNowConnectorProfileCredentials' => [ 'base' => 'The connector-specific profile credentials required when using ServiceNow.
', 'refs' => [ 'ConnectorProfileCredentials$ServiceNow' => 'The connector-specific credentials required when using ServiceNow.
', ], ], 'ServiceNowConnectorProfileProperties' => [ 'base' => 'The connector-specific profile properties required when using ServiceNow.
', 'refs' => [ 'ConnectorProfileProperties$ServiceNow' => 'The connector-specific properties required by serviceNow.
', ], ], 'ServiceNowMetadata' => [ 'base' => 'The connector metadata specific to ServiceNow.
', 'refs' => [ 'ConnectorMetadata$ServiceNow' => 'The connector metadata specific to ServiceNow.
', ], ], 'ServiceNowSourceProperties' => [ 'base' => 'The properties that are applied when ServiceNow is being used as a source.
', 'refs' => [ 'SourceConnectorProperties$ServiceNow' => 'Specifies the information that is required for querying ServiceNow.
', ], ], 'ServiceQuotaExceededException' => [ 'base' => 'The request would cause a service quota (such as the number of flows) to be exceeded.
', 'refs' => [], ], 'SingularConnectorOperator' => [ 'base' => NULL, 'refs' => [ 'ConnectorOperator$Singular' => 'The operation to be performed on the provided Singular source fields.
', ], ], 'SingularConnectorProfileCredentials' => [ 'base' => 'The connector-specific profile credentials required when using Singular.
', 'refs' => [ 'ConnectorProfileCredentials$Singular' => 'The connector-specific credentials required when using Singular.
', ], ], 'SingularConnectorProfileProperties' => [ 'base' => 'The connector-specific profile properties required when using Singular.
', 'refs' => [ 'ConnectorProfileProperties$Singular' => 'The connector-specific properties required by Singular.
', ], ], 'SingularMetadata' => [ 'base' => 'The connector metadata specific to Singular.
', 'refs' => [ 'ConnectorMetadata$Singular' => 'The connector metadata specific to Singular.
', ], ], 'SingularSourceProperties' => [ 'base' => 'The properties that are applied when Singular is being used as a source.
', 'refs' => [ 'SourceConnectorProperties$Singular' => 'Specifies the information that is required for querying Singular.
', ], ], 'SlackConnectorOperator' => [ 'base' => NULL, 'refs' => [ 'ConnectorOperator$Slack' => 'The operation to be performed on the provided Slack source fields.
', ], ], 'SlackConnectorProfileCredentials' => [ 'base' => 'The connector-specific profile credentials required when using Slack.
', 'refs' => [ 'ConnectorProfileCredentials$Slack' => 'The connector-specific credentials required when using Slack.
', ], ], 'SlackConnectorProfileProperties' => [ 'base' => 'The connector-specific profile properties required when using Slack.
', 'refs' => [ 'ConnectorProfileProperties$Slack' => 'The connector-specific properties required by Slack.
', ], ], 'SlackMetadata' => [ 'base' => 'The connector metadata specific to Slack.
', 'refs' => [ 'ConnectorMetadata$Slack' => 'The connector metadata specific to Slack.
', ], ], 'SlackSourceProperties' => [ 'base' => 'The properties that are applied when Slack is being used as a source.
', 'refs' => [ 'SourceConnectorProperties$Slack' => 'Specifies the information that is required for querying Slack.
', ], ], 'SnowflakeConnectorProfileCredentials' => [ 'base' => 'The connector-specific profile credentials required when using Snowflake.
', 'refs' => [ 'ConnectorProfileCredentials$Snowflake' => 'The connector-specific credentials required when using Snowflake.
', ], ], 'SnowflakeConnectorProfileProperties' => [ 'base' => 'The connector-specific profile properties required when using Snowflake.
', 'refs' => [ 'ConnectorProfileProperties$Snowflake' => 'The connector-specific properties required by Snowflake.
', ], ], 'SnowflakeDestinationProperties' => [ 'base' => 'The properties that are applied when Snowflake is being used as a destination.
', 'refs' => [ 'DestinationConnectorProperties$Snowflake' => 'The properties required to query Snowflake.
', ], ], 'SnowflakeMetadata' => [ 'base' => 'The connector metadata specific to Snowflake.
', 'refs' => [ 'ConnectorMetadata$Snowflake' => 'The connector metadata specific to Snowflake.
', ], ], 'SourceConnectorProperties' => [ 'base' => 'Specifies the information that is required to query a particular connector.
', 'refs' => [ 'SourceFlowConfig$sourceConnectorProperties' => 'Specifies the information that is required to query a particular source connector.
', ], ], 'SourceFieldProperties' => [ 'base' => 'The properties that can be applied to a field when the connector is being used as a source.
', 'refs' => [ 'ConnectorEntityField$sourceProperties' => 'The properties that can be applied to a field when the connector is being used as a source.
', ], ], 'SourceFields' => [ 'base' => NULL, 'refs' => [ 'Task$sourceFields' => 'The source fields to which a particular task is applied.
', ], ], 'SourceFlowConfig' => [ 'base' => 'Contains information about the configuration of the source connector used in the flow.
', 'refs' => [ 'CreateFlowRequest$sourceFlowConfig' => 'The configuration that controls how Amazon AppFlow retrieves data from the source connector.
', 'DescribeFlowResponse$sourceFlowConfig' => 'The configuration that controls how Amazon AppFlow retrieves data from the source connector.
', 'UpdateFlowRequest$sourceFlowConfig' => NULL, ], ], 'Stage' => [ 'base' => NULL, 'refs' => [ 'SnowflakeConnectorProfileProperties$stage' => 'The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account. This is written in the following format: < Database>< Schema><Stage Name>.
', ], ], 'StartFlowRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartFlowResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopFlowRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopFlowResponse' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'ConnectorEntityField$defaultValue' => 'Default value that can be assigned to this field.
', 'FieldTypeDetails$valueRegexPattern' => 'The regular expression pattern for the field name.
', 'FieldTypeDetails$supportedDateFormat' => 'The date format that the field supports.
', 'MetadataCatalogDetail$tableName' => 'The name of the table that stores the metadata for the associated flow run. The table stores metadata that represents the data that the flow transferred. Amazon AppFlow stores the table in the metadata catalog.
', 'RedshiftConnectorProfileCredentials$username' => 'The name of the user.
', 'RegistrationOutput$message' => 'Explains the status of the registration attempt from Amazon AppFlow. If the attempt fails, the message explains why.
', 'RegistrationOutput$result' => 'Indicates the number of resources that Amazon AppFlow created or updated. Possible resources include metadata tables and data partitions.
', 'SourceFields$member' => NULL, ], ], 'SuccessResponseHandlingConfig' => [ 'base' => 'Determines how Amazon AppFlow handles the success response that it gets from the connector after placing data.
For example, this setting would determine where to write the response from the destination connector upon a successful insert operation.
', 'refs' => [ 'SAPODataDestinationProperties$successResponseHandlingConfig' => 'Determines how Amazon AppFlow handles the success response that it gets from the connector after placing data.
For example, this setting would determine where to write the response from a destination connector upon a successful insert operation.
', ], ], 'SupportedApiVersion' => [ 'base' => NULL, 'refs' => [ 'SupportedApiVersionList$member' => NULL, ], ], 'SupportedApiVersionList' => [ 'base' => NULL, 'refs' => [ 'ConnectorConfiguration$supportedApiVersions' => 'A list of API versions that are supported by the connector.
', ], ], 'SupportedDataTransferApis' => [ 'base' => NULL, 'refs' => [ 'ConnectorConfiguration$supportedDataTransferApis' => 'The APIs of the connector application that Amazon AppFlow can use to transfer your data.
', ], ], 'SupportedDataTransferType' => [ 'base' => NULL, 'refs' => [ 'SupportedDataTransferTypeList$member' => NULL, ], ], 'SupportedDataTransferTypeList' => [ 'base' => NULL, 'refs' => [ 'ConnectorConfiguration$supportedDataTransferTypes' => 'The data transfer types that the connector supports.
Structured records.
Files or binary data.
The data transfer types that the connector supports.
Structured records.
Files or binary data.
Contains details regarding all the supported FieldTypes and their corresponding filterOperators and supportedValues.
Contains details regarding the supported FieldType, including the corresponding filterOperators and supportedValues.
A list of operators supported by the connector.
', ], ], 'SupportedValueList' => [ 'base' => NULL, 'refs' => [ 'FieldTypeDetails$supportedValues' => ' The list of values that a field can contain. For example, a Boolean fieldType can have two values: "true" and "false".
A list of write operations supported by the connector.
', 'DestinationFieldProperties$supportedWriteOperations' => ' A list of supported write operations. For each write operation listed, this field can be used in idFieldNames when that write operation is present as a destination option.
The tag keys associated with the tag that you want to remove from your flow.
', ], ], 'TagMap' => [ 'base' => NULL, 'refs' => [ 'CreateFlowRequest$tags' => 'The tags used to organize, track, or control access for your flow.
', 'DescribeFlowResponse$tags' => 'The tags used to organize, track, or control access for your flow.
', 'FlowDefinition$tags' => 'The tags used to organize, track, or control access for your flow.
', 'ListTagsForResourceResponse$tags' => 'The tags used to organize, track, or control access for your flow.
', 'TagResourceRequest$tags' => 'The tags used to organize, track, or control access for your flow.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'TagMap$value' => NULL, ], ], 'Task' => [ 'base' => ' A class for modeling different type of tasks. Task implementation varies based on the TaskType.
A map used to store task-related information. The execution service looks for particular information based on the TaskType.
Specifies the particular task implementation that Amazon AppFlow performs.
', ], ], 'Tasks' => [ 'base' => NULL, 'refs' => [ 'CreateFlowRequest$tasks' => 'A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
', 'DescribeFlowResponse$tasks' => 'A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
', 'UpdateFlowRequest$tasks' => 'A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
', ], ], 'ThrottlingException' => [ 'base' => 'API calls have exceeded the maximum allowed API request rate per account and per Region.
', 'refs' => [], ], 'Timezone' => [ 'base' => NULL, 'refs' => [ 'ScheduledTriggerProperties$timezone' => 'Specifies the time zone used when referring to the dates and times of a scheduled flow, such as America/New_York. 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.
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 America/New_York timezone are -04:00 EDT and -05:00 EST.
The token URL required for OAuth 2.0 authentication.
', 'OAuthProperties$tokenUrl' => 'The token url required to fetch access/refresh tokens using authorization code and also to refresh expired access token using refresh token.
', 'TokenUrlList$member' => NULL, ], ], 'TokenUrlCustomProperties' => [ 'base' => NULL, 'refs' => [ 'OAuth2Properties$tokenUrlCustomProperties' => 'Associates your token URL with a map of properties that you define. Use this parameter to provide any additional details that the connector requires to authenticate your request.
', ], ], 'TokenUrlList' => [ 'base' => NULL, 'refs' => [ 'OAuth2Defaults$tokenUrls' => 'Token URLs that can be used for OAuth 2.0 authentication.
', ], ], 'TrendmicroConnectorOperator' => [ 'base' => NULL, 'refs' => [ 'ConnectorOperator$Trendmicro' => 'The operation to be performed on the provided Trend Micro source fields.
', ], ], 'TrendmicroConnectorProfileCredentials' => [ 'base' => 'The connector-specific profile credentials required when using Trend Micro.
', 'refs' => [ 'ConnectorProfileCredentials$Trendmicro' => 'The connector-specific credentials required when using Trend Micro.
', ], ], 'TrendmicroConnectorProfileProperties' => [ 'base' => 'The connector-specific profile properties required when using Trend Micro.
', 'refs' => [ 'ConnectorProfileProperties$Trendmicro' => 'The connector-specific properties required by Trend Micro.
', ], ], 'TrendmicroMetadata' => [ 'base' => 'The connector metadata specific to Trend Micro.
', 'refs' => [ 'ConnectorMetadata$Trendmicro' => 'The connector metadata specific to Trend Micro.
', ], ], 'TrendmicroSourceProperties' => [ 'base' => 'The properties that are applied when using Trend Micro as a flow source.
', 'refs' => [ 'SourceConnectorProperties$Trendmicro' => 'Specifies the information that is required for querying Trend Micro.
', ], ], 'TriggerConfig' => [ 'base' => 'The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
', 'refs' => [ 'CreateFlowRequest$triggerConfig' => 'The trigger settings that determine how and when the flow runs.
', 'DescribeFlowResponse$triggerConfig' => 'The trigger settings that determine how and when the flow runs.
', 'UpdateFlowRequest$triggerConfig' => 'The trigger settings that determine how and when the flow runs.
', ], ], 'TriggerProperties' => [ 'base' => ' Specifies the configuration details that control the trigger for a flow. Currently, these settings only apply to the Scheduled trigger type.
Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the Scheduled trigger type.
Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.
Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.
Specifies the supported trigger types for the flow.
', ], ], 'UnregisterConnectorRequest' => [ 'base' => NULL, 'refs' => [], ], 'UnregisterConnectorResponse' => [ 'base' => NULL, 'refs' => [], ], 'UnsupportedOperationException' => [ 'base' => 'The requested operation is not supported for the current flow.
', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectorProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectorProfileResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectorRegistrationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectorRegistrationResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFlowRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFlowResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatedBy' => [ 'base' => NULL, 'refs' => [ 'DescribeFlowResponse$lastUpdatedBy' => 'Specifies the user name of the account that performed the most recent update.
', 'FlowDefinition$lastUpdatedBy' => 'Specifies the account user name that most recently updated the flow.
', ], ], 'UpsolverBucketName' => [ 'base' => NULL, 'refs' => [ 'UpsolverDestinationProperties$bucketName' => 'The Upsolver Amazon S3 bucket name in which Amazon AppFlow places the transferred data.
', ], ], 'UpsolverDestinationProperties' => [ 'base' => 'The properties that are applied when Upsolver is used as a destination.
', 'refs' => [ 'DestinationConnectorProperties$Upsolver' => 'The properties required to query Upsolver.
', ], ], 'UpsolverMetadata' => [ 'base' => 'The connector metadata specific to Upsolver.
', 'refs' => [ 'ConnectorMetadata$Upsolver' => 'The connector metadata specific to Upsolver.
', ], ], 'UpsolverS3OutputFormatConfig' => [ 'base' => 'The configuration that determines how Amazon AppFlow formats the flow output data when Upsolver is used as the destination.
', 'refs' => [ 'UpsolverDestinationProperties$s3OutputFormatConfig' => 'The configuration that determines how data is formatted when Upsolver is used as the flow destination.
', ], ], 'Username' => [ 'base' => NULL, 'refs' => [ 'BasicAuthCredentials$username' => 'The username to use to connect to a resource.
', 'InforNexusConnectorProfileCredentials$userId' => 'The identifier for the user.
', 'ServiceNowConnectorProfileCredentials$username' => 'The name of the user.
', 'SnowflakeConnectorProfileCredentials$username' => 'The name of the user.
', 'VeevaConnectorProfileCredentials$username' => 'The name of the user.
', ], ], 'ValidationException' => [ 'base' => 'The request has invalid or missing parameters.
', 'refs' => [], ], 'Value' => [ 'base' => NULL, 'refs' => [ 'SupportedValueList$member' => NULL, ], ], 'VeevaConnectorOperator' => [ 'base' => NULL, 'refs' => [ 'ConnectorOperator$Veeva' => 'The operation to be performed on the provided Veeva source fields.
', ], ], 'VeevaConnectorProfileCredentials' => [ 'base' => 'The connector-specific profile credentials required when using Veeva.
', 'refs' => [ 'ConnectorProfileCredentials$Veeva' => 'The connector-specific credentials required when using Veeva.
', ], ], 'VeevaConnectorProfileProperties' => [ 'base' => 'The connector-specific profile properties required when using Veeva.
', 'refs' => [ 'ConnectorProfileProperties$Veeva' => 'The connector-specific properties required by Veeva.
', ], ], 'VeevaMetadata' => [ 'base' => 'The connector metadata specific to Veeva.
', 'refs' => [ 'ConnectorMetadata$Veeva' => 'The connector metadata specific to Veeva.
', ], ], 'VeevaSourceProperties' => [ 'base' => 'The properties that are applied when using Veeva as a flow source.
', 'refs' => [ 'SourceConnectorProperties$Veeva' => 'Specifies the information that is required for querying Veeva.
', ], ], 'Warehouse' => [ 'base' => NULL, 'refs' => [ 'SnowflakeConnectorProfileProperties$warehouse' => 'The name of the Snowflake warehouse.
', ], ], 'WorkgroupName' => [ 'base' => NULL, 'refs' => [ 'RedshiftConnectorProfileProperties$workgroupName' => 'The name of an Amazon Redshift workgroup.
', ], ], 'WriteOperationType' => [ 'base' => ' The possible write operations in the destination connector. When this value is not provided, this defaults to the INSERT operation.
Specifies the type of write operation to be performed in the custom connector when it\'s used as destination.
', 'SAPODataDestinationProperties$writeOperationType' => NULL, 'SalesforceDestinationProperties$writeOperationType' => ' This specifies the type of write operation to be performed in Salesforce. When the value is UPSERT, then idFieldNames is required.
The operation to be performed on the provided Zendesk source fields.
', ], ], 'ZendeskConnectorProfileCredentials' => [ 'base' => 'The connector-specific profile credentials required when using Zendesk.
', 'refs' => [ 'ConnectorProfileCredentials$Zendesk' => 'The connector-specific credentials required when using Zendesk.
', ], ], 'ZendeskConnectorProfileProperties' => [ 'base' => 'The connector-specific profile properties required when using Zendesk.
', 'refs' => [ 'ConnectorProfileProperties$Zendesk' => 'The connector-specific properties required by Zendesk.
', ], ], 'ZendeskDestinationProperties' => [ 'base' => 'The properties that are applied when Zendesk is used as a destination.
', 'refs' => [ 'DestinationConnectorProperties$Zendesk' => 'The properties required to query Zendesk.
', ], ], 'ZendeskMetadata' => [ 'base' => 'The connector metadata specific to Zendesk.
', 'refs' => [ 'ConnectorMetadata$Zendesk' => 'The connector metadata specific to Zendesk.
', ], ], 'ZendeskSourceProperties' => [ 'base' => 'The properties that are applied when using Zendesk as a flow source.
', 'refs' => [ 'SourceConnectorProperties$Zendesk' => 'Specifies the information that is required for querying Zendesk.
', ], ], ],];