5.0.0 • Published 5 years ago

@datafire/amazonaws_appflow v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/amazonaws_appflow

Client library for Amazon Appflow

Installation and Usage

npm install --save @datafire/amazonaws_appflow
let amazonaws_appflow = require('@datafire/amazonaws_appflow').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

CreateConnectorProfile

amazonaws_appflow.CreateConnectorProfile({
  "connectorProfileName": "",
  "connectorType": "",
  "connectionMode": "",
  "connectorProfileConfig": {}
}, context)

Input

  • input object
    • connectionMode required string (values: Public, Private): Indicates the connection mode and specifies whether it is public or private. Private flows use AWS PrivateLink to route data over AWS infrastructure without exposing it to the public internet.
    • connectorProfileConfig required object: Defines the connector-specific configuration and credentials for the connector profile.
      • connectorProfileCredentials
        • Amplitude
          • apiKey required
          • secretKey required
        • Datadog
          • apiKey required
          • applicationKey required
        • Dynatrace
          • apiToken required
        • GoogleAnalytics
          • accessToken
          • clientId required
          • clientSecret required
          • oAuthRequest
            • authCode
            • redirectUri
          • refreshToken
        • InforNexus
          • accessKeyId required
          • datakey required
          • secretAccessKey required
          • userId required
        • Marketo
          • accessToken
          • clientId required
          • clientSecret required
          • oAuthRequest
            • authCode
            • redirectUri
        • Redshift
          • password required
          • username required
        • Salesforce
          • accessToken
          • clientCredentialsArn
          • oAuthRequest
            • authCode
            • redirectUri
          • refreshToken
        • ServiceNow
          • password required
          • username required
        • Singular
          • apiKey required
        • Slack
          • accessToken
          • clientId required
          • clientSecret required
          • oAuthRequest
            • authCode
            • redirectUri
        • Snowflake
          • password required
          • username required
        • Trendmicro
          • apiSecretKey required
        • Veeva
          • password required
          • username required
        • Zendesk
          • accessToken
          • clientId required
          • clientSecret required
          • oAuthRequest
            • authCode
            • redirectUri
      • connectorProfileProperties
        • Amplitude
        • Datadog
          • instanceUrl required
        • Dynatrace
          • instanceUrl required
        • GoogleAnalytics
        • InforNexus
          • instanceUrl required
        • Marketo
          • instanceUrl required
        • Redshift
          • bucketName required
          • bucketPrefix
          • databaseUrl required
          • roleArn required
        • Salesforce
          • instanceUrl
          • isSandboxEnvironment
        • ServiceNow
          • instanceUrl required
        • Singular
        • Slack
          • instanceUrl required
        • Snowflake
          • accountName
          • bucketName required
          • bucketPrefix
          • privateLinkServiceName
          • region
          • stage required
          • warehouse required
        • Trendmicro
        • Veeva
          • instanceUrl required
        • Zendesk
          • instanceUrl required
    • connectorProfileName required string: The name of the connector profile. The name is unique for each ConnectorProfile in your AWS account.
    • connectorType required string (values: Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, Upsolver): The type of connector, such as Salesforce, Amplitude, and so on.
    • kmsArn string: 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.

Output

CreateFlow

amazonaws_appflow.CreateFlow({
  "flowName": "",
  "triggerConfig": {},
  "sourceFlowConfig": {},
  "destinationFlowConfigList": [],
  "tasks": []
}, context)

Input

  • input object
    • tags object: The tags used to organize, track, or control access for your flow.
    • description string: A description of the flow you want to create.
    • destinationFlowConfigList required array: The configuration that controls how Amazon AppFlow places data in the destination connector.
    • flowName required string: The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
    • kmsArn string: 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.
    • sourceFlowConfig required object: Contains information about the configuration of the source connector used in the flow.
      • connectorProfileName
      • connectorType
      • incrementalPullConfig
        • datetimeTypeFieldName
      • sourceConnectorProperties
        • Amplitude
          • object required
        • Datadog
          • object required
        • Dynatrace
          • object required
        • GoogleAnalytics
          • object required
        • InforNexus
          • object required
        • Marketo
          • object required
        • S3
          • bucketName required
          • bucketPrefix
        • Salesforce
          • enableDynamicFieldUpdate
          • includeDeletedRecords
          • object required
        • ServiceNow
          • object required
        • Singular
          • object required
        • Slack
          • object required
        • Trendmicro
          • object required
        • Veeva
          • object required
        • Zendesk
          • object required
    • tasks required array: A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
    • triggerConfig required object: The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
      • triggerProperties
        • Scheduled
          • dataPullMode
          • scheduleEndTime
          • scheduleExpression required
          • scheduleStartTime
          • timezone
      • triggerType

Output

DeleteConnectorProfile

amazonaws_appflow.DeleteConnectorProfile({
  "connectorProfileName": ""
}, context)

Input

  • input object
    • connectorProfileName required string: The name of the connector profile. The name is unique for each ConnectorProfile in your account.
    • forceDelete boolean: Indicates whether Amazon AppFlow should delete the profile, even if it is currently in use in one or more flows.

Output

DeleteFlow

amazonaws_appflow.DeleteFlow({
  "flowName": ""
}, context)

Input

  • input object
    • flowName required string: The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
    • forceDelete boolean: Indicates whether Amazon AppFlow should delete the flow, even if it is currently in use.

Output

DescribeConnectorEntity

amazonaws_appflow.DescribeConnectorEntity({
  "connectorEntityName": ""
}, context)

Input

  • input object
    • connectorEntityName required string: The entity name for that connector.
    • connectorProfileName string: The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account.
    • connectorType string (values: Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, Upsolver): The type of connector application, such as Salesforce, Amplitude, and so on.

Output

DescribeConnectorProfiles

amazonaws_appflow.DescribeConnectorProfiles({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • connectorProfileNames array: The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account.
    • connectorType string (values: Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, Upsolver): The type of connector, such as Salesforce, Amplitude, and so on.
    • maxResults integer: 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).
    • nextToken string: The pagination token for the next page of data.

Output

DescribeConnectors

amazonaws_appflow.DescribeConnectors({}, context)

Input

  • input object
    • nextToken string
    • connectorTypes array: The type of connector, such as Salesforce, Amplitude, and so on.
    • nextToken string: The pagination token for the next page of data.

Output

DescribeFlow

amazonaws_appflow.DescribeFlow({
  "flowName": ""
}, context)

Input

  • input object
    • flowName required string: The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Output

DescribeFlowExecutionRecords

amazonaws_appflow.DescribeFlowExecutionRecords({
  "flowName": ""
}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • flowName required string: The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
    • maxResults integer: 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).
    • nextToken string: The pagination token for the next page of data.

Output

ListConnectorEntities

amazonaws_appflow.ListConnectorEntities({}, context)

Input

  • input object
    • connectorProfileName string: The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account, and is used to query the downstream connector.
    • connectorType string (values: Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, Upsolver): The type of connector, such as Salesforce, Amplitude, and so on.
    • entitiesPath string: 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.

Output

ListFlows

amazonaws_appflow.ListFlows({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • maxResults integer: Specifies the maximum number of items that should be returned in the result set.
    • nextToken string: The pagination token for next page of data.

Output

StartFlow

amazonaws_appflow.StartFlow({
  "flowName": ""
}, context)

Input

  • input object
    • flowName required string: The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Output

StopFlow

amazonaws_appflow.StopFlow({
  "flowName": ""
}, context)

Input

  • input object
    • flowName required string: The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Output

ListTagsForResource

amazonaws_appflow.ListTagsForResource({
  "resourceArn": ""
}, context)

Input

  • input object
    • resourceArn required string

Output

TagResource

amazonaws_appflow.TagResource({
  "resourceArn": "",
  "tags": {}
}, context)

Input

  • input object
    • resourceArn required string
    • tags required object: The tags used to organize, track, or control access for your flow.

Output

UntagResource

amazonaws_appflow.UntagResource({
  "resourceArn": "",
  "tagKeys": []
}, context)

Input

  • input object
    • resourceArn required string
    • tagKeys required array

Output

UpdateConnectorProfile

amazonaws_appflow.UpdateConnectorProfile({
  "connectorProfileName": "",
  "connectionMode": "",
  "connectorProfileConfig": {}
}, context)

Input

  • input object
    • connectionMode required string (values: Public, Private): Indicates the connection mode and if it is public or private.
    • connectorProfileConfig required object: Defines the connector-specific configuration and credentials for the connector profile.
      • connectorProfileCredentials
        • Amplitude
          • apiKey required
          • secretKey required
        • Datadog
          • apiKey required
          • applicationKey required
        • Dynatrace
          • apiToken required
        • GoogleAnalytics
          • accessToken
          • clientId required
          • clientSecret required
          • oAuthRequest
            • authCode
            • redirectUri
          • refreshToken
        • InforNexus
          • accessKeyId required
          • datakey required
          • secretAccessKey required
          • userId required
        • Marketo
          • accessToken
          • clientId required
          • clientSecret required
          • oAuthRequest
            • authCode
            • redirectUri
        • Redshift
          • password required
          • username required
        • Salesforce
          • accessToken
          • clientCredentialsArn
          • oAuthRequest
            • authCode
            • redirectUri
          • refreshToken
        • ServiceNow
          • password required
          • username required
        • Singular
          • apiKey required
        • Slack
          • accessToken
          • clientId required
          • clientSecret required
          • oAuthRequest
            • authCode
            • redirectUri
        • Snowflake
          • password required
          • username required
        • Trendmicro
          • apiSecretKey required
        • Veeva
          • password required
          • username required
        • Zendesk
          • accessToken
          • clientId required
          • clientSecret required
          • oAuthRequest
            • authCode
            • redirectUri
      • connectorProfileProperties
        • Amplitude
        • Datadog
          • instanceUrl required
        • Dynatrace
          • instanceUrl required
        • GoogleAnalytics
        • InforNexus
          • instanceUrl required
        • Marketo
          • instanceUrl required
        • Redshift
          • bucketName required
          • bucketPrefix
          • databaseUrl required
          • roleArn required
        • Salesforce
          • instanceUrl
          • isSandboxEnvironment
        • ServiceNow
          • instanceUrl required
        • Singular
        • Slack
          • instanceUrl required
        • Snowflake
          • accountName
          • bucketName required
          • bucketPrefix
          • privateLinkServiceName
          • region
          • stage required
          • warehouse required
        • Trendmicro
        • Veeva
          • instanceUrl required
        • Zendesk
          • instanceUrl required
    • connectorProfileName required string: The name of the connector profile and is unique for each ConnectorProfile in the AWS Account.

Output

UpdateFlow

amazonaws_appflow.UpdateFlow({
  "flowName": "",
  "triggerConfig": {},
  "destinationFlowConfigList": [],
  "tasks": []
}, context)

Input

  • input object
    • description string: A description of the flow.
    • destinationFlowConfigList required array: The configuration that controls how Amazon AppFlow transfers data to the destination connector.
    • flowName required string: The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
    • sourceFlowConfig object: Contains information about the configuration of the source connector used in the flow.
      • connectorProfileName
      • connectorType
      • incrementalPullConfig
        • datetimeTypeFieldName
      • sourceConnectorProperties
        • Amplitude
          • object required
        • Datadog
          • object required
        • Dynatrace
          • object required
        • GoogleAnalytics
          • object required
        • InforNexus
          • object required
        • Marketo
          • object required
        • S3
          • bucketName required
          • bucketPrefix
        • Salesforce
          • enableDynamicFieldUpdate
          • includeDeletedRecords
          • object required
        • ServiceNow
          • object required
        • Singular
          • object required
        • Slack
          • object required
        • Trendmicro
          • object required
        • Veeva
          • object required
        • Zendesk
          • object required
    • tasks required array: A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
    • triggerConfig required object: The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
      • triggerProperties
        • Scheduled
          • dataPullMode
          • scheduleEndTime
          • scheduleExpression required
          • scheduleStartTime
          • timezone
      • triggerType

Output

Definitions

ARN

  • ARN string

AccessKeyId

  • AccessKeyId string

AccessToken

  • AccessToken string

AccountName

  • AccountName string

AggregationConfig

  • AggregationConfig object: The aggregation settings that you can use to customize the output format of your flow data.
    • aggregationType

AggregationType

  • AggregationType string (values: None, SingleFile)

AmplitudeConnectorOperator

  • AmplitudeConnectorOperator string (values: BETWEEN)

AmplitudeConnectorProfileCredentials

  • AmplitudeConnectorProfileCredentials object: The connector-specific credentials required when using Amplitude.
    • apiKey required
    • secretKey required

AmplitudeConnectorProfileProperties

  • AmplitudeConnectorProfileProperties object: The connector-specific profile properties required when using Amplitude.

AmplitudeMetadata

  • AmplitudeMetadata object: The connector metadata specific to Amplitude.

AmplitudeSourceProperties

  • AmplitudeSourceProperties object: The properties that are applied when Amplitude is being used as a source.
    • object required

ApiKey

  • ApiKey string

ApiSecretKey

  • ApiSecretKey string

ApiToken

  • ApiToken string

ApplicationKey

  • ApplicationKey string

AuthCode

  • AuthCode string

Boolean

  • Boolean boolean

BucketName

  • BucketName string

BucketPrefix

  • BucketPrefix string

ClientCredentialsArn

  • ClientCredentialsArn string

ClientId

  • ClientId string

ClientSecret

  • ClientSecret string

ConflictException

ConnectionMode

  • ConnectionMode string (values: Public, Private)

ConnectorAuthenticationException

ConnectorConfiguration

  • ConnectorConfiguration object: The configuration settings related to a given connector.
    • canUseAsDestination
    • canUseAsSource
    • connectorMetadata
      • Amplitude
      • Datadog
      • Dynatrace
      • EventBridge
      • GoogleAnalytics
      • InforNexus
      • Marketo
      • Redshift
      • S3
      • Salesforce
      • ServiceNow
      • Singular
      • Slack
      • Snowflake
      • Trendmicro
      • Upsolver
      • Veeva
      • Zendesk
    • isPrivateLinkEnabled
    • isPrivateLinkEndpointUrlRequired
    • supportedDestinationConnectors
    • supportedSchedulingFrequencies
    • supportedTriggerTypes

ConnectorConfigurationsMap

  • ConnectorConfigurationsMap object

ConnectorEntity

  • ConnectorEntity object: The high-level entity that can be queried in Amazon AppFlow. For example, a Salesforce entity might be an Account or Opportunity, whereas a ServiceNow entity might be an Incident.
    • hasNestedEntities
    • label
    • name required

ConnectorEntityField

  • ConnectorEntityField object: Describes the data model of a connector field. For example, for an account entity, the fields would be account name, account ID, and so on.
    • description
    • destinationProperties
      • isCreatable
      • isNullable
      • isUpdatable
      • isUpsertable
      • supportedWriteOperations
    • identifier required
    • label
    • sourceProperties
      • isQueryable
      • isRetrievable
    • supportedFieldTypeDetails
      • v1 required
        • fieldType required
        • filterOperators required
        • supportedValues

ConnectorEntityFieldList

ConnectorEntityList

ConnectorEntityMap

  • ConnectorEntityMap object

ConnectorMetadata

  • ConnectorMetadata object: A structure to specify connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on.
    • Amplitude
    • Datadog
    • Dynatrace
    • EventBridge
    • GoogleAnalytics
    • InforNexus
    • Marketo
    • Redshift
    • S3
    • Salesforce
    • ServiceNow
    • Singular
    • Slack
    • Snowflake
    • Trendmicro
    • Upsolver
    • Veeva
    • Zendesk

ConnectorOAuthRequest

  • ConnectorOAuthRequest object: Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
    • authCode
    • redirectUri

ConnectorOperator

  • ConnectorOperator object: The operation to be performed on the provided source fields.
    • Amplitude
    • Datadog
    • Dynatrace
    • GoogleAnalytics
    • InforNexus
    • Marketo
    • S3
    • Salesforce
    • ServiceNow
    • Singular
    • Slack
    • Trendmicro
    • Veeva
    • Zendesk

ConnectorProfile

  • ConnectorProfile object: Describes an instance of a connector. This includes the provided name, credentials ARN, connection-mode, and so on. To keep the API intuitive and extensible, the fields that are common to all types of connector profiles are explicitly specified at the top level. The rest of the connector-specific properties are available via the connectorProfileProperties field.
    • connectionMode
    • connectorProfileArn
    • connectorProfileName
    • connectorProfileProperties
      • Amplitude
      • Datadog
        • instanceUrl required
      • Dynatrace
        • instanceUrl required
      • GoogleAnalytics
      • InforNexus
        • instanceUrl required
      • Marketo
        • instanceUrl required
      • Redshift
        • bucketName required
        • bucketPrefix
        • databaseUrl required
        • roleArn required
      • Salesforce
        • instanceUrl
        • isSandboxEnvironment
      • ServiceNow
        • instanceUrl required
      • Singular
      • Slack
        • instanceUrl required
      • Snowflake
        • accountName
        • bucketName required
        • bucketPrefix
        • privateLinkServiceName
        • region
        • stage required
        • warehouse required
      • Trendmicro
      • Veeva
        • instanceUrl required
      • Zendesk
        • instanceUrl required
    • connectorType
    • createdAt
    • credentialsArn
    • lastUpdatedAt

ConnectorProfileArn

  • ConnectorProfileArn string

ConnectorProfileConfig

  • ConnectorProfileConfig object: Defines the connector-specific configuration and credentials for the connector profile.
    • connectorProfileCredentials required
      • Amplitude
        • apiKey required
        • secretKey required
      • Datadog
        • apiKey required
        • applicationKey required
      • Dynatrace
        • apiToken required
      • GoogleAnalytics
        • accessToken
        • clientId required
        • clientSecret required
        • oAuthRequest
          • authCode
          • redirectUri
        • refreshToken
      • InforNexus
        • accessKeyId required
        • datakey required
        • secretAccessKey required
        • userId required
      • Marketo
        • accessToken
        • clientId required
        • clientSecret required
        • oAuthRequest
          • authCode
          • redirectUri
      • Redshift
        • password required
        • username required
      • Salesforce
        • accessToken
        • clientCredentialsArn
        • oAuthRequest
          • authCode
          • redirectUri
        • refreshToken
      • ServiceNow
        • password required
        • username required
      • Singular
        • apiKey required
      • Slack
        • accessToken
        • clientId required
        • clientSecret required
        • oAuthRequest
          • authCode
          • redirectUri
      • Snowflake
        • password required
        • username required
      • Trendmicro
        • apiSecretKey required
      • Veeva
        • password required
        • username required
      • Zendesk
        • accessToken
        • clientId required
        • clientSecret required
        • oAuthRequest
          • authCode
          • redirectUri
    • connectorProfileProperties required
      • Amplitude
      • Datadog
        • instanceUrl required
      • Dynatrace
        • instanceUrl required
      • GoogleAnalytics
      • InforNexus
        • instanceUrl required
      • Marketo
        • instanceUrl required
      • Redshift
        • bucketName required
        • bucketPrefix
        • databaseUrl required
        • roleArn required
      • Salesforce
        • instanceUrl
        • isSandboxEnvironment
      • ServiceNow
        • instanceUrl required
      • Singular
      • Slack
        • instanceUrl required
      • Snowflake
        • accountName
        • bucketName required
        • bucketPrefix
        • privateLinkServiceName
        • region
        • stage required
        • warehouse required
      • Trendmicro
      • Veeva
        • instanceUrl required
      • Zendesk
        • instanceUrl required

ConnectorProfileCredentials

  • ConnectorProfileCredentials object: The connector-specific credentials required by a connector.
    • Amplitude
      • apiKey required
      • secretKey required
    • Datadog
      • apiKey required
      • applicationKey required
    • Dynatrace
      • apiToken required
    • GoogleAnalytics
      • accessToken
      • clientId required
      • clientSecret required
      • oAuthRequest
        • authCode
        • redirectUri
      • refreshToken
    • InforNexus
      • accessKeyId required
      • datakey required
      • secretAccessKey required
      • userId required
    • Marketo
      • accessToken
      • clientId required
      • clientSecret required
      • oAuthRequest
        • authCode
        • redirectUri
    • Redshift
      • password required
      • username required
    • Salesforce
      • accessToken
      • clientCredentialsArn
      • oAuthRequest
        • authCode
        • redirectUri
      • refreshToken
    • ServiceNow
      • password required
      • username required
    • Singular
      • apiKey required
    • Slack
      • accessToken
      • clientId required
      • clientSecret required
      • oAuthRequest
        • authCode
        • redirectUri
    • Snowflake
      • password required
      • username required
    • Trendmicro
      • apiSecretKey required
    • Veeva
      • password required
      • username required
    • Zendesk
      • accessToken
      • clientId required
      • clientSecret required
      • oAuthRequest
        • authCode
        • redirectUri

ConnectorProfileDetailList

ConnectorProfileName

  • ConnectorProfileName string

ConnectorProfileNameList

ConnectorProfileProperties

  • ConnectorProfileProperties object: The connector-specific profile properties required by each connector.
    • Amplitude
    • Datadog
      • instanceUrl required
    • Dynatrace
      • instanceUrl required
    • GoogleAnalytics
    • InforNexus
      • instanceUrl required
    • Marketo
      • instanceUrl required
    • Redshift
      • bucketName required
      • bucketPrefix
      • databaseUrl required
      • roleArn required
    • Salesforce
      • instanceUrl
      • isSandboxEnvironment
    • ServiceNow
      • instanceUrl required
    • Singular
    • Slack
      • instanceUrl required
    • Snowflake
      • accountName
      • bucketName required
      • bucketPrefix
      • privateLinkServiceName
      • region
      • stage required
      • warehouse required
    • Trendmicro
    • Veeva
      • instanceUrl required
    • Zendesk
      • instanceUrl required

ConnectorServerException

ConnectorType

  • ConnectorType string (values: Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, Upsolver)

ConnectorTypeList

CreateConnectorProfileRequest

  • CreateConnectorProfileRequest object
    • connectionMode required
    • connectorProfileConfig required
      • connectorProfileCredentials required
        • Amplitude
          • apiKey required
          • secretKey required
        • Datadog
          • apiKey required
          • applicationKey required
        • Dynatrace
          • apiToken required
        • GoogleAnalytics
          • accessToken
          • clientId required
          • clientSecret required
          • oAuthRequest
            • authCode
            • redirectUri
          • refreshToken
        • InforNexus
          • accessKeyId required
          • datakey required
          • secretAccessKey required
          • userId required
        • Marketo
          • accessToken
          • clientId required
          • clientSecret required
          • oAuthRequest
            • authCode
            • redirectUri
        • Redshift
          • password required
          • username required
        • Salesforce
          • accessToken
          • clientCredentialsArn
          • oAuthRequest
            • authCode
            • redirectUri
          • refreshToken
        • ServiceNow
          • password required
          • username required
        • Singular
          • apiKey required
        • Slack
          • accessToken
          • clientId required
          • clientSecret required
          • oAuthRequest
            • authCode
            • redirectUri
        • Snowflake
          • password required
          • username required
        • Trendmicro
          • apiSecretKey required
        • Veeva
          • password required
          • username required
        • Zendesk
          • accessToken
          • clientId required
          • clientSecret required
          • oAuthRequest
            • authCode
            • redirectUri
      • connectorProfileProperties required
        • Amplitude
        • Datadog
          • instanceUrl required
        • Dynatrace
          • instanceUrl required
        • GoogleAnalytics
        • InforNexus
          • instanceUrl required
        • Marketo
          • instanceUrl required
        • Redshift
          • bucketName required
          • bucketPrefix
          • databaseUrl required
          • roleArn required
        • Salesforce
          • instanceUrl
          • isSandboxEnvironment
        • ServiceNow
          • instanceUrl required
        • Singular
        • Slack
          • instanceUrl required
        • Snowflake
          • accountName
          • bucketName required
          • bucketPrefix
          • privateLinkServiceName
          • region
          • stage required
          • warehouse required
        • Trendmicro
        • Veeva
          • instanceUrl required
        • Zendesk
          • instanceUrl required
    • connectorProfileName required
    • connectorType required
    • kmsArn

CreateConnectorProfileResponse

  • CreateConnectorProfileResponse object
    • connectorProfileArn

CreateFlowRequest

  • CreateFlowRequest object
    • tags
    • description
    • destinationFlowConfigList required
    • flowName required
    • kmsArn
    • sourceFlowConfig required
      • connectorProfileName
      • connectorType required
      • incrementalPullConfig
        • datetimeTypeFieldName
      • sourceConnectorProperties required
        • Amplitude
          • object required
        • Datadog
          • object required
        • Dynatrace
          • object required
        • GoogleAnalytics
          • object required
        • InforNexus
          • object required
        • Marketo
          • object required
        • S3
          • bucketName required
          • bucketPrefix
        • Salesforce
          • enableDynamicFieldUpdate
          • includeDeletedRecords
          • object required
        • ServiceNow
          • object required
        • Singular
          • object required
        • Slack
          • object required
        • Trendmicro
          • object required
        • Veeva
          • object required
        • Zendesk
          • object required
    • tasks required
    • triggerConfig required
      • triggerProperties
        • Scheduled
          • dataPullMode
          • scheduleEndTime
          • scheduleExpression required
          • scheduleStartTime
          • timezone
      • triggerType required

CreateFlowResponse

  • CreateFlowResponse object
    • flowArn
    • flowStatus

CreatedBy

  • CreatedBy string

DataPullMode

  • DataPullMode string (values: Incremental, Complete)

DatabaseUrl

  • DatabaseUrl string

DatadogConnectorOperator

  • DatadogConnectorOperator string (values: PROJECTION, BETWEEN, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP)

DatadogConnectorProfileCredentials

  • DatadogConnectorProfileCredentials object: The connector-specific credentials required by Datadog.
    • apiKey required
    • applicationKey required

DatadogConnectorProfileProperties

  • DatadogConnectorProfileProperties object: The connector-specific profile properties required by Datadog.
    • instanceUrl required

DatadogMetadata

  • DatadogMetadata object: The connector metadata specific to Datadog.

DatadogSourceProperties

  • DatadogSourceProperties object: The properties that are applied when Datadog is being used as a source.
    • object required

Date

  • Date string

DatetimeTypeFieldName

  • DatetimeTypeFieldName string

DeleteConnectorProfileRequest

  • DeleteConnectorProfileRequest object
    • connectorProfileName required
    • forceDelete

DeleteConnectorProfileResponse

  • DeleteConnectorProfileResponse object

DeleteFlowRequest

  • DeleteFlowRequest object
    • flowName required
    • forceDelete

DeleteFlowResponse

  • DeleteFlowResponse object

DescribeConnectorEntityRequest

  • DescribeConnectorEntityRequest object
    • connectorEntityName required
    • connectorProfileName
    • connectorType

DescribeConnectorEntityResponse

DescribeConnectorProfilesRequest

  • DescribeConnectorProfilesRequest object

DescribeConnectorProfilesResponse

  • DescribeConnectorProfilesResponse object

DescribeConnectorsRequest

  • DescribeConnectorsRequest object

DescribeConnectorsResponse

  • DescribeConnectorsResponse object
    • connectorConfigurations
    • nextToken

DescribeFlowExecutionRecordsRequest

  • DescribeFlowExecutionRecordsRequest object
    • flowName required
    • maxResults
    • nextToken

DescribeFlowExecutionRecordsResponse

  • DescribeFlowExecutionRecordsResponse object

DescribeFlowRequest

  • DescribeFlowRequest object
    • flowName required

DescribeFlowResponse

  • DescribeFlowResponse object
    • tags
    • createdAt
    • createdBy
    • description
    • destinationFlowConfigList
    • flowArn
    • flowName
    • flowStatus
    • flowStatusMessage
    • kmsArn
    • lastRunExecutionDetails
      • mostRecentExecutionMessage
      • mostRecentExecutionStatus
      • mostRecentExecutionTime
    • lastUpdatedAt
    • lastUpdatedBy
    • sourceFlowConfig
      • connectorProfileName
      • connectorType required
      • incrementalPullConfig
        • datetimeTypeFieldName
      • sourceConnectorProperties required
        • Amplitude
          • object required
        • Datadog
          • object required
        • Dynatrace
          • object required
        • GoogleAnalytics
          • object required
        • InforNexus
          • object required
        • Marketo
          • object required
        • S3
          • bucketName required
          • bucketPrefix
        • Salesforce
          • enableDynamicFieldUpdate
          • includeDeletedRecords
          • object required
        • ServiceNow
          • object required
        • Singular
          • object required
        • Slack
          • object required
        • Trendmicro
          • object required
        • Veeva
          • object required
        • Zendesk
          • object required
    • tasks
    • triggerConfig
      • triggerProperties
        • Scheduled
          • dataPullMode
          • scheduleEndTime
          • scheduleExpression required
          • scheduleStartTime
          • timezone
      • triggerType required

Description

  • Description string

DestinationConnectorProperties

  • DestinationConnectorProperties object: This stores the information that is required to query a particular connector.
    • EventBridge
    • Redshift
      • bucketPrefix
      • errorHandlingConfig
        • bucketName
        • bucketPrefix
        • failOnFirstDestinationError
      • intermediateBucketName required
      • object required
    • S3
    • Salesforce
      • errorHandlingConfig
        • bucketName
        • bucketPrefix
        • failOnFirstDestinationError
      • idFieldNames
      • object required
      • writeOperationType
    • Snowflake
      • bucketPrefix
      • errorHandlingConfig
        • bucketName
        • bucketPrefix
        • failOnFirstDestinationError
      • intermediateBucketName required
      • object required
    • Upsolver

DestinationField

  • DestinationField string

DestinationFieldProperties

  • DestinationFieldProperties object: The properties that can be applied to a field when connector is being used as a destination.
    • isCreatable
    • isNullable
    • isUpdatable
    • isUpsertable
    • supportedWriteOperations

DestinationFlowConfig

  • DestinationFlowConfig object: Contains information about the configuration of destination connectors present in the flow.
    • connectorProfileName
    • connectorType required
    • destinationConnectorProperties required
      • EventBridge
      • Redshift
        • bucketPrefix
        • errorHandlingConfig
          • bucketName
          • bucketPrefix
          • failOnFirstDestinationError
        • intermediateBucketName required
        • object required
      • S3
      • Salesforce
        • errorHandlingConfig
          • bucketName
          • bucketPrefix
          • failOnFirstDestinationError
        • idFieldNames
        • object required
        • writeOperationType
      • Snowflake
        • bucketPrefix
        • errorHandlingConfig
          • bucketName
          • bucketPrefix
          • failOnFirstDestinationError
        • intermediateBucketName required
        • object required
      • Upsolver

DestinationFlowConfigList

DynatraceConnectorOperator

  • DynatraceConnectorOperator string (values: PROJECTION, BETWEEN, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP)

DynatraceConnectorProfileCredentials

  • DynatraceConnectorProfileCredentials object: The connector-specific profile credentials required by Dynatrace.
    • apiToken required

DynatraceConnectorProfileProperties

  • DynatraceConnectorProfileProperties object: The connector-specific profile properties required by Dynatrace.
    • instanceUrl required

DynatraceMetadata

  • DynatraceMetadata object: The connector metadata specific to Dynatrace.

DynatraceSourceProperties

  • DynatraceSourceProperties object: The properties that are applied when Dynatrace is being used as a source.
    • object required

EntitiesPath

  • EntitiesPath string

ErrorHandlingConfig

  • ErrorHandlingConfig object: The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.
    • bucketName
    • bucketPrefix
    • failOnFirstDestinationError

ErrorInfo

  • ErrorInfo object: Provides details in the event of a failed flow, including the failure count and the related error messages.
    • executionMessage
    • putFailuresCount

EventBridgeDestinationProperties

  • EventBridgeDestinationProperties object: The properties that are applied when Amazon EventBridge is being used as a destination.

EventBridgeMetadata

  • EventBridgeMetadata object: The connector metadata specific to Amazon EventBridge.

ExecutionDetails

  • ExecutionDetails object: Describes the details of the flow run, including the timestamp, status, and message.
    • mostRecentExecutionMessage
    • mostRecentExecutionStatus
    • mostRecentExecutionTime

ExecutionId

  • ExecutionId string

ExecutionMessage

  • ExecutionMessage string

ExecutionRecord

  • ExecutionRecord object: Specifies information about the past flow run instances for a given flow.
    • executionId
    • executionResult
      • bytesProcessed
      • bytesWritten
      • errorInfo
        • executionMessage
        • putFailuresCount
      • recordsProcessed
    • executionStatus
    • lastUpdatedAt
    • startedAt

ExecutionResult

  • ExecutionResult object: Specifies the end result of the flow run.
    • bytesProcessed
    • bytesWritten
    • errorInfo
      • executionMessage
      • putFailuresCount
    • recordsProcessed

ExecutionStatus

  • ExecutionStatus string (values: InProgress, Successful, Error)

FieldType

  • FieldType string

FieldTypeDetails

  • FieldTypeDetails object: Contains details regarding the supported field type and the operators that can be applied for filtering.
    • fieldType required
    • filterOperators required
    • supportedValues

FileType

  • FileType string (values: CSV, JSON, PARQUET)

FilterOperatorList

FlowArn

  • FlowArn string

FlowDefinition

  • FlowDefinition object: The properties of the flow, such as its source, destination, trigger type, and so on.
    • tags
    • createdAt
    • createdBy
    • description
    • destinationConnectorType
    • flowArn
    • flowName
    • flowStatus
    • lastRunExecutionDetails
      • mostRecentExecutionMessage
      • mostRecentExecutionStatus
      • mostRecentExecutionTime
    • lastUpdatedAt
    • lastUpdatedBy
    • sourceConnectorType
    • triggerType

FlowDescription

  • FlowDescription string

FlowExecutionList

FlowList

FlowName

  • FlowName string

FlowStatus

  • FlowStatus string (values: Active, Deprecated, Deleted, Draft, Errored, Suspended)

FlowStatusMessage

  • FlowStatusMessage string

GoogleAnalyticsConnectorOperator

  • GoogleAnalyticsConnectorOperator string (values: PROJECTION, BETWEEN)

GoogleAnalyticsConnectorProfileCredentials

  • GoogleAnalyticsConnectorProfileCredentials object: The connector-specific profile credentials required by Google Analytics.
    • accessToken
    • clientId required
    • clientSecret required
    • oAuthRequest
      • authCode
      • redirectUri
    • refreshToken

GoogleAnalyticsConnectorProfileProperties

  • GoogleAnalyticsConnectorProfileProperties object: The connector-specific profile properties required by Google Analytics.

GoogleAnalyticsMetadata

  • GoogleAnalyticsMetadata object: The connector metadata specific to Google Analytics.

GoogleAnalyticsSourceProperties

  • GoogleAnalyticsSourceProperties object: The properties that are applied when Google Analytics is being used as a source.
    • object required

Group

  • Group string

IdFieldNameList

  • IdFieldNameList array: A list of field names that can be used as an ID field when performing a write operation.

Identifier

  • Identifier string

IncrementalPullConfig

  • IncrementalPullConfig object: Specifies the configuration used when importing incremental records from the source.
    • datetimeTypeFieldName

InforNexusConnectorOperator

  • InforNexusConnectorOperator string (values: PROJECTION, BETWEEN, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP)

InforNexusConnectorProfileCredentials

  • InforNexusConnectorProfileCredentials object: The connector-specific profile credentials required by Infor Nexus.
    • accessKeyId required
    • datakey required
    • secretAccessKey required
    • userId required

InforNexusConnectorProfileProperties

  • InforNexusConnectorProfileProperties object: The connector-specific profile properties required by Infor Nexus.
    • instanceUrl required

InforNexusMetadata

  • InforNexusMetadata object: The connector metadata specific to Infor Nexus.

InforNexusSourceProperties

  • InforNexusSourceProperties object: The properties that are applied when Infor Nexus is being used as a source.
    • object required

InstanceUrl

  • InstanceUrl string

InternalServerException

KMSArn

  • KMSArn string

Key

  • Key string

Label

  • Label string

ListConnectorEntitiesRequest

  • ListConnectorEntitiesRequest object
    • connectorProfileName
    • connectorType
    • entitiesPath

ListConnectorEntitiesResponse

  • ListConnectorEntitiesResponse object
    • connectorEntityMap required

ListFlowsRequest

  • ListFlowsRequest object
    • maxResults
    • nextToken

ListFlowsResponse

ListTagsForResourceRequest

  • ListTagsForResourceRequest object

ListTagsForResourceResponse

  • ListTagsForResourceResponse object
    • tags

Long

  • Long integer

MarketoConnectorOperator

  • MarketoConnectorOperator string (values: PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP)

MarketoConnectorProfileCredentials

  • MarketoConnectorProfileCredentials object: The connector-specific profile credentials required by Marketo.
    • accessToken
    • clientId required
    • clientSecret required
    • oAuthRequest
      • authCode
      • redirectUri

MarketoConnectorProfileProperties

  • MarketoConnectorProfileProperties object: The connector-specific profile properties required when using Marketo.
    • instanceUrl required

MarketoMetadata

  • MarketoMetadata object: The connector metadata specific to Marketo.

MarketoSourceProperties

  • MarketoSourceProperties object: The properties that are applied when Marketo is being used as a source.
    • object required

MaxResults

  • MaxResults integer

MostRecentExecutionMessage

  • MostRecentExecutionMessage string

Name

  • Name string

NextToken

  • NextToken string

OAuthScope

  • OAuthScope string

OAuthScopeList

Object

  • Object string

Operator

  • Operator string (values: PROJECTION, LESS_THAN, GREATER_THAN, CONTAINS, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP)

OperatorPropertiesKeys

  • OperatorPropertiesKeys string (values: VALUE, VALUES, DATA_TYPE, UPPER_BOUND, LOWER_BOUND, SOURCE_DATA_TYPE, DESTINATION_DATA_TYPE, VALIDATION_ACTION, MASK_VALUE, MASK_LENGTH, TRUNCATE_LENGTH, MATH_OPERATION_FIELDS_ORDER, CONCAT_FORMAT, SUBFIELD_CATEGORY_MAP)

Password

  • Password string

PrefixConfig

  • PrefixConfig object: Determines the prefix that Amazon AppFlow applies to the destination folder name. You can name your destination folders according to the flow frequency and date.
    • prefixFormat
    • prefixType

PrefixFormat

  • PrefixFormat string (values: YEAR, MONTH, DAY, HOUR, MINUTE)

PrefixType

  • PrefixType string (values: FILENAME, PATH, PATH_AND_FILENAME)

PrivateLinkServiceName

  • PrivateLinkServiceName string

Property

  • Property string

RedirectUri

  • RedirectUri string

RedshiftConnectorProfileCredentials

  • RedshiftConnectorProfileCredentials object: The connector-specific profile credentials required when using Amazon Redshift.
    • password required
    • username required

RedshiftConnectorProfileProperties

  • RedshiftConnectorProfileProperties object: The connector-specific profile properties when using Amazon Redshift.
    • bucketName required
    • bucketPrefix
    • databaseUrl required
    • roleArn required

RedshiftDestinationProperties

  • RedshiftDestinationProperties object: The properties that are applied when Amazon Redshift is being used as a destination.
    • bucketPrefix
    • errorHandlingConfig
      • bucketName
      • bucketPrefix
      • failOnFirstDestinationError
    • intermediateBucketName required
    • object required

RedshiftMetadata

  • RedshiftMetadata object: The connector metadata specific to Amazon Redshift.

RefreshToken

  • RefreshToken string

Region

  • Region string

RegionList

ResourceNotFoundException

RoleArn

  • RoleArn string

S3ConnectorOperator

  • S3ConnectorOperator string (values: PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP)

S3DestinationProperties

  • S3DestinationProperties object: The properties that are applied when Amazon S3 is used as a destination.

S3Metadata

  • S3Metadata object: The connector metadata specific to Amazon S3.

S3OutputFormatConfig

  • S3OutputFormatConfig object: The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination.

S3SourceProperties

  • S3SourceProperties object: The properties that are applied when Amazon S3 is being used as the flow source.
    • bucketName required
    • bucketPrefix

SalesforceConnectorOperator

  • SalesforceConnectorOperator string (values: PROJECTION, LESS_THAN, CONTAINS, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP)

SalesforceConnectorProfileCredentials

  • SalesforceConnectorProfileCredentials object: The connector-specific profile credentials required when using Salesforce.
    • accessToken
    • clientCredentialsArn
    • oAuthRequest
      • authCode
      • redirectUri
    • refreshToken

SalesforceConnectorProfileProperties

  • SalesforceConnectorProfileProperties object: The connector-specific profile properties required when using Salesforce.
    • instanceUrl
    • isSandboxEnvironment

SalesforceDestinationProperties

  • SalesforceDestinationProperties object: The properties that are applied when Salesforce is being used as a destination.
    • errorHandlingConfig
      • bucketName
      • bucketPrefix
      • failOnFirstDestinationError
    • idFieldNames
    • object required
    • writeOperationType

SalesforceMetadata

  • SalesforceMetadata object: The connector metadata specific to Salesforce.

SalesforceSourceProperties

  • SalesforceSourceProperties object: The properties that are applied when Salesforce is being used as a source.
    • enableDynamicFieldUpdate
    • includeDeletedRecords
    • object required

ScheduleExpression

  • ScheduleExpression string

ScheduleFrequencyType

  • ScheduleFrequencyType string (values: BYMINUTE, HOURLY, DAILY, WEEKLY, MONTHLY, ONCE)

ScheduledTriggerProperties

  • ScheduledTriggerProperties object: Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the Scheduled trigger type.
    • dataPullMode
    • scheduleEndTime
    • scheduleExpression required
    • scheduleStartTime
    • timezone

SchedulingFrequencyTypeList

SecretKey

  • SecretKey string

ServiceNowConnectorOperator

  • ServiceNowConnectorOperator string (values: PROJECTION, CONTAINS, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP)

ServiceNowConnectorProfileCredentials

  • ServiceNowConnectorProfileCredentials object: The connector-specific profile credentials required when using ServiceNow.
    • password required
    • username required

ServiceNowConnectorProfileProperties

  • ServiceNowConnectorProfileProperties object: The connector-specific profile properties required when using ServiceNow.
    • instanceUrl required

ServiceNowMetadata

  • ServiceNowMetadata object: The connector metadata specific to ServiceNow.

ServiceNowSourceProperties

  • ServiceNowSourceProperties object: The properties that are applied when ServiceNow is being used as a source.
    • object required

ServiceQuotaExceededException

SingularConnectorOperator

  • SingularConnectorOperator string (values: PROJECTION, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP)

SingularConnectorProfileCredentials

  • SingularConnectorProfileCredentials object: The connector-specific profile credentials required when using Singular.
    • apiKey required

SingularConnectorProfileProperties

  • SingularConnectorProfileProperties object: The connector-specific profile properties required when using Singular.

SingularMetadata

  • SingularMetadata object: The connector metadata specific to Singular.

SingularSourceProperties

  • SingularSourceProperties object: The properties that are applied when Singular is being used as a source.
    • object required

SlackConnectorOperator

  • SlackConnectorOperator string (values: PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP)

SlackConnectorProfileCredentials

  • SlackConnectorProfileCredentials object: The connector-specific profile credentials required when using Slack.
    • accessToken
    • clientId required
    • clientSecret required
    • oAuthRequest
      • authCode
      • redirectUri

SlackConnectorProfileProperties

  • SlackConnectorProfileProperties object: The connector-specific profile properties required when using Slack.
    • instanceUrl required

SlackMetadata

  • SlackMetadata object: The connector metadata specific to Slack.

SlackSourceProperties

  • SlackSourceProperties object: The properties that are applied when Slack is being used as a source.
    • object required

SnowflakeConnectorProfileCredentials

  • SnowflakeConnectorProfileCredentials object: The connector-specific profile credentials required when using Snowflake.
    • password required
    • username required

SnowflakeConnectorProfileProperties

  • SnowflakeConnectorProfileProperties object: The connector-specific profile properties required when using Snowflake.
    • accountName
    • bucketName required
    • bucketPrefix
    • privateLinkServiceName
    • region
    • stage required
    • warehouse required

SnowflakeDestinationProperties

  • SnowflakeDestinationProperties object: The properties that are applied when Snowflake is being used as a destination.
    • bucketPrefix
    • errorHandlingConfig
      • bucketName
      • bucketPrefix
      • failOnFirstDestinationError
    • intermediateBucketName required
    • object required

SnowflakeMetadata

  • SnowflakeMetadata
datafireaws-sdk
@infinitebrahmanuniverse/nolb-_datafire_am@everything-registry/sub-chunk-220
5.0.0

5 years ago