libZSservicesZSamazonka-appflowZSamazonka-appflow
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AppFlow.Lens

Contents

Description

 
Synopsis

Operations

ListConnectorEntities

listConnectorEntities_connectorProfileName :: Lens' ListConnectorEntities (Maybe Text) Source #

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.

listConnectorEntities_entitiesPath :: Lens' ListConnectorEntities (Maybe Text) Source #

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.

listConnectorEntities_connectorType :: Lens' ListConnectorEntities (Maybe ConnectorType) Source #

The type of connector, such as Salesforce, Amplitude, and so on.

listConnectorEntitiesResponse_connectorEntityMap :: Lens' ListConnectorEntitiesResponse (HashMap Text [ConnectorEntity]) Source #

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.

CreateConnectorProfile

createConnectorProfile_kmsArn :: Lens' CreateConnectorProfile (Maybe Text) Source #

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.

createConnectorProfile_connectorProfileName :: Lens' CreateConnectorProfile Text Source #

The name of the connector profile. The name is unique for each ConnectorProfile in your Amazon Web Services account.

createConnectorProfile_connectorType :: Lens' CreateConnectorProfile ConnectorType Source #

The type of connector, such as Salesforce, Amplitude, and so on.

createConnectorProfile_connectionMode :: Lens' CreateConnectorProfile ConnectionMode Source #

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.

createConnectorProfile_connectorProfileConfig :: Lens' CreateConnectorProfile ConnectorProfileConfig Source #

Defines the connector-specific configuration and credentials.

StartFlow

startFlow_flowName :: Lens' StartFlow Text Source #

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

startFlowResponse_executionId :: Lens' StartFlowResponse (Maybe Text) Source #

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.

startFlowResponse_flowArn :: Lens' StartFlowResponse (Maybe Text) Source #

The flow's Amazon Resource Name (ARN).

startFlowResponse_flowStatus :: Lens' StartFlowResponse (Maybe FlowStatus) Source #

Indicates the current status of the flow.

startFlowResponse_httpStatus :: Lens' StartFlowResponse Int Source #

The response's http status code.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the specified flow.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for your flow.

CreateFlow

createFlow_kmsArn :: Lens' CreateFlow (Maybe Text) Source #

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.

createFlow_description :: Lens' CreateFlow (Maybe Text) Source #

A description of the flow you want to create.

createFlow_tags :: Lens' CreateFlow (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for your flow.

createFlow_flowName :: Lens' CreateFlow Text Source #

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

createFlow_triggerConfig :: Lens' CreateFlow TriggerConfig Source #

The trigger settings that determine how and when the flow runs.

createFlow_sourceFlowConfig :: Lens' CreateFlow SourceFlowConfig Source #

The configuration that controls how Amazon AppFlow retrieves data from the source connector.

createFlow_destinationFlowConfigList :: Lens' CreateFlow [DestinationFlowConfig] Source #

The configuration that controls how Amazon AppFlow places data in the destination connector.

createFlow_tasks :: Lens' CreateFlow [Task] Source #

A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

createFlowResponse_flowArn :: Lens' CreateFlowResponse (Maybe Text) Source #

The flow's Amazon Resource Name (ARN).

createFlowResponse_flowStatus :: Lens' CreateFlowResponse (Maybe FlowStatus) Source #

Indicates the current status of the flow.

DeleteConnectorProfile

deleteConnectorProfile_forceDelete :: Lens' DeleteConnectorProfile (Maybe Bool) Source #

Indicates whether Amazon AppFlow should delete the profile, even if it is currently in use in one or more flows.

deleteConnectorProfile_connectorProfileName :: Lens' DeleteConnectorProfile Text Source #

The name of the connector profile. The name is unique for each ConnectorProfile in your account.

UpdateConnectorProfile

updateConnectorProfile_connectorProfileName :: Lens' UpdateConnectorProfile Text Source #

The name of the connector profile and is unique for each ConnectorProfile in the Amazon Web Services account.

updateConnectorProfile_connectionMode :: Lens' UpdateConnectorProfile ConnectionMode Source #

Indicates the connection mode and if it is public or private.

updateConnectorProfile_connectorProfileConfig :: Lens' UpdateConnectorProfile ConnectorProfileConfig Source #

Defines the connector-specific profile configuration and credentials.

DescribeFlow

describeFlow_flowName :: Lens' DescribeFlow Text Source #

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

describeFlowResponse_lastUpdatedBy :: Lens' DescribeFlowResponse (Maybe Text) Source #

Specifies the user name of the account that performed the most recent update.

describeFlowResponse_flowArn :: Lens' DescribeFlowResponse (Maybe Text) Source #

The flow's Amazon Resource Name (ARN).

describeFlowResponse_lastUpdatedAt :: Lens' DescribeFlowResponse (Maybe UTCTime) Source #

Specifies when the flow was last updated.

describeFlowResponse_createdBy :: Lens' DescribeFlowResponse (Maybe Text) Source #

The ARN of the user who created the flow.

describeFlowResponse_tasks :: Lens' DescribeFlowResponse (Maybe [Task]) Source #

A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

describeFlowResponse_triggerConfig :: Lens' DescribeFlowResponse (Maybe TriggerConfig) Source #

The trigger settings that determine how and when the flow runs.

describeFlowResponse_flowName :: Lens' DescribeFlowResponse (Maybe Text) Source #

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

describeFlowResponse_sourceFlowConfig :: Lens' DescribeFlowResponse (Maybe SourceFlowConfig) Source #

The configuration that controls how Amazon AppFlow retrieves data from the source connector.

describeFlowResponse_flowStatusMessage :: Lens' DescribeFlowResponse (Maybe Text) Source #

Contains an error message if the flow status is in a suspended or error state. This applies only to scheduled or event-triggered flows.

describeFlowResponse_kmsArn :: Lens' DescribeFlowResponse (Maybe Text) Source #

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_flowStatus :: Lens' DescribeFlowResponse (Maybe FlowStatus) Source #

Indicates the current status of the flow.

describeFlowResponse_destinationFlowConfigList :: Lens' DescribeFlowResponse (Maybe [DestinationFlowConfig]) Source #

The configuration that controls how Amazon AppFlow transfers data to the destination connector.

describeFlowResponse_tags :: Lens' DescribeFlowResponse (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for your flow.

StopFlow

stopFlow_flowName :: Lens' StopFlow Text Source #

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

stopFlowResponse_flowArn :: Lens' StopFlowResponse (Maybe Text) Source #

The flow's Amazon Resource Name (ARN).

stopFlowResponse_flowStatus :: Lens' StopFlowResponse (Maybe FlowStatus) Source #

Indicates the current status of the flow.

stopFlowResponse_httpStatus :: Lens' StopFlowResponse Int Source #

The response's http status code.

DescribeConnectors

describeConnectors_nextToken :: Lens' DescribeConnectors (Maybe Text) Source #

The pagination token for the next page of data.

describeConnectors_connectorTypes :: Lens' DescribeConnectors (Maybe [ConnectorType]) Source #

The type of connector, such as Salesforce, Amplitude, and so on.

describeConnectorsResponse_nextToken :: Lens' DescribeConnectorsResponse (Maybe Text) Source #

The pagination token for the next page of data.

DescribeConnectorEntity

describeConnectorEntity_connectorProfileName :: Lens' DescribeConnectorEntity (Maybe Text) Source #

The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account.

describeConnectorEntity_connectorType :: Lens' DescribeConnectorEntity (Maybe ConnectorType) Source #

The type of connector application, such as Salesforce, Amplitude, and so on.

describeConnectorEntityResponse_connectorEntityFields :: Lens' DescribeConnectorEntityResponse [ConnectorEntityField] Source #

Describes the fields for that connector entity. For example, for an account entity, the fields would be account name, account ID, and so on.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the flow that you want to tag.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

The tags used to organize, track, or control access for your flow.

ListFlows

listFlows_nextToken :: Lens' ListFlows (Maybe Text) Source #

The pagination token for next page of data.

listFlows_maxResults :: Lens' ListFlows (Maybe Natural) Source #

Specifies the maximum number of items that should be returned in the result set.

listFlowsResponse_nextToken :: Lens' ListFlowsResponse (Maybe Text) Source #

The pagination token for next page of data.

listFlowsResponse_flows :: Lens' ListFlowsResponse (Maybe [FlowDefinition]) Source #

The list of flows associated with your account.

listFlowsResponse_httpStatus :: Lens' ListFlowsResponse Int Source #

The response's http status code.

DescribeFlowExecutionRecords

describeFlowExecutionRecords_nextToken :: Lens' DescribeFlowExecutionRecords (Maybe Text) Source #

The pagination token for the next page of data.

describeFlowExecutionRecords_maxResults :: Lens' DescribeFlowExecutionRecords (Maybe Natural) Source #

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).

describeFlowExecutionRecords_flowName :: Lens' DescribeFlowExecutionRecords Text Source #

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the flow that you want to untag.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The tag keys associated with the tag that you want to remove from your flow.

UpdateFlow

updateFlow_description :: Lens' UpdateFlow (Maybe Text) Source #

A description of the flow.

updateFlow_flowName :: Lens' UpdateFlow Text Source #

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

updateFlow_triggerConfig :: Lens' UpdateFlow TriggerConfig Source #

The trigger settings that determine how and when the flow runs.

updateFlow_destinationFlowConfigList :: Lens' UpdateFlow [DestinationFlowConfig] Source #

The configuration that controls how Amazon AppFlow transfers data to the destination connector.

updateFlow_tasks :: Lens' UpdateFlow [Task] Source #

A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

updateFlowResponse_flowStatus :: Lens' UpdateFlowResponse (Maybe FlowStatus) Source #

Indicates the current status of the flow.

DeleteFlow

deleteFlow_forceDelete :: Lens' DeleteFlow (Maybe Bool) Source #

Indicates whether Amazon AppFlow should delete the flow, even if it is currently in use.

deleteFlow_flowName :: Lens' DeleteFlow Text Source #

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

DescribeConnectorProfiles

describeConnectorProfiles_connectorProfileNames :: Lens' DescribeConnectorProfiles (Maybe [Text]) Source #

The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account.

describeConnectorProfiles_nextToken :: Lens' DescribeConnectorProfiles (Maybe Text) Source #

The pagination token for the next page of data.

describeConnectorProfiles_connectorType :: Lens' DescribeConnectorProfiles (Maybe ConnectorType) Source #

The type of connector, such as Salesforce, Amplitude, and so on.

describeConnectorProfiles_maxResults :: Lens' DescribeConnectorProfiles (Maybe Natural) Source #

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).

describeConnectorProfilesResponse_connectorProfileDetails :: Lens' DescribeConnectorProfilesResponse (Maybe [ConnectorProfile]) Source #

Returns information about the connector profiles associated with the flow.

describeConnectorProfilesResponse_nextToken :: Lens' DescribeConnectorProfilesResponse (Maybe Text) Source #

The pagination token for the next page of data. If nextToken=null, this means that all records have been fetched.

Types

AggregationConfig

aggregationConfig_aggregationType :: Lens' AggregationConfig (Maybe AggregationType) Source #

Specifies whether Amazon AppFlow aggregates the flow records into a single file, or leave them unaggregated.

AmplitudeConnectorProfileCredentials

amplitudeConnectorProfileCredentials_apiKey :: Lens' AmplitudeConnectorProfileCredentials Text Source #

A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.

AmplitudeConnectorProfileProperties

AmplitudeMetadata

AmplitudeSourceProperties

amplitudeSourceProperties_object :: Lens' AmplitudeSourceProperties Text Source #

The object specified in the Amplitude flow source.

BasicAuthCredentials

basicAuthCredentials_username :: Lens' BasicAuthCredentials Text Source #

The username to use to connect to a resource.

basicAuthCredentials_password :: Lens' BasicAuthCredentials Text Source #

The password to use to connect to a resource.

ConnectorConfiguration

connectorConfiguration_isPrivateLinkEnabled :: Lens' ConnectorConfiguration (Maybe Bool) Source #

Specifies if PrivateLink is enabled for that connector.

connectorConfiguration_supportedTriggerTypes :: Lens' ConnectorConfiguration (Maybe [TriggerType]) Source #

Specifies the supported trigger types for the flow.

connectorConfiguration_canUseAsSource :: Lens' ConnectorConfiguration (Maybe Bool) Source #

Specifies whether the connector can be used as a source.

connectorConfiguration_connectorMetadata :: Lens' ConnectorConfiguration (Maybe ConnectorMetadata) Source #

Specifies connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on.

connectorConfiguration_canUseAsDestination :: Lens' ConnectorConfiguration (Maybe Bool) Source #

Specifies whether the connector can be used as a destination.

connectorConfiguration_supportedDestinationConnectors :: Lens' ConnectorConfiguration (Maybe [ConnectorType]) Source #

Lists the connectors that are available for use as destinations.

ConnectorEntity

connectorEntity_hasNestedEntities :: Lens' ConnectorEntity (Maybe Bool) Source #

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.

connectorEntity_label :: Lens' ConnectorEntity (Maybe Text) Source #

The label applied to the connector entity.

connectorEntity_name :: Lens' ConnectorEntity Text Source #

The name of the connector entity.

ConnectorEntityField

connectorEntityField_sourceProperties :: Lens' ConnectorEntityField (Maybe SourceFieldProperties) Source #

The properties that can be applied to a field when the connector is being used as a source.

connectorEntityField_supportedFieldTypeDetails :: Lens' ConnectorEntityField (Maybe SupportedFieldTypeDetails) Source #

Contains details regarding the supported FieldType, including the corresponding filterOperators and supportedValues.

connectorEntityField_destinationProperties :: Lens' ConnectorEntityField (Maybe DestinationFieldProperties) Source #

The properties applied to a field when the connector is being used as a destination.

connectorEntityField_description :: Lens' ConnectorEntityField (Maybe Text) Source #

A description of the connector entity field.

connectorEntityField_label :: Lens' ConnectorEntityField (Maybe Text) Source #

The label applied to a connector entity field.

connectorEntityField_identifier :: Lens' ConnectorEntityField Text Source #

The unique identifier of the connector field.

ConnectorMetadata

connectorMetadata_upsolver :: Lens' ConnectorMetadata (Maybe UpsolverMetadata) Source #

The connector metadata specific to Upsolver.

connectorMetadata_snowflake :: Lens' ConnectorMetadata (Maybe SnowflakeMetadata) Source #

The connector metadata specific to Snowflake.

connectorMetadata_honeycode :: Lens' ConnectorMetadata (Maybe HoneycodeMetadata) Source #

The connector metadata specific to Amazon Honeycode.

connectorMetadata_serviceNow :: Lens' ConnectorMetadata (Maybe ServiceNowMetadata) Source #

The connector metadata specific to ServiceNow.

connectorMetadata_dynatrace :: Lens' ConnectorMetadata (Maybe DynatraceMetadata) Source #

The connector metadata specific to Dynatrace.

connectorMetadata_marketo :: Lens' ConnectorMetadata (Maybe MarketoMetadata) Source #

The connector metadata specific to Marketo.

connectorMetadata_slack :: Lens' ConnectorMetadata (Maybe SlackMetadata) Source #

The connector metadata specific to Slack.

connectorMetadata_singular :: Lens' ConnectorMetadata (Maybe SingularMetadata) Source #

The connector metadata specific to Singular.

connectorMetadata_inforNexus :: Lens' ConnectorMetadata (Maybe InforNexusMetadata) Source #

The connector metadata specific to Infor Nexus.

connectorMetadata_amplitude :: Lens' ConnectorMetadata (Maybe AmplitudeMetadata) Source #

The connector metadata specific to Amplitude.

connectorMetadata_customerProfiles :: Lens' ConnectorMetadata (Maybe CustomerProfilesMetadata) Source #

The connector metadata specific to Amazon Connect Customer Profiles.

connectorMetadata_datadog :: Lens' ConnectorMetadata (Maybe DatadogMetadata) Source #

The connector metadata specific to Datadog.

connectorMetadata_googleAnalytics :: Lens' ConnectorMetadata (Maybe GoogleAnalyticsMetadata) Source #

The connector metadata specific to Google Analytics.

connectorMetadata_salesforce :: Lens' ConnectorMetadata (Maybe SalesforceMetadata) Source #

The connector metadata specific to Salesforce.

connectorMetadata_zendesk :: Lens' ConnectorMetadata (Maybe ZendeskMetadata) Source #

The connector metadata specific to Zendesk.

connectorMetadata_s3 :: Lens' ConnectorMetadata (Maybe S3Metadata) Source #

The connector metadata specific to Amazon S3.

connectorMetadata_eventBridge :: Lens' ConnectorMetadata (Maybe EventBridgeMetadata) Source #

The connector metadata specific to Amazon EventBridge.

connectorMetadata_trendmicro :: Lens' ConnectorMetadata (Maybe TrendmicroMetadata) Source #

The connector metadata specific to Trend Micro.

connectorMetadata_redshift :: Lens' ConnectorMetadata (Maybe RedshiftMetadata) Source #

The connector metadata specific to Amazon Redshift.

connectorMetadata_veeva :: Lens' ConnectorMetadata (Maybe VeevaMetadata) Source #

The connector metadata specific to Veeva.

ConnectorOAuthRequest

connectorOAuthRequest_redirectUri :: Lens' ConnectorOAuthRequest (Maybe Text) Source #

The URL to which the authentication server redirects the browser after authorization has been granted.

connectorOAuthRequest_authCode :: Lens' ConnectorOAuthRequest (Maybe Text) Source #

The code provided by the connector when it has been authenticated via the connected app.

ConnectorOperator

connectorOperator_serviceNow :: Lens' ConnectorOperator (Maybe ServiceNowConnectorOperator) Source #

The operation to be performed on the provided ServiceNow source fields.

connectorOperator_dynatrace :: Lens' ConnectorOperator (Maybe DynatraceConnectorOperator) Source #

The operation to be performed on the provided Dynatrace source fields.

connectorOperator_marketo :: Lens' ConnectorOperator (Maybe MarketoConnectorOperator) Source #

The operation to be performed on the provided Marketo source fields.

connectorOperator_slack :: Lens' ConnectorOperator (Maybe SlackConnectorOperator) Source #

The operation to be performed on the provided Slack source fields.

connectorOperator_singular :: Lens' ConnectorOperator (Maybe SingularConnectorOperator) Source #

The operation to be performed on the provided Singular source fields.

connectorOperator_inforNexus :: Lens' ConnectorOperator (Maybe InforNexusConnectorOperator) Source #

The operation to be performed on the provided Infor Nexus source fields.

connectorOperator_amplitude :: Lens' ConnectorOperator (Maybe AmplitudeConnectorOperator) Source #

The operation to be performed on the provided Amplitude source fields.

connectorOperator_datadog :: Lens' ConnectorOperator (Maybe DatadogConnectorOperator) Source #

The operation to be performed on the provided Datadog source fields.

connectorOperator_googleAnalytics :: Lens' ConnectorOperator (Maybe GoogleAnalyticsConnectorOperator) Source #

The operation to be performed on the provided Google Analytics source fields.

connectorOperator_sAPOData :: Lens' ConnectorOperator (Maybe SAPODataConnectorOperator) Source #

The operation to be performed on the provided SAPOData source fields.

connectorOperator_salesforce :: Lens' ConnectorOperator (Maybe SalesforceConnectorOperator) Source #

The operation to be performed on the provided Salesforce source fields.

connectorOperator_zendesk :: Lens' ConnectorOperator (Maybe ZendeskConnectorOperator) Source #

The operation to be performed on the provided Zendesk source fields.

connectorOperator_s3 :: Lens' ConnectorOperator (Maybe S3ConnectorOperator) Source #

The operation to be performed on the provided Amazon S3 source fields.

connectorOperator_trendmicro :: Lens' ConnectorOperator (Maybe TrendmicroConnectorOperator) Source #

The operation to be performed on the provided Trend Micro source fields.

connectorOperator_veeva :: Lens' ConnectorOperator (Maybe VeevaConnectorOperator) Source #

The operation to be performed on the provided Veeva source fields.

ConnectorProfile

connectorProfile_connectorProfileName :: Lens' ConnectorProfile (Maybe Text) Source #

The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account.

connectorProfile_lastUpdatedAt :: Lens' ConnectorProfile (Maybe UTCTime) Source #

Specifies when the connector profile was last updated.

connectorProfile_createdAt :: Lens' ConnectorProfile (Maybe UTCTime) Source #

Specifies when the connector profile was created.

connectorProfile_credentialsArn :: Lens' ConnectorProfile (Maybe Text) Source #

The Amazon Resource Name (ARN) of the connector profile credentials.

connectorProfile_connectorProfileProperties :: Lens' ConnectorProfile (Maybe ConnectorProfileProperties) Source #

The connector-specific properties of the profile configuration.

connectorProfile_connectionMode :: Lens' ConnectorProfile (Maybe ConnectionMode) Source #

Indicates the connection mode and if it is public or private.

connectorProfile_connectorProfileArn :: Lens' ConnectorProfile (Maybe Text) Source #

The Amazon Resource Name (ARN) of the connector profile.

connectorProfile_connectorType :: Lens' ConnectorProfile (Maybe ConnectorType) Source #

The type of connector, such as Salesforce, Amplitude, and so on.

ConnectorProfileConfig

ConnectorProfileCredentials

connectorProfileCredentials_honeycode :: Lens' ConnectorProfileCredentials (Maybe HoneycodeConnectorProfileCredentials) Source #

The connector-specific credentials required when using Amazon Honeycode.

connectorProfileCredentials_redshift :: Lens' ConnectorProfileCredentials (Maybe RedshiftConnectorProfileCredentials) Source #

The connector-specific credentials required when using Amazon Redshift.

ConnectorProfileProperties

CustomerProfilesDestinationProperties

customerProfilesDestinationProperties_objectTypeName :: Lens' CustomerProfilesDestinationProperties (Maybe Text) Source #

The object specified in the Amazon Connect Customer Profiles flow destination.

customerProfilesDestinationProperties_domainName :: Lens' CustomerProfilesDestinationProperties Text Source #

The unique name of the Amazon Connect Customer Profiles domain.

CustomerProfilesMetadata

DatadogConnectorProfileCredentials

datadogConnectorProfileCredentials_apiKey :: Lens' DatadogConnectorProfileCredentials Text Source #

A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.

datadogConnectorProfileCredentials_applicationKey :: Lens' DatadogConnectorProfileCredentials Text Source #

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.

DatadogConnectorProfileProperties

DatadogMetadata

DatadogSourceProperties

datadogSourceProperties_object :: Lens' DatadogSourceProperties Text Source #

The object specified in the Datadog flow source.

DestinationConnectorProperties

DestinationFieldProperties

destinationFieldProperties_isUpdatable :: Lens' DestinationFieldProperties (Maybe Bool) Source #

Specifies whether the field can be updated during an UPDATE or UPSERT write operation.

destinationFieldProperties_isNullable :: Lens' DestinationFieldProperties (Maybe Bool) Source #

Specifies if the destination field can have a null value.

destinationFieldProperties_supportedWriteOperations :: Lens' DestinationFieldProperties (Maybe [WriteOperationType]) Source #

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.

destinationFieldProperties_isUpsertable :: Lens' DestinationFieldProperties (Maybe Bool) Source #

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_isCreatable :: Lens' DestinationFieldProperties (Maybe Bool) Source #

Specifies if the destination field can be created by the current user.

DestinationFlowConfig

destinationFlowConfig_connectorProfileName :: Lens' DestinationFlowConfig (Maybe Text) Source #

The name of the connector profile. This name must be unique for each connector profile in the Amazon Web Services account.

destinationFlowConfig_connectorType :: Lens' DestinationFlowConfig ConnectorType Source #

The type of connector, such as Salesforce, Amplitude, and so on.

destinationFlowConfig_destinationConnectorProperties :: Lens' DestinationFlowConfig DestinationConnectorProperties Source #

This stores the information that is required to query a particular connector.

DynatraceConnectorProfileCredentials

dynatraceConnectorProfileCredentials_apiToken :: Lens' DynatraceConnectorProfileCredentials Text Source #

The API tokens used by Dynatrace API to authenticate various API calls.

DynatraceConnectorProfileProperties

DynatraceMetadata

DynatraceSourceProperties

dynatraceSourceProperties_object :: Lens' DynatraceSourceProperties Text Source #

The object specified in the Dynatrace flow source.

ErrorHandlingConfig

errorHandlingConfig_failOnFirstDestinationError :: Lens' ErrorHandlingConfig (Maybe Bool) Source #

Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination.

errorHandlingConfig_bucketPrefix :: Lens' ErrorHandlingConfig (Maybe Text) Source #

Specifies the Amazon S3 bucket prefix.

errorHandlingConfig_bucketName :: Lens' ErrorHandlingConfig (Maybe Text) Source #

Specifies the name of the Amazon S3 bucket.

ErrorInfo

errorInfo_executionMessage :: Lens' ErrorInfo (Maybe Text) Source #

Specifies the error message that appears if a flow fails.

errorInfo_putFailuresCount :: Lens' ErrorInfo (Maybe Integer) Source #

Specifies the failure count for the attempted flow.

EventBridgeDestinationProperties

eventBridgeDestinationProperties_object :: Lens' EventBridgeDestinationProperties Text Source #

The object specified in the Amazon EventBridge flow destination.

EventBridgeMetadata

ExecutionDetails

executionDetails_mostRecentExecutionMessage :: Lens' ExecutionDetails (Maybe Text) Source #

Describes the details of the most recent flow run.

executionDetails_mostRecentExecutionStatus :: Lens' ExecutionDetails (Maybe ExecutionStatus) Source #

Specifies the status of the most recent flow run.

executionDetails_mostRecentExecutionTime :: Lens' ExecutionDetails (Maybe UTCTime) Source #

Specifies the time of the most recent flow run.

ExecutionRecord

executionRecord_executionId :: Lens' ExecutionRecord (Maybe Text) Source #

Specifies the identifier of the given flow run.

executionRecord_lastUpdatedAt :: Lens' ExecutionRecord (Maybe UTCTime) Source #

Specifies the time of the most recent update.

executionRecord_dataPullStartTime :: Lens' ExecutionRecord (Maybe UTCTime) Source #

The timestamp that determines the first new or updated record to be transferred in the flow run.

executionRecord_executionStatus :: Lens' ExecutionRecord (Maybe ExecutionStatus) Source #

Specifies the flow run status and whether it is in progress, has completed successfully, or has failed.

executionRecord_startedAt :: Lens' ExecutionRecord (Maybe UTCTime) Source #

Specifies the start time of the flow run.

executionRecord_dataPullEndTime :: Lens' ExecutionRecord (Maybe UTCTime) Source #

The timestamp that indicates the last new or updated record to be transferred in the flow run.

executionRecord_executionResult :: Lens' ExecutionRecord (Maybe ExecutionResult) Source #

Describes the result of the given flow run.

ExecutionResult

executionResult_recordsProcessed :: Lens' ExecutionResult (Maybe Integer) Source #

The number of records processed in the flow run.

executionResult_bytesWritten :: Lens' ExecutionResult (Maybe Integer) Source #

The total number of bytes written as a result of the flow run.

executionResult_bytesProcessed :: Lens' ExecutionResult (Maybe Integer) Source #

The total number of bytes processed by the flow run.

executionResult_errorInfo :: Lens' ExecutionResult (Maybe ErrorInfo) Source #

Provides any error message information related to the flow run.

FieldTypeDetails

fieldTypeDetails_supportedValues :: Lens' FieldTypeDetails (Maybe [Text]) Source #

The list of values that a field can contain. For example, a Boolean fieldType can have two values: "true" and "false".

fieldTypeDetails_fieldType :: Lens' FieldTypeDetails Text Source #

The type of field, such as string, integer, date, and so on.

fieldTypeDetails_filterOperators :: Lens' FieldTypeDetails [Operator] Source #

The list of operators supported by a field.

FlowDefinition

flowDefinition_lastUpdatedBy :: Lens' FlowDefinition (Maybe Text) Source #

Specifies the account user name that most recently updated the flow.

flowDefinition_flowArn :: Lens' FlowDefinition (Maybe Text) Source #

The flow's Amazon Resource Name (ARN).

flowDefinition_lastUpdatedAt :: Lens' FlowDefinition (Maybe UTCTime) Source #

Specifies when the flow was last updated.

flowDefinition_createdAt :: Lens' FlowDefinition (Maybe UTCTime) Source #

Specifies when the flow was created.

flowDefinition_triggerType :: Lens' FlowDefinition (Maybe TriggerType) Source #

Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.

flowDefinition_createdBy :: Lens' FlowDefinition (Maybe Text) Source #

The ARN of the user who created the flow.

flowDefinition_sourceConnectorType :: Lens' FlowDefinition (Maybe ConnectorType) Source #

Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

flowDefinition_destinationConnectorType :: Lens' FlowDefinition (Maybe ConnectorType) Source #

Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

flowDefinition_flowName :: Lens' FlowDefinition (Maybe Text) Source #

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

flowDefinition_lastRunExecutionDetails :: Lens' FlowDefinition (Maybe ExecutionDetails) Source #

Describes the details of the most recent flow run.

flowDefinition_flowStatus :: Lens' FlowDefinition (Maybe FlowStatus) Source #

Indicates the current status of the flow.

flowDefinition_description :: Lens' FlowDefinition (Maybe Text) Source #

A user-entered description of the flow.

flowDefinition_tags :: Lens' FlowDefinition (Maybe (HashMap Text Text)) Source #

The tags used to organize, track, or control access for your flow.

GoogleAnalyticsConnectorProfileCredentials

googleAnalyticsConnectorProfileCredentials_accessToken :: Lens' GoogleAnalyticsConnectorProfileCredentials (Maybe Text) Source #

The credentials used to access protected Google Analytics resources.

googleAnalyticsConnectorProfileCredentials_refreshToken :: Lens' GoogleAnalyticsConnectorProfileCredentials (Maybe Text) Source #

The credentials used to acquire new access tokens. This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens.

googleAnalyticsConnectorProfileCredentials_oAuthRequest :: Lens' GoogleAnalyticsConnectorProfileCredentials (Maybe ConnectorOAuthRequest) Source #

The OAuth requirement needed to request security tokens from the connector endpoint.

googleAnalyticsConnectorProfileCredentials_clientSecret :: Lens' GoogleAnalyticsConnectorProfileCredentials Text Source #

The client secret used by the OAuth client to authenticate to the authorization server.

GoogleAnalyticsConnectorProfileProperties

GoogleAnalyticsMetadata

googleAnalyticsMetadata_oAuthScopes :: Lens' GoogleAnalyticsMetadata (Maybe [Text]) Source #

The desired authorization scope for the Google Analytics account.

GoogleAnalyticsSourceProperties

googleAnalyticsSourceProperties_object :: Lens' GoogleAnalyticsSourceProperties Text Source #

The object specified in the Google Analytics flow source.

HoneycodeConnectorProfileCredentials

honeycodeConnectorProfileCredentials_accessToken :: Lens' HoneycodeConnectorProfileCredentials (Maybe Text) Source #

The credentials used to access protected Amazon Honeycode resources.

HoneycodeConnectorProfileProperties

HoneycodeDestinationProperties

honeycodeDestinationProperties_object :: Lens' HoneycodeDestinationProperties Text Source #

The object specified in the Amazon Honeycode flow destination.

HoneycodeMetadata

honeycodeMetadata_oAuthScopes :: Lens' HoneycodeMetadata (Maybe [Text]) Source #

The desired authorization scope for the Amazon Honeycode account.

IncrementalPullConfig

incrementalPullConfig_datetimeTypeFieldName :: Lens' IncrementalPullConfig (Maybe Text) Source #

A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.

InforNexusConnectorProfileCredentials

InforNexusConnectorProfileProperties

InforNexusMetadata

InforNexusSourceProperties

inforNexusSourceProperties_object :: Lens' InforNexusSourceProperties Text Source #

The object specified in the Infor Nexus flow source.

LookoutMetricsDestinationProperties

MarketoConnectorProfileCredentials

marketoConnectorProfileCredentials_accessToken :: Lens' MarketoConnectorProfileCredentials (Maybe Text) Source #

The credentials used to access protected Marketo resources.

marketoConnectorProfileCredentials_oAuthRequest :: Lens' MarketoConnectorProfileCredentials (Maybe ConnectorOAuthRequest) Source #

The OAuth requirement needed to request security tokens from the connector endpoint.

marketoConnectorProfileCredentials_clientSecret :: Lens' MarketoConnectorProfileCredentials Text Source #

The client secret used by the OAuth client to authenticate to the authorization server.

MarketoConnectorProfileProperties

MarketoMetadata

MarketoSourceProperties

marketoSourceProperties_object :: Lens' MarketoSourceProperties Text Source #

The object specified in the Marketo flow source.

OAuthCredentials

oAuthCredentials_accessToken :: Lens' OAuthCredentials (Maybe Text) Source #

The access token used to access protected SAPOData resources.

oAuthCredentials_refreshToken :: Lens' OAuthCredentials (Maybe Text) Source #

The refresh token used to refresh expired access token.

oAuthCredentials_oAuthRequest :: Lens' OAuthCredentials (Maybe ConnectorOAuthRequest) Source #

The OAuth requirement needed to request security tokens from the connector endpoint.

oAuthCredentials_clientId :: Lens' OAuthCredentials Text Source #

The identifier for the desired client.

oAuthCredentials_clientSecret :: Lens' OAuthCredentials Text Source #

The client secret used by the OAuth client to authenticate to the authorization server.

OAuthProperties

oAuthProperties_tokenUrl :: Lens' OAuthProperties Text Source #

The token url required to fetch access/refresh tokens using authorization code and also to refresh expired access token using refresh token.

oAuthProperties_authCodeUrl :: Lens' OAuthProperties Text Source #

The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type authentication.

oAuthProperties_oAuthScopes :: Lens' OAuthProperties [Text] Source #

The OAuth scopes required for OAuth type authentication.

PrefixConfig

prefixConfig_prefixFormat :: Lens' PrefixConfig (Maybe PrefixFormat) Source #

Determines the level of granularity that's included in the prefix.

prefixConfig_prefixType :: Lens' PrefixConfig (Maybe PrefixType) Source #

Determines the format of the prefix, and whether it applies to the file name, file path, or both.

PrivateConnectionProvisioningState

privateConnectionProvisioningState_failureMessage :: Lens' PrivateConnectionProvisioningState (Maybe Text) Source #

Specifies the private connection provisioning failure reason.

RedshiftConnectorProfileCredentials

RedshiftConnectorProfileProperties

redshiftConnectorProfileProperties_bucketPrefix :: Lens' RedshiftConnectorProfileProperties (Maybe Text) Source #

The object key for the destination bucket in which Amazon AppFlow places the files.

RedshiftDestinationProperties

redshiftDestinationProperties_bucketPrefix :: Lens' RedshiftDestinationProperties (Maybe Text) Source #

The object key for the bucket in which Amazon AppFlow places the destination files.

redshiftDestinationProperties_errorHandlingConfig :: Lens' RedshiftDestinationProperties (Maybe ErrorHandlingConfig) Source #

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.

redshiftDestinationProperties_object :: Lens' RedshiftDestinationProperties Text Source #

The object specified in the Amazon Redshift flow destination.

redshiftDestinationProperties_intermediateBucketName :: Lens' RedshiftDestinationProperties Text Source #

The intermediate bucket that Amazon AppFlow uses when moving data into Amazon Redshift.

RedshiftMetadata

S3DestinationProperties

s3DestinationProperties_bucketPrefix :: Lens' S3DestinationProperties (Maybe Text) Source #

The object key for the destination bucket in which Amazon AppFlow places the files.

s3DestinationProperties_bucketName :: Lens' S3DestinationProperties Text Source #

The Amazon S3 bucket name in which Amazon AppFlow places the transferred data.

S3InputFormatConfig

s3InputFormatConfig_s3InputFileType :: Lens' S3InputFormatConfig (Maybe S3InputFileType) Source #

The file type that Amazon AppFlow gets from your Amazon S3 bucket.

S3Metadata

S3OutputFormatConfig

s3OutputFormatConfig_prefixConfig :: Lens' S3OutputFormatConfig (Maybe PrefixConfig) Source #

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.

s3OutputFormatConfig_fileType :: Lens' S3OutputFormatConfig (Maybe FileType) Source #

Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket.

S3SourceProperties

s3SourceProperties_bucketPrefix :: Lens' S3SourceProperties (Maybe Text) Source #

The object key for the Amazon S3 bucket in which the source files are stored.

s3SourceProperties_bucketName :: Lens' S3SourceProperties Text Source #

The Amazon S3 bucket name where the source files are stored.

SAPODataConnectorProfileCredentials

SAPODataConnectorProfileProperties

sAPODataConnectorProfileProperties_privateLinkServiceName :: Lens' SAPODataConnectorProfileProperties (Maybe Text) Source #

The SAPOData Private Link service name to be used for private data transfers.

sAPODataConnectorProfileProperties_oAuthProperties :: Lens' SAPODataConnectorProfileProperties (Maybe OAuthProperties) Source #

The SAPOData OAuth properties required for OAuth type authentication.

sAPODataConnectorProfileProperties_clientNumber :: Lens' SAPODataConnectorProfileProperties Text Source #

The client number for the client creating the connection.

SAPODataMetadata

SAPODataSourceProperties

sAPODataSourceProperties_objectPath :: Lens' SAPODataSourceProperties (Maybe Text) Source #

The object path specified in the SAPOData flow source.

SalesforceConnectorProfileCredentials

salesforceConnectorProfileCredentials_accessToken :: Lens' SalesforceConnectorProfileCredentials (Maybe Text) Source #

The credentials used to access protected Salesforce resources.

salesforceConnectorProfileCredentials_oAuthRequest :: Lens' SalesforceConnectorProfileCredentials (Maybe ConnectorOAuthRequest) Source #

The OAuth requirement needed to request security tokens from the connector endpoint.

salesforceConnectorProfileCredentials_clientCredentialsArn :: Lens' SalesforceConnectorProfileCredentials (Maybe Text) Source #

The secret manager ARN, which contains the client ID and client secret of the connected app.

SalesforceConnectorProfileProperties

salesforceConnectorProfileProperties_isSandboxEnvironment :: Lens' SalesforceConnectorProfileProperties (Maybe Bool) Source #

Indicates whether the connector profile applies to a sandbox or production environment.

SalesforceDestinationProperties

salesforceDestinationProperties_writeOperationType :: Lens' SalesforceDestinationProperties (Maybe WriteOperationType) Source #

This specifies the type of write operation to be performed in Salesforce. When the value is UPSERT, then idFieldNames is required.

salesforceDestinationProperties_idFieldNames :: Lens' SalesforceDestinationProperties (Maybe [Text]) Source #

The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update or delete.

salesforceDestinationProperties_errorHandlingConfig :: Lens' SalesforceDestinationProperties (Maybe ErrorHandlingConfig) Source #

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.

salesforceDestinationProperties_object :: Lens' SalesforceDestinationProperties Text Source #

The object specified in the Salesforce flow destination.

SalesforceMetadata

salesforceMetadata_oAuthScopes :: Lens' SalesforceMetadata (Maybe [Text]) Source #

The desired authorization scope for the Salesforce account.

SalesforceSourceProperties

salesforceSourceProperties_enableDynamicFieldUpdate :: Lens' SalesforceSourceProperties (Maybe Bool) Source #

The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.

salesforceSourceProperties_includeDeletedRecords :: Lens' SalesforceSourceProperties (Maybe Bool) Source #

Indicates whether Amazon AppFlow includes deleted files in the flow run.

salesforceSourceProperties_object :: Lens' SalesforceSourceProperties Text Source #

The object specified in the Salesforce flow source.

ScheduledTriggerProperties

scheduledTriggerProperties_scheduleEndTime :: Lens' ScheduledTriggerProperties (Maybe UTCTime) Source #

Specifies the scheduled end time for a schedule-triggered flow.

scheduledTriggerProperties_scheduleOffset :: Lens' ScheduledTriggerProperties (Maybe Natural) Source #

Specifies the optional offset that is added to the time interval for a schedule-triggered flow.

scheduledTriggerProperties_dataPullMode :: Lens' ScheduledTriggerProperties (Maybe DataPullMode) Source #

Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

scheduledTriggerProperties_scheduleStartTime :: Lens' ScheduledTriggerProperties (Maybe UTCTime) Source #

Specifies the scheduled start time for a schedule-triggered flow.

scheduledTriggerProperties_timezone :: Lens' ScheduledTriggerProperties (Maybe Text) Source #

Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.

scheduledTriggerProperties_firstExecutionFrom :: Lens' ScheduledTriggerProperties (Maybe UTCTime) Source #

Specifies the date range for the records to import from the connector in the first flow run.

scheduledTriggerProperties_scheduleExpression :: Lens' ScheduledTriggerProperties Text Source #

The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes).

ServiceNowConnectorProfileCredentials

ServiceNowConnectorProfileProperties

ServiceNowMetadata

ServiceNowSourceProperties

serviceNowSourceProperties_object :: Lens' ServiceNowSourceProperties Text Source #

The object specified in the ServiceNow flow source.

SingularConnectorProfileCredentials

singularConnectorProfileCredentials_apiKey :: Lens' SingularConnectorProfileCredentials Text Source #

A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.

SingularConnectorProfileProperties

SingularMetadata

SingularSourceProperties

singularSourceProperties_object :: Lens' SingularSourceProperties Text Source #

The object specified in the Singular flow source.

SlackConnectorProfileCredentials

slackConnectorProfileCredentials_accessToken :: Lens' SlackConnectorProfileCredentials (Maybe Text) Source #

The credentials used to access protected Slack resources.

slackConnectorProfileCredentials_oAuthRequest :: Lens' SlackConnectorProfileCredentials (Maybe ConnectorOAuthRequest) Source #

The OAuth requirement needed to request security tokens from the connector endpoint.

slackConnectorProfileCredentials_clientSecret :: Lens' SlackConnectorProfileCredentials Text Source #

The client secret used by the OAuth client to authenticate to the authorization server.

SlackConnectorProfileProperties

SlackMetadata

slackMetadata_oAuthScopes :: Lens' SlackMetadata (Maybe [Text]) Source #

The desired authorization scope for the Slack account.

SlackSourceProperties

slackSourceProperties_object :: Lens' SlackSourceProperties Text Source #

The object specified in the Slack flow source.

SnowflakeConnectorProfileCredentials

SnowflakeConnectorProfileProperties

snowflakeConnectorProfileProperties_privateLinkServiceName :: Lens' SnowflakeConnectorProfileProperties (Maybe Text) Source #

The Snowflake Private Link service name to be used for private data transfers.

snowflakeConnectorProfileProperties_bucketPrefix :: Lens' SnowflakeConnectorProfileProperties (Maybe Text) Source #

The bucket path that refers to the Amazon S3 bucket associated with Snowflake.

snowflakeConnectorProfileProperties_region :: Lens' SnowflakeConnectorProfileProperties (Maybe Text) Source #

The Amazon Web Services Region of the Snowflake account.

snowflakeConnectorProfileProperties_stage :: Lens' SnowflakeConnectorProfileProperties Text Source #

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>.

snowflakeConnectorProfileProperties_bucketName :: Lens' SnowflakeConnectorProfileProperties Text Source #

The name of the Amazon S3 bucket associated with Snowflake.

SnowflakeDestinationProperties

snowflakeDestinationProperties_bucketPrefix :: Lens' SnowflakeDestinationProperties (Maybe Text) Source #

The object key for the destination bucket in which Amazon AppFlow places the files.

snowflakeDestinationProperties_errorHandlingConfig :: Lens' SnowflakeDestinationProperties (Maybe ErrorHandlingConfig) Source #

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.

snowflakeDestinationProperties_object :: Lens' SnowflakeDestinationProperties Text Source #

The object specified in the Snowflake flow destination.

snowflakeDestinationProperties_intermediateBucketName :: Lens' SnowflakeDestinationProperties Text Source #

The intermediate bucket that Amazon AppFlow uses when moving data into Snowflake.

SnowflakeMetadata

snowflakeMetadata_supportedRegions :: Lens' SnowflakeMetadata (Maybe [Text]) Source #

Specifies the supported Amazon Web Services Regions when using Snowflake.

SourceConnectorProperties

sourceConnectorProperties_serviceNow :: Lens' SourceConnectorProperties (Maybe ServiceNowSourceProperties) Source #

Specifies the information that is required for querying ServiceNow.

sourceConnectorProperties_dynatrace :: Lens' SourceConnectorProperties (Maybe DynatraceSourceProperties) Source #

Specifies the information that is required for querying Dynatrace.

sourceConnectorProperties_marketo :: Lens' SourceConnectorProperties (Maybe MarketoSourceProperties) Source #

Specifies the information that is required for querying Marketo.

sourceConnectorProperties_slack :: Lens' SourceConnectorProperties (Maybe SlackSourceProperties) Source #

Specifies the information that is required for querying Slack.

sourceConnectorProperties_singular :: Lens' SourceConnectorProperties (Maybe SingularSourceProperties) Source #

Specifies the information that is required for querying Singular.

sourceConnectorProperties_inforNexus :: Lens' SourceConnectorProperties (Maybe InforNexusSourceProperties) Source #

Specifies the information that is required for querying Infor Nexus.

sourceConnectorProperties_amplitude :: Lens' SourceConnectorProperties (Maybe AmplitudeSourceProperties) Source #

Specifies the information that is required for querying Amplitude.

sourceConnectorProperties_datadog :: Lens' SourceConnectorProperties (Maybe DatadogSourceProperties) Source #

Specifies the information that is required for querying Datadog.

sourceConnectorProperties_googleAnalytics :: Lens' SourceConnectorProperties (Maybe GoogleAnalyticsSourceProperties) Source #

Specifies the information that is required for querying Google Analytics.

sourceConnectorProperties_salesforce :: Lens' SourceConnectorProperties (Maybe SalesforceSourceProperties) Source #

Specifies the information that is required for querying Salesforce.

sourceConnectorProperties_zendesk :: Lens' SourceConnectorProperties (Maybe ZendeskSourceProperties) Source #

Specifies the information that is required for querying Zendesk.

sourceConnectorProperties_s3 :: Lens' SourceConnectorProperties (Maybe S3SourceProperties) Source #

Specifies the information that is required for querying Amazon S3.

sourceConnectorProperties_trendmicro :: Lens' SourceConnectorProperties (Maybe TrendmicroSourceProperties) Source #

Specifies the information that is required for querying Trend Micro.

sourceConnectorProperties_veeva :: Lens' SourceConnectorProperties (Maybe VeevaSourceProperties) Source #

Specifies the information that is required for querying Veeva.

SourceFieldProperties

sourceFieldProperties_isRetrievable :: Lens' SourceFieldProperties (Maybe Bool) Source #

Indicates whether the field can be returned in a search result.

SourceFlowConfig

sourceFlowConfig_connectorProfileName :: Lens' SourceFlowConfig (Maybe Text) Source #

The name of the connector profile. This name must be unique for each connector profile in the Amazon Web Services account.

sourceFlowConfig_incrementalPullConfig :: Lens' SourceFlowConfig (Maybe IncrementalPullConfig) Source #

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.

sourceFlowConfig_connectorType :: Lens' SourceFlowConfig ConnectorType Source #

The type of connector, such as Salesforce, Amplitude, and so on.

sourceFlowConfig_sourceConnectorProperties :: Lens' SourceFlowConfig SourceConnectorProperties Source #

Specifies the information that is required to query a particular source connector.

SupportedFieldTypeDetails

supportedFieldTypeDetails_v1 :: Lens' SupportedFieldTypeDetails FieldTypeDetails Source #

The initial supported version for fieldType. If this is later changed to a different version, v2 will be introduced.

Task

task_taskProperties :: Lens' Task (Maybe (HashMap OperatorPropertiesKeys Text)) Source #

A map used to store task-related information. The execution service looks for particular information based on the TaskType.

task_connectorOperator :: Lens' Task (Maybe ConnectorOperator) Source #

The operation to be performed on the provided source fields.

task_destinationField :: Lens' Task (Maybe Text) Source #

A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.

task_sourceFields :: Lens' Task [Text] Source #

The source fields to which a particular task is applied.

task_taskType :: Lens' Task TaskType Source #

Specifies the particular task implementation that Amazon AppFlow performs.

TrendmicroConnectorProfileCredentials

TrendmicroConnectorProfileProperties

TrendmicroMetadata

TrendmicroSourceProperties

trendmicroSourceProperties_object :: Lens' TrendmicroSourceProperties Text Source #

The object specified in the Trend Micro flow source.

TriggerConfig

triggerConfig_triggerProperties :: Lens' TriggerConfig (Maybe TriggerProperties) Source #

Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the Scheduled trigger type.

triggerConfig_triggerType :: Lens' TriggerConfig TriggerType Source #

Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.

TriggerProperties

triggerProperties_scheduled :: Lens' TriggerProperties (Maybe ScheduledTriggerProperties) Source #

Specifies the configuration details of a schedule-triggered flow as defined by the user.

UpsolverDestinationProperties

upsolverDestinationProperties_bucketPrefix :: Lens' UpsolverDestinationProperties (Maybe Text) Source #

The object key for the destination Upsolver Amazon S3 bucket in which Amazon AppFlow places the files.

upsolverDestinationProperties_bucketName :: Lens' UpsolverDestinationProperties Text Source #

The Upsolver Amazon S3 bucket name in which Amazon AppFlow places the transferred data.

upsolverDestinationProperties_s3OutputFormatConfig :: Lens' UpsolverDestinationProperties UpsolverS3OutputFormatConfig Source #

The configuration that determines how data is formatted when Upsolver is used as the flow destination.

UpsolverMetadata

UpsolverS3OutputFormatConfig

upsolverS3OutputFormatConfig_fileType :: Lens' UpsolverS3OutputFormatConfig (Maybe FileType) Source #

Indicates the file type that Amazon AppFlow places in the Upsolver Amazon S3 bucket.

VeevaConnectorProfileCredentials

VeevaConnectorProfileProperties

VeevaMetadata

VeevaSourceProperties

veevaSourceProperties_includeAllVersions :: Lens' VeevaSourceProperties (Maybe Bool) Source #

Boolean value to include All Versions of files in Veeva document extract flow.

veevaSourceProperties_documentType :: Lens' VeevaSourceProperties (Maybe Text) Source #

The document type specified in the Veeva document extract flow.

veevaSourceProperties_includeRenditions :: Lens' VeevaSourceProperties (Maybe Bool) Source #

Boolean value to include file renditions in Veeva document extract flow.

veevaSourceProperties_includeSourceFiles :: Lens' VeevaSourceProperties (Maybe Bool) Source #

Boolean value to include source files in Veeva document extract flow.

veevaSourceProperties_object :: Lens' VeevaSourceProperties Text Source #

The object specified in the Veeva flow source.

ZendeskConnectorProfileCredentials

zendeskConnectorProfileCredentials_accessToken :: Lens' ZendeskConnectorProfileCredentials (Maybe Text) Source #

The credentials used to access protected Zendesk resources.

zendeskConnectorProfileCredentials_oAuthRequest :: Lens' ZendeskConnectorProfileCredentials (Maybe ConnectorOAuthRequest) Source #

The OAuth requirement needed to request security tokens from the connector endpoint.

zendeskConnectorProfileCredentials_clientSecret :: Lens' ZendeskConnectorProfileCredentials Text Source #

The client secret used by the OAuth client to authenticate to the authorization server.

ZendeskConnectorProfileProperties

ZendeskDestinationProperties

zendeskDestinationProperties_object :: Lens' ZendeskDestinationProperties Text Source #

The object specified in the Zendesk flow destination.

ZendeskMetadata

zendeskMetadata_oAuthScopes :: Lens' ZendeskMetadata (Maybe [Text]) Source #

The desired authorization scope for the Zendesk account.

ZendeskSourceProperties

zendeskSourceProperties_object :: Lens' ZendeskSourceProperties Text Source #

The object specified in the Zendesk flow source.