Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AppFlow.Lens

Contents

Operations
Types

Description

Synopsis

Operations

CreateConnectorProfile

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

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

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.

createConnectorProfileResponse_connectorProfileArn :: Lens' CreateConnectorProfileResponse (Maybe Text) Source #

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

createConnectorProfileResponse_httpStatus :: Lens' CreateConnectorProfileResponse Int Source #

The response's http status code.

CreateFlow

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

A description of the flow you want to create.

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_metadataCatalogConfig :: Lens' CreateFlow (Maybe MetadataCatalogConfig) Source #

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.

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.

createFlowResponse_httpStatus :: Lens' CreateFlowResponse Int Source #

The response's http status code.

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.

deleteConnectorProfileResponse_httpStatus :: Lens' DeleteConnectorProfileResponse Int Source #

The response's http status code.

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.

deleteFlowResponse_httpStatus :: Lens' DeleteFlowResponse Int Source #

The response's http status code.

DescribeConnector

describeConnector_connectorLabel :: Lens' DescribeConnector (Maybe Text) Source #

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

describeConnector_connectorType :: Lens' DescribeConnector ConnectorType Source #

The connector type, such as CUSTOMCONNECTOR, Saleforce, Marketo. Please choose CUSTOMCONNECTOR for Lambda based custom connectors.

describeConnectorResponse_connectorConfiguration :: Lens' DescribeConnectorResponse (Maybe ConnectorConfiguration) Source #

Configuration info of all the connectors that the user requested.

describeConnectorResponse_httpStatus :: Lens' DescribeConnectorResponse Int Source #

The response's http status code.

DescribeConnectorEntity

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

The version of the API that's used by the connector.

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.

describeConnectorEntity_connectorEntityName :: Lens' DescribeConnectorEntity Text Source #

The entity name for that connector.

describeConnectorEntityResponse_httpStatus :: Lens' DescribeConnectorEntityResponse Int Source #

The response's http status code.

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.

DescribeConnectorProfiles

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

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

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

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

The pagination token for the next page of data.

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.

describeConnectorProfilesResponse_httpStatus :: Lens' DescribeConnectorProfilesResponse Int Source #

The response's http status code.

DescribeConnectors

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

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

describeConnectors_maxResults :: Lens' DescribeConnectors (Maybe Natural) Source #

The maximum number of items that should be returned in the result set. The default is 20.

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

The pagination token for the next page of data.

describeConnectorsResponse_connectorConfigurations :: Lens' DescribeConnectorsResponse (Maybe (HashMap ConnectorType ConnectorConfiguration)) Source #

The configuration that is applied to the connectors used in the flow.

describeConnectorsResponse_connectors :: Lens' DescribeConnectorsResponse (Maybe [ConnectorDetail]) Source #

Information about the connectors supported in Amazon AppFlow.

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

The pagination token for the next page of data.

describeConnectorsResponse_httpStatus :: Lens' DescribeConnectorsResponse Int Source #

The response's http status code.

DescribeFlow

describeFlow_flowName :: Lens' DescribeFlow Text Source #

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

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

Specifies when the flow was created.

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

The ARN of the user who created the flow.

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

A description of the flow.

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

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

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

The flow's Amazon Resource Name (ARN).

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

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

describeFlowResponse_flowStatus :: Lens' DescribeFlowResponse (Maybe FlowStatus) Source #

Indicates the current status of the flow.

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

Describes the details of the most recent flow run.

describeFlowResponse_lastRunMetadataCatalogDetails :: Lens' DescribeFlowResponse (Maybe [MetadataCatalogDetail]) Source #

Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.

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

Specifies when the flow was last updated.

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

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

describeFlowResponse_metadataCatalogConfig :: Lens' DescribeFlowResponse (Maybe MetadataCatalogConfig) Source #

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

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

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

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

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

The tags used to organize, track, or control access for your 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_httpStatus :: Lens' DescribeFlowResponse Int Source #

The response's http status code.

DescribeFlowExecutionRecords

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_nextToken :: Lens' DescribeFlowExecutionRecords (Maybe Text) Source #

The pagination token for the next page of data.

describeFlowExecutionRecords_flowName :: Lens' DescribeFlowExecutionRecords Text Source #

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

describeFlowExecutionRecordsResponse_flowExecutions :: Lens' DescribeFlowExecutionRecordsResponse (Maybe [ExecutionRecord]) Source #

Returns a list of all instances when this flow was run.

describeFlowExecutionRecordsResponse_nextToken :: Lens' DescribeFlowExecutionRecordsResponse (Maybe Text) Source #

The pagination token for the next page of data.

describeFlowExecutionRecordsResponse_httpStatus :: Lens' DescribeFlowExecutionRecordsResponse Int Source #

The response's http status code.

ListConnectorEntities

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

The version of the API that's used by the connector.

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_connectorType :: Lens' ListConnectorEntities (Maybe ConnectorType) Source #

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

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_maxResults :: Lens' ListConnectorEntities (Maybe Natural) Source #

The maximum number of items that the operation returns in the response.

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

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.

listConnectorEntitiesResponse_nextToken :: Lens' ListConnectorEntitiesResponse (Maybe Text) Source #

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.

listConnectorEntitiesResponse_httpStatus :: Lens' ListConnectorEntitiesResponse Int Source #

The response's http status code.

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.

ListConnectors

listConnectors_maxResults :: Lens' ListConnectors (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).

listConnectors_nextToken :: Lens' ListConnectors (Maybe Text) Source #

The pagination token for the next page of data.

listConnectorsResponse_connectors :: Lens' ListConnectorsResponse (Maybe [ConnectorDetail]) Source #

Contains information about the connectors supported by Amazon AppFlow.

listConnectorsResponse_nextToken :: Lens' ListConnectorsResponse (Maybe Text) Source #

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

listConnectorsResponse_httpStatus :: Lens' ListConnectorsResponse Int Source #

The response's http status code.

ListFlows

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

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

listFlows_nextToken :: Lens' ListFlows (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_nextToken :: Lens' ListFlowsResponse (Maybe Text) Source #

The pagination token for next page of data.

listFlowsResponse_httpStatus :: Lens' ListFlowsResponse 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.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

RegisterConnector

registerConnector_connectorLabel :: Lens' RegisterConnector (Maybe Text) Source #

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

registerConnector_connectorProvisioningConfig :: Lens' RegisterConnector (Maybe ConnectorProvisioningConfig) Source #

The provisioning type of the connector. Currently the only supported value is LAMBDA.

registerConnector_connectorProvisioningType :: Lens' RegisterConnector (Maybe ConnectorProvisioningType) Source #

The provisioning type of the connector. Currently the only supported value is LAMBDA.

registerConnector_description :: Lens' RegisterConnector (Maybe Text) Source #

A description about the connector that's being registered.

registerConnectorResponse_connectorArn :: Lens' RegisterConnectorResponse (Maybe Text) Source #

The ARN of the connector being registered.

registerConnectorResponse_httpStatus :: Lens' RegisterConnectorResponse Int Source #

The response's http status code.

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.

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.

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.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

UnregisterConnector

unregisterConnector_forceDelete :: Lens' UnregisterConnector (Maybe Bool) Source #

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.

unregisterConnector_connectorLabel :: Lens' UnregisterConnector Text Source #

The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web Services account.

unregisterConnectorResponse_httpStatus :: Lens' UnregisterConnectorResponse Int Source #

The response's http status code.

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.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

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.

updateConnectorProfileResponse_connectorProfileArn :: Lens' UpdateConnectorProfileResponse (Maybe Text) Source #

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

updateConnectorProfileResponse_httpStatus :: Lens' UpdateConnectorProfileResponse Int Source #

The response's http status code.

UpdateConnectorRegistration

updateConnectorRegistration_connectorProvisioningConfig :: Lens' UpdateConnectorRegistration (Maybe ConnectorProvisioningConfig) Source #

Undocumented member.

updateConnectorRegistration_description :: Lens' UpdateConnectorRegistration (Maybe Text) Source #

A description about the update that you're applying to the connector.

updateConnectorRegistration_connectorLabel :: Lens' UpdateConnectorRegistration Text Source #

The name of the connector. The name is unique for each connector registration in your AWS account.

updateConnectorRegistrationResponse_connectorArn :: Lens' UpdateConnectorRegistrationResponse (Maybe Text) Source #

The ARN of the connector being updated.

updateConnectorRegistrationResponse_httpStatus :: Lens' UpdateConnectorRegistrationResponse Int Source #

The response's http status code.

UpdateFlow

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

A description of the flow.

updateFlow_metadataCatalogConfig :: Lens' UpdateFlow (Maybe MetadataCatalogConfig) Source #

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.

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_sourceFlowConfig :: Lens' UpdateFlow SourceFlowConfig Source #

Undocumented member.

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.

updateFlowResponse_httpStatus :: Lens' UpdateFlowResponse Int Source #

The response's http status code.

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.

aggregationConfig_targetFileSize :: Lens' AggregationConfig (Maybe Integer) Source #

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.

AmplitudeConnectorProfileCredentials

amplitudeConnectorProfileCredentials_apiKey :: Lens' AmplitudeConnectorProfileCredentials Text Source #

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

amplitudeConnectorProfileCredentials_secretKey :: Lens' AmplitudeConnectorProfileCredentials Text Source #

The Secret Access Key portion of the credentials.

AmplitudeConnectorProfileProperties

AmplitudeMetadata

AmplitudeSourceProperties

amplitudeSourceProperties_object :: Lens' AmplitudeSourceProperties Text Source #

The object specified in the Amplitude flow source.

ApiKeyCredentials

apiKeyCredentials_apiSecretKey :: Lens' ApiKeyCredentials (Maybe Text) Source #

The API secret key required for API key authentication.

apiKeyCredentials_apiKey :: Lens' ApiKeyCredentials Text Source #

The API key required for API key authentication.

AuthParameter

authParameter_connectorSuppliedValues :: Lens' AuthParameter (Maybe [Text]) Source #

Contains default values for this authentication parameter that are supplied by the connector.

authParameter_description :: Lens' AuthParameter (Maybe Text) Source #

A description about the authentication parameter.

authParameter_isRequired :: Lens' AuthParameter (Maybe Bool) Source #

Indicates whether this authentication parameter is required.

authParameter_isSensitiveField :: Lens' AuthParameter (Maybe Bool) Source #

Indicates whether this authentication parameter is a sensitive field.

authParameter_key :: Lens' AuthParameter (Maybe Text) Source #

The authentication key required to authenticate with the connector.

authParameter_label :: Lens' AuthParameter (Maybe Text) Source #

Label used for authentication parameter.

AuthenticationConfig

authenticationConfig_customAuthConfigs :: Lens' AuthenticationConfig (Maybe [CustomAuthConfig]) Source #

Contains information required for custom authentication.

authenticationConfig_isApiKeyAuthSupported :: Lens' AuthenticationConfig (Maybe Bool) Source #

Indicates whether API key authentication is supported by the connector

authenticationConfig_isBasicAuthSupported :: Lens' AuthenticationConfig (Maybe Bool) Source #

Indicates whether basic authentication is supported by the connector.

authenticationConfig_isCustomAuthSupported :: Lens' AuthenticationConfig (Maybe Bool) Source #

Indicates whether custom authentication is supported by the connector

authenticationConfig_isOAuth2Supported :: Lens' AuthenticationConfig (Maybe Bool) Source #

Indicates whether OAuth 2.0 authentication is supported by the connector.

authenticationConfig_oAuth2Defaults :: Lens' AuthenticationConfig (Maybe OAuth2Defaults) Source #

Contains the default values required for OAuth 2.0 authentication.

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_authenticationConfig :: Lens' ConnectorConfiguration (Maybe AuthenticationConfig) Source #

The authentication config required for the connector.

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

Specifies whether the connector can be used as a destination.

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

Specifies whether the connector can be used as a source.

connectorConfiguration_connectorArn :: Lens' ConnectorConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) for the registered connector.

connectorConfiguration_connectorDescription :: Lens' ConnectorConfiguration (Maybe Text) Source #

A description about the connector.

connectorConfiguration_connectorLabel :: Lens' ConnectorConfiguration (Maybe Text) Source #

The label used for registering the connector.

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

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

connectorConfiguration_connectorModes :: Lens' ConnectorConfiguration (Maybe [Text]) Source #

The connection modes that the connector supports.

connectorConfiguration_connectorName :: Lens' ConnectorConfiguration (Maybe Text) Source #

The connector name.

connectorConfiguration_connectorOwner :: Lens' ConnectorConfiguration (Maybe Text) Source #

The owner who developed the connector.

connectorConfiguration_connectorProvisioningConfig :: Lens' ConnectorConfiguration (Maybe ConnectorProvisioningConfig) Source #

The configuration required for registering the connector.

connectorConfiguration_connectorProvisioningType :: Lens' ConnectorConfiguration (Maybe ConnectorProvisioningType) Source #

The provisioning type used to register the connector.

connectorConfiguration_connectorRuntimeSettings :: Lens' ConnectorConfiguration (Maybe [ConnectorRuntimeSetting]) Source #

The required connector runtime settings.

connectorConfiguration_connectorType :: Lens' ConnectorConfiguration (Maybe ConnectorType) Source #

The connector type.

connectorConfiguration_connectorVersion :: Lens' ConnectorConfiguration (Maybe Text) Source #

The connector version.

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

Specifies if PrivateLink is enabled for that connector.

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

Specifies if a PrivateLink endpoint URL is required.

connectorConfiguration_logoURL :: Lens' ConnectorConfiguration (Maybe Text) Source #

Logo URL of the connector.

connectorConfiguration_registeredAt :: Lens' ConnectorConfiguration (Maybe UTCTime) Source #

The date on which the connector was registered.

connectorConfiguration_registeredBy :: Lens' ConnectorConfiguration (Maybe Text) Source #

Information about who registered the connector.

connectorConfiguration_supportedApiVersions :: Lens' ConnectorConfiguration (Maybe [Text]) Source #

A list of API versions that are supported by the connector.

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

Lists the connectors that are available for use as destinations.

connectorConfiguration_supportedOperators :: Lens' ConnectorConfiguration (Maybe [Operators]) Source #

A list of operators supported by the connector.

connectorConfiguration_supportedSchedulingFrequencies :: Lens' ConnectorConfiguration (Maybe [ScheduleFrequencyType]) Source #

Specifies the supported flow frequency for that connector.

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

Specifies the supported trigger types for the flow.

connectorConfiguration_supportedWriteOperations :: Lens' ConnectorConfiguration (Maybe [WriteOperationType]) Source #

A list of write operations supported by the connector.

ConnectorDetail

connectorDetail_applicationType :: Lens' ConnectorDetail (Maybe Text) Source #

The application type of the connector.

connectorDetail_connectorDescription :: Lens' ConnectorDetail (Maybe Text) Source #

A description about the registered connector.

connectorDetail_connectorLabel :: Lens' ConnectorDetail (Maybe Text) Source #

A label used for the connector.

connectorDetail_connectorModes :: Lens' ConnectorDetail (Maybe [Text]) Source #

The connection mode that the connector supports.

connectorDetail_connectorName :: Lens' ConnectorDetail (Maybe Text) Source #

The name of the connector.

connectorDetail_connectorOwner :: Lens' ConnectorDetail (Maybe Text) Source #

The owner of the connector.

connectorDetail_connectorProvisioningType :: Lens' ConnectorDetail (Maybe ConnectorProvisioningType) Source #

The provisioning type that the connector uses.

connectorDetail_connectorType :: Lens' ConnectorDetail (Maybe ConnectorType) Source #

The connector type.

connectorDetail_connectorVersion :: Lens' ConnectorDetail (Maybe Text) Source #

The connector version.

connectorDetail_registeredAt :: Lens' ConnectorDetail (Maybe UTCTime) Source #

The time at which the connector was registered.

connectorDetail_registeredBy :: Lens' ConnectorDetail (Maybe Text) Source #

The user who registered the connector.

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_customProperties :: Lens' ConnectorEntityField (Maybe (HashMap Text Text)) Source #

A map that has specific properties related to the ConnectorEntityField.

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

Default value that can be assigned to this field.

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

A description of the connector entity field.

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

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

connectorEntityField_isDeprecated :: Lens' ConnectorEntityField (Maybe Bool) Source #

Booelan value that indicates whether this field is deprecated or not.

connectorEntityField_isPrimaryKey :: Lens' ConnectorEntityField (Maybe Bool) Source #

Booelan value that indicates whether this field can be used as a primary key.

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

The label applied to a connector entity field.

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

The parent identifier of the connector field.

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_identifier :: Lens' ConnectorEntityField Text Source #

The unique identifier of the connector field.

ConnectorMetadata

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_dynatrace :: Lens' ConnectorMetadata (Maybe DynatraceMetadata) Source #

The connector metadata specific to Dynatrace.

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

The connector metadata specific to Amazon EventBridge.

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

The connector metadata specific to Google Analytics.

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

The connector metadata specific to Amazon Honeycode.

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

The connector metadata specific to Infor Nexus.

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

The connector metadata specific to Marketo.

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

The connector metadata specific to Amazon Redshift.

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

The connector metadata specific to Amazon S3.

connectorMetadata_sAPOData :: Lens' ConnectorMetadata (Maybe SAPODataMetadata) Source #

Undocumented member.

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

The connector metadata specific to Salesforce.

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

The connector metadata specific to ServiceNow.

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

The connector metadata specific to Singular.

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

The connector metadata specific to Slack.

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

The connector metadata specific to Snowflake.

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

The connector metadata specific to Trend Micro.

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

The connector metadata specific to Upsolver.

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

The connector metadata specific to Veeva.

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

The connector metadata specific to Zendesk.

ConnectorOAuthRequest

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

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

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

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

ConnectorOperator

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

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

connectorOperator_customConnector :: Lens' ConnectorOperator (Maybe Operator) Source #

Operators supported by the custom connector.

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

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

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

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

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

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

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

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

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

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

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

The operation to be performed on the provided Amazon S3 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_serviceNow :: Lens' ConnectorOperator (Maybe ServiceNowConnectorOperator) Source #

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

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

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

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

The operation to be performed on the provided Slack 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.

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

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

ConnectorProfile

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

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

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

The label for the connector profile being created.

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

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

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_connectorProfileProperties :: Lens' ConnectorProfile (Maybe ConnectorProfileProperties) Source #

The connector-specific properties of the profile configuration.

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

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

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_lastUpdatedAt :: Lens' ConnectorProfile (Maybe UTCTime) Source #

Specifies when the connector profile was last updated.

connectorProfile_privateConnectionProvisioningState :: Lens' ConnectorProfile (Maybe PrivateConnectionProvisioningState) Source #

Specifies the private connection provisioning state.

ConnectorProfileConfig

connectorProfileConfig_connectorProfileCredentials :: Lens' ConnectorProfileConfig (Maybe ConnectorProfileCredentials) Source #

The connector-specific credentials required by each connector.

connectorProfileConfig_connectorProfileProperties :: Lens' ConnectorProfileConfig ConnectorProfileProperties Source #

The connector-specific properties of the profile configuration.

ConnectorProfileCredentials

connectorProfileCredentials_amplitude :: Lens' ConnectorProfileCredentials (Maybe AmplitudeConnectorProfileCredentials) Source #

The connector-specific credentials required when using Amplitude.

connectorProfileCredentials_customConnector :: Lens' ConnectorProfileCredentials (Maybe CustomConnectorProfileCredentials) Source #

Undocumented member.

connectorProfileCredentials_datadog :: Lens' ConnectorProfileCredentials (Maybe DatadogConnectorProfileCredentials) Source #

The connector-specific credentials required when using Datadog.

connectorProfileCredentials_dynatrace :: Lens' ConnectorProfileCredentials (Maybe DynatraceConnectorProfileCredentials) Source #

The connector-specific credentials required when using Dynatrace.

connectorProfileCredentials_googleAnalytics :: Lens' ConnectorProfileCredentials (Maybe GoogleAnalyticsConnectorProfileCredentials) Source #

The connector-specific credentials required when using Google Analytics.

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

The connector-specific credentials required when using Amazon Honeycode.

connectorProfileCredentials_inforNexus :: Lens' ConnectorProfileCredentials (Maybe InforNexusConnectorProfileCredentials) Source #

The connector-specific credentials required when using Infor Nexus.

connectorProfileCredentials_marketo :: Lens' ConnectorProfileCredentials (Maybe MarketoConnectorProfileCredentials) Source #

The connector-specific credentials required when using Marketo.

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

The connector-specific credentials required when using Amazon Redshift.

connectorProfileCredentials_sAPOData :: Lens' ConnectorProfileCredentials (Maybe SAPODataConnectorProfileCredentials) Source #

Undocumented member.

connectorProfileCredentials_salesforce :: Lens' ConnectorProfileCredentials (Maybe SalesforceConnectorProfileCredentials) Source #

The connector-specific credentials required when using Salesforce.

connectorProfileCredentials_serviceNow :: Lens' ConnectorProfileCredentials (Maybe ServiceNowConnectorProfileCredentials) Source #

The connector-specific credentials required when using ServiceNow.

connectorProfileCredentials_singular :: Lens' ConnectorProfileCredentials (Maybe SingularConnectorProfileCredentials) Source #

The connector-specific credentials required when using Singular.

connectorProfileCredentials_slack :: Lens' ConnectorProfileCredentials (Maybe SlackConnectorProfileCredentials) Source #

The connector-specific credentials required when using Slack.

connectorProfileCredentials_snowflake :: Lens' ConnectorProfileCredentials (Maybe SnowflakeConnectorProfileCredentials) Source #

The connector-specific credentials required when using Snowflake.

connectorProfileCredentials_trendmicro :: Lens' ConnectorProfileCredentials (Maybe TrendmicroConnectorProfileCredentials) Source #

The connector-specific credentials required when using Trend Micro.

connectorProfileCredentials_veeva :: Lens' ConnectorProfileCredentials (Maybe VeevaConnectorProfileCredentials) Source #

The connector-specific credentials required when using Veeva.

connectorProfileCredentials_zendesk :: Lens' ConnectorProfileCredentials (Maybe ZendeskConnectorProfileCredentials) Source #

The connector-specific credentials required when using Zendesk.

ConnectorProfileProperties

connectorProfileProperties_amplitude :: Lens' ConnectorProfileProperties (Maybe AmplitudeConnectorProfileProperties) Source #

The connector-specific properties required by Amplitude.

connectorProfileProperties_customConnector :: Lens' ConnectorProfileProperties (Maybe CustomConnectorProfileProperties) Source #

The properties required by the custom connector.

connectorProfileProperties_datadog :: Lens' ConnectorProfileProperties (Maybe DatadogConnectorProfileProperties) Source #

The connector-specific properties required by Datadog.

connectorProfileProperties_dynatrace :: Lens' ConnectorProfileProperties (Maybe DynatraceConnectorProfileProperties) Source #

The connector-specific properties required by Dynatrace.

connectorProfileProperties_googleAnalytics :: Lens' ConnectorProfileProperties (Maybe GoogleAnalyticsConnectorProfileProperties) Source #

The connector-specific properties required Google Analytics.

connectorProfileProperties_honeycode :: Lens' ConnectorProfileProperties (Maybe HoneycodeConnectorProfileProperties) Source #

The connector-specific properties required by Amazon Honeycode.

connectorProfileProperties_inforNexus :: Lens' ConnectorProfileProperties (Maybe InforNexusConnectorProfileProperties) Source #

The connector-specific properties required by Infor Nexus.

connectorProfileProperties_marketo :: Lens' ConnectorProfileProperties (Maybe MarketoConnectorProfileProperties) Source #

The connector-specific properties required by Marketo.

connectorProfileProperties_redshift :: Lens' ConnectorProfileProperties (Maybe RedshiftConnectorProfileProperties) Source #

The connector-specific properties required by Amazon Redshift.

connectorProfileProperties_sAPOData :: Lens' ConnectorProfileProperties (Maybe SAPODataConnectorProfileProperties) Source #

Undocumented member.

connectorProfileProperties_salesforce :: Lens' ConnectorProfileProperties (Maybe SalesforceConnectorProfileProperties) Source #

The connector-specific properties required by Salesforce.

connectorProfileProperties_serviceNow :: Lens' ConnectorProfileProperties (Maybe ServiceNowConnectorProfileProperties) Source #

The connector-specific properties required by serviceNow.

connectorProfileProperties_singular :: Lens' ConnectorProfileProperties (Maybe SingularConnectorProfileProperties) Source #

The connector-specific properties required by Singular.

connectorProfileProperties_slack :: Lens' ConnectorProfileProperties (Maybe SlackConnectorProfileProperties) Source #

The connector-specific properties required by Slack.

connectorProfileProperties_snowflake :: Lens' ConnectorProfileProperties (Maybe SnowflakeConnectorProfileProperties) Source #

The connector-specific properties required by Snowflake.

connectorProfileProperties_trendmicro :: Lens' ConnectorProfileProperties (Maybe TrendmicroConnectorProfileProperties) Source #

The connector-specific properties required by Trend Micro.

connectorProfileProperties_veeva :: Lens' ConnectorProfileProperties (Maybe VeevaConnectorProfileProperties) Source #

The connector-specific properties required by Veeva.

connectorProfileProperties_zendesk :: Lens' ConnectorProfileProperties (Maybe ZendeskConnectorProfileProperties) Source #

The connector-specific properties required by Zendesk.

ConnectorProvisioningConfig

connectorProvisioningConfig_lambda :: Lens' ConnectorProvisioningConfig (Maybe LambdaConnectorProvisioningConfig) Source #

Contains information about the configuration of the lambda which is being registered as the connector.

ConnectorRuntimeSetting

connectorRuntimeSetting_connectorSuppliedValueOptions :: Lens' ConnectorRuntimeSetting (Maybe [Text]) Source #

Contains default values for the connector runtime setting that are supplied by the connector.

connectorRuntimeSetting_dataType :: Lens' ConnectorRuntimeSetting (Maybe Text) Source #

Data type of the connector runtime setting.

connectorRuntimeSetting_description :: Lens' ConnectorRuntimeSetting (Maybe Text) Source #

A description about the connector runtime setting.

connectorRuntimeSetting_isRequired :: Lens' ConnectorRuntimeSetting (Maybe Bool) Source #

Indicates whether this connector runtime setting is required.

connectorRuntimeSetting_key :: Lens' ConnectorRuntimeSetting (Maybe Text) Source #

Contains value information about the connector runtime setting.

connectorRuntimeSetting_label :: Lens' ConnectorRuntimeSetting (Maybe Text) Source #

A label used for connector runtime setting.

connectorRuntimeSetting_scope :: Lens' ConnectorRuntimeSetting (Maybe Text) Source #

Indicates the scope of the connector runtime setting.

CustomAuthConfig

customAuthConfig_authParameters :: Lens' CustomAuthConfig (Maybe [AuthParameter]) Source #

Information about authentication parameters required for authentication.

customAuthConfig_customAuthenticationType :: Lens' CustomAuthConfig (Maybe Text) Source #

The authentication type that the custom connector uses.

CustomAuthCredentials

customAuthCredentials_credentialsMap :: Lens' CustomAuthCredentials (Maybe (HashMap Text Text)) Source #

A map that holds custom authentication credentials.

customAuthCredentials_customAuthenticationType :: Lens' CustomAuthCredentials Text Source #

The custom authentication type that the connector uses.

CustomConnectorDestinationProperties

customConnectorDestinationProperties_customProperties :: Lens' CustomConnectorDestinationProperties (Maybe (HashMap Text Text)) Source #

The custom properties that are specific to the connector when it's used as a destination in the flow.

customConnectorDestinationProperties_errorHandlingConfig :: Lens' CustomConnectorDestinationProperties (Maybe ErrorHandlingConfig) Source #

The settings that determine how Amazon AppFlow handles an error when placing data in the custom connector as destination.

customConnectorDestinationProperties_idFieldNames :: Lens' CustomConnectorDestinationProperties (Maybe [Text]) Source #

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

customConnectorDestinationProperties_writeOperationType :: Lens' CustomConnectorDestinationProperties (Maybe WriteOperationType) Source #

Specifies the type of write operation to be performed in the custom connector when it's used as destination.

customConnectorDestinationProperties_entityName :: Lens' CustomConnectorDestinationProperties Text Source #

The entity specified in the custom connector as a destination in the flow.

CustomConnectorProfileCredentials

customConnectorProfileCredentials_apiKey :: Lens' CustomConnectorProfileCredentials (Maybe ApiKeyCredentials) Source #

The API keys required for the authentication of the user.

customConnectorProfileCredentials_basic :: Lens' CustomConnectorProfileCredentials (Maybe BasicAuthCredentials) Source #

The basic credentials that are required for the authentication of the user.

customConnectorProfileCredentials_custom :: Lens' CustomConnectorProfileCredentials (Maybe CustomAuthCredentials) Source #

If the connector uses the custom authentication mechanism, this holds the required credentials.

customConnectorProfileCredentials_oauth2 :: Lens' CustomConnectorProfileCredentials (Maybe OAuth2Credentials) Source #

The OAuth 2.0 credentials required for the authentication of the user.

customConnectorProfileCredentials_authenticationType :: Lens' CustomConnectorProfileCredentials AuthenticationType Source #

The authentication type that the custom connector uses for authenticating while creating a connector profile.

CustomConnectorProfileProperties

customConnectorProfileProperties_oAuth2Properties :: Lens' CustomConnectorProfileProperties (Maybe OAuth2Properties) Source #

Undocumented member.

customConnectorProfileProperties_profileProperties :: Lens' CustomConnectorProfileProperties (Maybe (HashMap Text Text)) Source #

A map of properties that are required to create a profile for the custom connector.

CustomConnectorSourceProperties

customConnectorSourceProperties_customProperties :: Lens' CustomConnectorSourceProperties (Maybe (HashMap Text Text)) Source #

Custom properties that are required to use the custom connector as a source.

customConnectorSourceProperties_entityName :: Lens' CustomConnectorSourceProperties Text Source #

The entity specified in the custom connector as a source in the flow.

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

datadogConnectorProfileProperties_instanceUrl :: Lens' DatadogConnectorProfileProperties Text Source #

The location of the Datadog resource.

DatadogMetadata

DatadogSourceProperties

datadogSourceProperties_object :: Lens' DatadogSourceProperties Text Source #

The object specified in the Datadog flow source.

DestinationConnectorProperties

destinationConnectorProperties_customConnector :: Lens' DestinationConnectorProperties (Maybe CustomConnectorDestinationProperties) Source #

The properties that are required to query the custom Connector.

destinationConnectorProperties_customerProfiles :: Lens' DestinationConnectorProperties (Maybe CustomerProfilesDestinationProperties) Source #

The properties required to query Amazon Connect Customer Profiles.

destinationConnectorProperties_eventBridge :: Lens' DestinationConnectorProperties (Maybe EventBridgeDestinationProperties) Source #

The properties required to query Amazon EventBridge.

destinationConnectorProperties_honeycode :: Lens' DestinationConnectorProperties (Maybe HoneycodeDestinationProperties) Source #

The properties required to query Amazon Honeycode.

destinationConnectorProperties_lookoutMetrics :: Lens' DestinationConnectorProperties (Maybe LookoutMetricsDestinationProperties) Source #

The properties required to query Amazon Lookout for Metrics.

destinationConnectorProperties_marketo :: Lens' DestinationConnectorProperties (Maybe MarketoDestinationProperties) Source #

The properties required to query Marketo.

destinationConnectorProperties_redshift :: Lens' DestinationConnectorProperties (Maybe RedshiftDestinationProperties) Source #

The properties required to query Amazon Redshift.

destinationConnectorProperties_s3 :: Lens' DestinationConnectorProperties (Maybe S3DestinationProperties) Source #

The properties required to query Amazon S3.

destinationConnectorProperties_sAPOData :: Lens' DestinationConnectorProperties (Maybe SAPODataDestinationProperties) Source #

The properties required to query SAPOData.

destinationConnectorProperties_salesforce :: Lens' DestinationConnectorProperties (Maybe SalesforceDestinationProperties) Source #

The properties required to query Salesforce.

destinationConnectorProperties_snowflake :: Lens' DestinationConnectorProperties (Maybe SnowflakeDestinationProperties) Source #

The properties required to query Snowflake.

destinationConnectorProperties_upsolver :: Lens' DestinationConnectorProperties (Maybe UpsolverDestinationProperties) Source #

The properties required to query Upsolver.

destinationConnectorProperties_zendesk :: Lens' DestinationConnectorProperties (Maybe ZendeskDestinationProperties) Source #

The properties required to query Zendesk.

DestinationFieldProperties

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

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

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

Specifies whether the field can use the default value during a Create operation.

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

Specifies if the destination field can have a null value.

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

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

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

DestinationFlowConfig

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

The API version that the destination connector uses.

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

dynatraceConnectorProfileProperties_instanceUrl :: Lens' DynatraceConnectorProfileProperties Text Source #

The location of the Dynatrace resource.

DynatraceMetadata

DynatraceSourceProperties

dynatraceSourceProperties_object :: Lens' DynatraceSourceProperties Text Source #

The object specified in the Dynatrace flow source.

ErrorHandlingConfig

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

Specifies the name of the Amazon S3 bucket.

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

Specifies the Amazon S3 bucket prefix.

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.

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_errorHandlingConfig :: Lens' EventBridgeDestinationProperties (Maybe ErrorHandlingConfig) Source #

Undocumented member.

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_dataPullEndTime :: Lens' ExecutionRecord (Maybe UTCTime) Source #

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

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_executionId :: Lens' ExecutionRecord (Maybe Text) Source #

Specifies the identifier of the given flow run.

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

Describes the result of the given 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_lastUpdatedAt :: Lens' ExecutionRecord (Maybe UTCTime) Source #

Specifies the time of the most recent update.

executionRecord_metadataCatalogDetails :: Lens' ExecutionRecord (Maybe [MetadataCatalogDetail]) Source #

Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.

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

Specifies the start time of the flow run.

ExecutionResult

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

The total number of bytes processed by the flow run.

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

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

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

Provides any error message information related to the flow run.

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

The number of records processed in the flow run.

FieldTypeDetails

fieldTypeDetails_fieldLengthRange :: Lens' FieldTypeDetails (Maybe Range) Source #

This is the allowable length range for this field's value.

fieldTypeDetails_fieldValueRange :: Lens' FieldTypeDetails (Maybe Range) Source #

The range of values this field can hold.

fieldTypeDetails_supportedDateFormat :: Lens' FieldTypeDetails (Maybe Text) Source #

The date format that the field supports.

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_valueRegexPattern :: Lens' FieldTypeDetails (Maybe Text) Source #

The regular expression pattern for the field name.

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_createdAt :: Lens' FlowDefinition (Maybe UTCTime) Source #

Specifies when the flow was created.

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

The ARN of the user who created the flow.

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

A user-entered description of the flow.

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

The label of the destination connector in the flow.

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

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

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

The flow's Amazon Resource Name (ARN).

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

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

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

Indicates the current status of the flow.

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

Describes the details of the most recent flow run.

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

Specifies when the flow was last updated.

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

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

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

The label of the source connector in the flow.

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

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

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

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

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

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

GlueDataCatalogConfig

glueDataCatalogConfig_roleArn :: Lens' GlueDataCatalogConfig Text Source #

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.

glueDataCatalogConfig_databaseName :: Lens' GlueDataCatalogConfig Text Source #

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.

glueDataCatalogConfig_tablePrefix :: Lens' GlueDataCatalogConfig Text Source #

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.

GoogleAnalyticsConnectorProfileCredentials

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

The credentials used to access protected Google Analytics resources.

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

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

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_clientId :: Lens' GoogleAnalyticsConnectorProfileCredentials Text Source #

The identifier for the desired client.

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.

honeycodeConnectorProfileCredentials_oAuthRequest :: Lens' HoneycodeConnectorProfileCredentials (Maybe ConnectorOAuthRequest) Source #

Undocumented member.

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

The credentials used to acquire new access tokens.

HoneycodeConnectorProfileProperties

HoneycodeDestinationProperties

honeycodeDestinationProperties_errorHandlingConfig :: Lens' HoneycodeDestinationProperties (Maybe ErrorHandlingConfig) Source #

Undocumented member.

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

inforNexusConnectorProfileCredentials_accessKeyId :: Lens' InforNexusConnectorProfileCredentials Text Source #

The Access Key portion of the credentials.

inforNexusConnectorProfileCredentials_userId :: Lens' InforNexusConnectorProfileCredentials Text Source #

The identifier for the user.

inforNexusConnectorProfileCredentials_secretAccessKey :: Lens' InforNexusConnectorProfileCredentials Text Source #

The secret key used to sign requests.

inforNexusConnectorProfileCredentials_datakey :: Lens' InforNexusConnectorProfileCredentials Text Source #

The encryption keys used to encrypt data.

InforNexusConnectorProfileProperties

inforNexusConnectorProfileProperties_instanceUrl :: Lens' InforNexusConnectorProfileProperties Text Source #

The location of the Infor Nexus resource.

InforNexusMetadata

InforNexusSourceProperties

inforNexusSourceProperties_object :: Lens' InforNexusSourceProperties Text Source #

The object specified in the Infor Nexus flow source.

LambdaConnectorProvisioningConfig

lambdaConnectorProvisioningConfig_lambdaArn :: Lens' LambdaConnectorProvisioningConfig Text Source #

Lambda ARN of the connector being registered.

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_clientId :: Lens' MarketoConnectorProfileCredentials Text Source #

The identifier for the desired client.

marketoConnectorProfileCredentials_clientSecret :: Lens' MarketoConnectorProfileCredentials Text Source #

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

MarketoConnectorProfileProperties

marketoConnectorProfileProperties_instanceUrl :: Lens' MarketoConnectorProfileProperties Text Source #

The location of the Marketo resource.

MarketoDestinationProperties

marketoDestinationProperties_errorHandlingConfig :: Lens' MarketoDestinationProperties (Maybe ErrorHandlingConfig) Source #

Undocumented member.

marketoDestinationProperties_object :: Lens' MarketoDestinationProperties Text Source #

The object specified in the Marketo flow destination.

MarketoMetadata

MarketoSourceProperties

marketoSourceProperties_object :: Lens' MarketoSourceProperties Text Source #

The object specified in the Marketo flow source.

MetadataCatalogConfig

metadataCatalogConfig_glueDataCatalog :: Lens' MetadataCatalogConfig (Maybe GlueDataCatalogConfig) Source #

Specifies the configuration that Amazon AppFlow uses when it catalogs your data with the Glue Data Catalog.

MetadataCatalogDetail

metadataCatalogDetail_catalogType :: Lens' MetadataCatalogDetail (Maybe CatalogType) Source #

The type of metadata catalog that Amazon AppFlow used for the associated flow run. This parameter returns the following value:

GLUE: The metadata catalog is provided by the Glue Data Catalog. Glue includes the Glue Data Catalog as a component.

metadataCatalogDetail_partitionRegistrationOutput :: Lens' MetadataCatalogDetail (Maybe RegistrationOutput) Source #

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.

metadataCatalogDetail_tableName :: Lens' MetadataCatalogDetail (Maybe Text) Source #

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.

metadataCatalogDetail_tableRegistrationOutput :: Lens' MetadataCatalogDetail (Maybe RegistrationOutput) Source #

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.

OAuth2Credentials

oAuth2Credentials_accessToken :: Lens' OAuth2Credentials (Maybe Text) Source #

The access token used to access the connector on your behalf.

oAuth2Credentials_clientId :: Lens' OAuth2Credentials (Maybe Text) Source #

The identifier for the desired client.

oAuth2Credentials_clientSecret :: Lens' OAuth2Credentials (Maybe Text) Source #

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

oAuth2Credentials_oAuthRequest :: Lens' OAuth2Credentials (Maybe ConnectorOAuthRequest) Source #

Undocumented member.

oAuth2Credentials_refreshToken :: Lens' OAuth2Credentials (Maybe Text) Source #

The refresh token used to refresh an expired access token.

OAuth2CustomParameter

oAuth2CustomParameter_connectorSuppliedValues :: Lens' OAuth2CustomParameter (Maybe [Text]) Source #

Contains default values for this authentication parameter that are supplied by the connector.

oAuth2CustomParameter_description :: Lens' OAuth2CustomParameter (Maybe Text) Source #

A description about the custom parameter used for OAuth 2.0 authentication.

oAuth2CustomParameter_isRequired :: Lens' OAuth2CustomParameter (Maybe Bool) Source #

Indicates whether the custom parameter for OAuth 2.0 authentication is required.

oAuth2CustomParameter_isSensitiveField :: Lens' OAuth2CustomParameter (Maybe Bool) Source #

Indicates whether this authentication custom parameter is a sensitive field.

oAuth2CustomParameter_key :: Lens' OAuth2CustomParameter (Maybe Text) Source #

The key of the custom parameter required for OAuth 2.0 authentication.

oAuth2CustomParameter_label :: Lens' OAuth2CustomParameter (Maybe Text) Source #

The label of the custom parameter used for OAuth 2.0 authentication.

oAuth2CustomParameter_type :: Lens' OAuth2CustomParameter (Maybe OAuth2CustomPropType) Source #

Indicates whether custom parameter is used with TokenUrl or AuthUrl.

OAuth2Defaults

oAuth2Defaults_authCodeUrls :: Lens' OAuth2Defaults (Maybe [Text]) Source #

Auth code URLs that can be used for OAuth 2.0 authentication.

oAuth2Defaults_oauth2CustomProperties :: Lens' OAuth2Defaults (Maybe [OAuth2CustomParameter]) Source #

List of custom parameters required for OAuth 2.0 authentication.

oAuth2Defaults_oauth2GrantTypesSupported :: Lens' OAuth2Defaults (Maybe [OAuth2GrantType]) Source #

OAuth 2.0 grant types supported by the connector.

oAuth2Defaults_oauthScopes :: Lens' OAuth2Defaults (Maybe [Text]) Source #

OAuth 2.0 scopes that the connector supports.

oAuth2Defaults_tokenUrls :: Lens' OAuth2Defaults (Maybe [Text]) Source #

Token URLs that can be used for OAuth 2.0 authentication.

OAuth2Properties

oAuth2Properties_tokenUrlCustomProperties :: Lens' OAuth2Properties (Maybe (HashMap Text Text)) Source #

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.

oAuth2Properties_tokenUrl :: Lens' OAuth2Properties Text Source #

The token URL required for OAuth 2.0 authentication.

oAuth2Properties_oAuth2GrantType :: Lens' OAuth2Properties OAuth2GrantType Source #

The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.

OAuthCredentials

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

The access token used to access protected SAPOData resources.

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

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

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

The refresh token used to refresh expired access token.

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_pathPrefixHierarchy :: Lens' PrefixConfig (Maybe [PathPrefix]) Source #

Specifies whether the destination file path includes either or both of the following elements:

EXECUTION_ID

The ID that Amazon AppFlow assigns to the flow run.

SCHEMA_VERSION

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

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

Determines the level of granularity for the date and time 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_failureCause :: Lens' PrivateConnectionProvisioningState (Maybe PrivateConnectionProvisioningFailureCause) Source #

Specifies the private connection provisioning failure cause.

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

Specifies the private connection provisioning failure reason.

privateConnectionProvisioningState_status :: Lens' PrivateConnectionProvisioningState (Maybe PrivateConnectionProvisioningStatus) Source #

Specifies the private connection provisioning status.

Range

range_maximum :: Lens' Range (Maybe Double) Source #

Maximum value supported by the field.

range_minimum :: Lens' Range (Maybe Double) Source #

Minimum value supported by the field.

RedshiftConnectorProfileCredentials

redshiftConnectorProfileCredentials_password :: Lens' RedshiftConnectorProfileCredentials (Maybe Text) Source #

The password that corresponds to the user name.

redshiftConnectorProfileCredentials_username :: Lens' RedshiftConnectorProfileCredentials (Maybe Text) Source #

The name of the user.

RedshiftConnectorProfileProperties

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

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

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

The unique ID that's assigned to an Amazon Redshift cluster.

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

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.

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

The name of an Amazon Redshift database.

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

The JDBC URL of the Amazon Redshift cluster.

redshiftConnectorProfileProperties_isRedshiftServerless :: Lens' RedshiftConnectorProfileProperties (Maybe Bool) Source #

Indicates whether the connector profile defines a connection to an Amazon Redshift Serverless data warehouse.

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

The name of an Amazon Redshift workgroup.

redshiftConnectorProfileProperties_bucketName :: Lens' RedshiftConnectorProfileProperties Text Source #

A name for the associated Amazon S3 bucket.

redshiftConnectorProfileProperties_roleArn :: Lens' RedshiftConnectorProfileProperties Text Source #

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.

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

RegistrationOutput

registrationOutput_message :: Lens' RegistrationOutput (Maybe Text) Source #

Explains the status of the registration attempt from Amazon AppFlow. If the attempt fails, the message explains why.

registrationOutput_result :: Lens' RegistrationOutput (Maybe Text) Source #

Indicates the number of resources that Amazon AppFlow created or updated. Possible resources include metadata tables and data partitions.

registrationOutput_status :: Lens' RegistrationOutput (Maybe ExecutionStatus) Source #

Indicates the status of the registration attempt from Amazon AppFlow.

S3DestinationProperties

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

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

s3DestinationProperties_s3OutputFormatConfig :: Lens' S3DestinationProperties (Maybe S3OutputFormatConfig) Source #

Undocumented member.

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_aggregationConfig :: Lens' S3OutputFormatConfig (Maybe AggregationConfig) Source #

Undocumented member.

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

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

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

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.

S3SourceProperties

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

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

s3SourceProperties_s3InputFormatConfig :: Lens' S3SourceProperties (Maybe S3InputFormatConfig) Source #

Undocumented member.

s3SourceProperties_bucketName :: Lens' S3SourceProperties Text Source #

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

SAPODataConnectorProfileCredentials

sAPODataConnectorProfileCredentials_basicAuthCredentials :: Lens' SAPODataConnectorProfileCredentials (Maybe BasicAuthCredentials) Source #

The SAPOData basic authentication credentials.

sAPODataConnectorProfileCredentials_oAuthCredentials :: Lens' SAPODataConnectorProfileCredentials (Maybe OAuthCredentials) Source #

The SAPOData OAuth type authentication credentials.

SAPODataConnectorProfileProperties

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

The logon language of SAPOData instance.

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

The SAPOData OAuth properties required for OAuth type authentication.

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

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

sAPODataConnectorProfileProperties_applicationHostUrl :: Lens' SAPODataConnectorProfileProperties Text Source #

The location of the SAPOData resource.

sAPODataConnectorProfileProperties_applicationServicePath :: Lens' SAPODataConnectorProfileProperties Text Source #

The application path to catalog service.

sAPODataConnectorProfileProperties_portNumber :: Lens' SAPODataConnectorProfileProperties Natural Source #

The port number of the SAPOData instance.

sAPODataConnectorProfileProperties_clientNumber :: Lens' SAPODataConnectorProfileProperties Text Source #

The client number for the client creating the connection.

SAPODataDestinationProperties

sAPODataDestinationProperties_errorHandlingConfig :: Lens' SAPODataDestinationProperties (Maybe ErrorHandlingConfig) Source #

Undocumented member.

sAPODataDestinationProperties_idFieldNames :: Lens' SAPODataDestinationProperties (Maybe [Text]) Source #

Undocumented member.

sAPODataDestinationProperties_successResponseHandlingConfig :: Lens' SAPODataDestinationProperties (Maybe SuccessResponseHandlingConfig) Source #

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.

sAPODataDestinationProperties_writeOperationType :: Lens' SAPODataDestinationProperties (Maybe WriteOperationType) Source #

Undocumented member.

sAPODataDestinationProperties_objectPath :: Lens' SAPODataDestinationProperties Text Source #

The object path specified in the SAPOData flow destination.

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_clientCredentialsArn :: Lens' SalesforceConnectorProfileCredentials (Maybe Text) Source #

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

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

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

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

The credentials used to acquire new access tokens.

SalesforceConnectorProfileProperties

salesforceConnectorProfileProperties_instanceUrl :: Lens' SalesforceConnectorProfileProperties (Maybe Text) Source #

The location of the Salesforce resource.

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

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

SalesforceDestinationProperties

salesforceDestinationProperties_dataTransferApi :: Lens' SalesforceDestinationProperties (Maybe SalesforceDataTransferApi) Source #

Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to Salesforce.

AUTOMATIC

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.

BULKV2

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.

REST_SYNC

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.

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_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_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_object :: Lens' SalesforceDestinationProperties Text Source #

The object specified in the Salesforce flow destination.

SalesforceMetadata

salesforceMetadata_dataTransferApis :: Lens' SalesforceMetadata (Maybe [SalesforceDataTransferApi]) Source #

The Salesforce APIs that you can have Amazon AppFlow use when your flows transfers data to or from Salesforce.

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

The desired authorization scope for the Salesforce account.

SalesforceSourceProperties

salesforceSourceProperties_dataTransferApi :: Lens' SalesforceSourceProperties (Maybe SalesforceDataTransferApi) Source #

Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce.

AUTOMATIC

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.

BULKV2

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.

REST_SYNC

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.

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_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_firstExecutionFrom :: Lens' ScheduledTriggerProperties (Maybe UTCTime) Source #

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

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

Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.

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

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.

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

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

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

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.

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

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.

scheduledTriggerProperties_scheduleExpression :: Lens' ScheduledTriggerProperties Text Source #

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

ServiceNowConnectorProfileCredentials

serviceNowConnectorProfileCredentials_username :: Lens' ServiceNowConnectorProfileCredentials Text Source #

The name of the user.

serviceNowConnectorProfileCredentials_password :: Lens' ServiceNowConnectorProfileCredentials Text Source #

The password that corresponds to the user name.

ServiceNowConnectorProfileProperties

serviceNowConnectorProfileProperties_instanceUrl :: Lens' ServiceNowConnectorProfileProperties Text Source #

The location of the ServiceNow resource.

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_clientId :: Lens' SlackConnectorProfileCredentials Text Source #

The identifier for the client.

slackConnectorProfileCredentials_clientSecret :: Lens' SlackConnectorProfileCredentials Text Source #

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

SlackConnectorProfileProperties

slackConnectorProfileProperties_instanceUrl :: Lens' SlackConnectorProfileProperties Text Source #

The location of the Slack resource.

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

snowflakeConnectorProfileCredentials_username :: Lens' SnowflakeConnectorProfileCredentials Text Source #

The name of the user.

snowflakeConnectorProfileCredentials_password :: Lens' SnowflakeConnectorProfileCredentials Text Source #

The password that corresponds to the user name.

SnowflakeConnectorProfileProperties

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

The name of the account.

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

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

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

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

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

The Amazon Web Services Region of the Snowflake account.

snowflakeConnectorProfileProperties_warehouse :: Lens' SnowflakeConnectorProfileProperties Text Source #

The name of the Snowflake warehouse.

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_amplitude :: Lens' SourceConnectorProperties (Maybe AmplitudeSourceProperties) Source #

Specifies the information that is required for querying Amplitude.

sourceConnectorProperties_customConnector :: Lens' SourceConnectorProperties (Maybe CustomConnectorSourceProperties) Source #

Undocumented member.

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

Specifies the information that is required for querying Datadog.

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

Specifies the information that is required for querying Dynatrace.

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

Specifies the information that is required for querying Google Analytics.

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

Specifies the information that is required for querying Infor Nexus.

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

Specifies the information that is required for querying Marketo.

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

Specifies the information that is required for querying Amazon S3.

sourceConnectorProperties_sAPOData :: Lens' SourceConnectorProperties (Maybe SAPODataSourceProperties) Source #

Undocumented member.

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

Specifies the information that is required for querying Salesforce.

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

Specifies the information that is required for querying ServiceNow.

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

Specifies the information that is required for querying Singular.

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

Specifies the information that is required for querying Slack.

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.

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

Specifies the information that is required for querying Zendesk.

SourceFieldProperties

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

Indicates if the field can be queried.

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

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

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

Indicates if this timestamp field can be used for incremental queries.

SourceFlowConfig

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

The API version of the connector when it's used as a source in the flow.

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.

SuccessResponseHandlingConfig

successResponseHandlingConfig_bucketName :: Lens' SuccessResponseHandlingConfig (Maybe Text) Source #

The name of the Amazon S3 bucket.

successResponseHandlingConfig_bucketPrefix :: Lens' SuccessResponseHandlingConfig (Maybe Text) Source #

The Amazon S3 bucket prefix.

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

trendmicroConnectorProfileCredentials_apiSecretKey :: Lens' TrendmicroConnectorProfileCredentials Text Source #

The Secret Access Key portion of the credentials.

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.