@aws-sdk/client-appflow 3.48.0 → 3.52.0

package/dist-types/ts3.4/models/models_0.d.ts

@@ -1,4 +1,10 @@
 import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
+
+export interface AccessDeniedException extends __SmithyException, $MetadataBearer {
+    name: "AccessDeniedException";
+    $fault: "client";
+    message?: string;
+}
 export declare enum AggregationType {
     NONE = "None",
     SINGLE_FILE = "SingleFile"
@@ -50,6 +56,91 @@ export declare namespace AmplitudeSourceProperties {
     const filterSensitiveLog: (obj: AmplitudeSourceProperties) => any;
 }
 
+export interface ApiKeyCredentials {
+    
+    apiKey: string | undefined;
+    
+    apiSecretKey?: string;
+}
+export declare namespace ApiKeyCredentials {
+    
+    const filterSensitiveLog: (obj: ApiKeyCredentials) => any;
+}
+
+export interface AuthParameter {
+    
+    key?: string;
+    
+    isRequired?: boolean;
+    
+    label?: string;
+    
+    description?: string;
+    
+    isSensitiveField?: boolean;
+    
+    connectorSuppliedValues?: string[];
+}
+export declare namespace AuthParameter {
+    
+    const filterSensitiveLog: (obj: AuthParameter) => any;
+}
+
+export interface CustomAuthConfig {
+    
+    customAuthenticationType?: string;
+    
+    authParameters?: AuthParameter[];
+}
+export declare namespace CustomAuthConfig {
+    
+    const filterSensitiveLog: (obj: CustomAuthConfig) => any;
+}
+export declare enum OAuth2GrantType {
+    AUTHORIZATION_CODE = "AUTHORIZATION_CODE",
+    CLIENT_CREDENTIALS = "CLIENT_CREDENTIALS"
+}
+
+export interface OAuth2Defaults {
+    
+    oauthScopes?: string[];
+    
+    tokenUrls?: string[];
+    
+    authCodeUrls?: string[];
+    
+    oauth2GrantTypesSupported?: (OAuth2GrantType | string)[];
+}
+export declare namespace OAuth2Defaults {
+    
+    const filterSensitiveLog: (obj: OAuth2Defaults) => any;
+}
+
+export interface AuthenticationConfig {
+    
+    isBasicAuthSupported?: boolean;
+    
+    isApiKeyAuthSupported?: boolean;
+    
+    isOAuth2Supported?: boolean;
+    
+    isCustomAuthSupported?: boolean;
+    
+    oAuth2Defaults?: OAuth2Defaults;
+    
+    customAuthConfigs?: CustomAuthConfig[];
+}
+export declare namespace AuthenticationConfig {
+    
+    const filterSensitiveLog: (obj: AuthenticationConfig) => any;
+}
+export declare enum AuthenticationType {
+    APIKEY = "APIKEY",
+    BASIC = "BASIC",
+    CUSTOM = "CUSTOM",
+    OAUTH2 = "OAUTH2"
+}
+
 export interface BasicAuthCredentials {
     
     username: string | undefined;
@@ -277,8 +368,51 @@ export declare namespace ConnectorMetadata {
     
     const filterSensitiveLog: (obj: ConnectorMetadata) => any;
 }
+
+export interface LambdaConnectorProvisioningConfig {
+    
+    lambdaArn: string | undefined;
+}
+export declare namespace LambdaConnectorProvisioningConfig {
+    
+    const filterSensitiveLog: (obj: LambdaConnectorProvisioningConfig) => any;
+}
+
+export interface ConnectorProvisioningConfig {
+    
+    lambda?: LambdaConnectorProvisioningConfig;
+}
+export declare namespace ConnectorProvisioningConfig {
+    
+    const filterSensitiveLog: (obj: ConnectorProvisioningConfig) => any;
+}
+export declare enum ConnectorProvisioningType {
+    LAMBDA = "LAMBDA"
+}
+
+export interface ConnectorRuntimeSetting {
+    
+    key?: string;
+    
+    dataType?: string;
+    
+    isRequired?: boolean;
+    
+    label?: string;
+    
+    description?: string;
+    
+    scope?: string;
+    
+    connectorSuppliedValueOptions?: string[];
+}
+export declare namespace ConnectorRuntimeSetting {
+    
+    const filterSensitiveLog: (obj: ConnectorRuntimeSetting) => any;
+}
 export declare enum ConnectorType {
     AMPLITUDE = "Amplitude",
+    CUSTOMCONNECTOR = "CustomConnector",
     CUSTOMERPROFILES = "CustomerProfiles",
     DATADOG = "Datadog",
     DYNATRACE = "Dynatrace",
@@ -301,6 +435,29 @@ export declare enum ConnectorType {
     VEEVA = "Veeva",
     ZENDESK = "Zendesk"
 }
+export declare enum Operators {
+    ADDITION = "ADDITION",
+    BETWEEN = "BETWEEN",
+    CONTAINS = "CONTAINS",
+    DIVISION = "DIVISION",
+    EQUAL_TO = "EQUAL_TO",
+    GREATER_THAN = "GREATER_THAN",
+    GREATER_THAN_OR_EQUAL_TO = "GREATER_THAN_OR_EQUAL_TO",
+    LESS_THAN = "LESS_THAN",
+    LESS_THAN_OR_EQUAL_TO = "LESS_THAN_OR_EQUAL_TO",
+    MASK_ALL = "MASK_ALL",
+    MASK_FIRST_N = "MASK_FIRST_N",
+    MASK_LAST_N = "MASK_LAST_N",
+    MULTIPLICATION = "MULTIPLICATION",
+    NOT_EQUAL_TO = "NOT_EQUAL_TO",
+    NO_OP = "NO_OP",
+    PROJECTION = "PROJECTION",
+    SUBTRACTION = "SUBTRACTION",
+    VALIDATE_NON_NEGATIVE = "VALIDATE_NON_NEGATIVE",
+    VALIDATE_NON_NULL = "VALIDATE_NON_NULL",
+    VALIDATE_NON_ZERO = "VALIDATE_NON_ZERO",
+    VALIDATE_NUMERIC = "VALIDATE_NUMERIC"
+}
 export declare enum ScheduleFrequencyType {
     BYMINUTE = "BYMINUTE",
     DAILY = "DAILY",
@@ -314,6 +471,12 @@ export declare enum TriggerType {
     ONDEMAND = "OnDemand",
     SCHEDULED = "Scheduled"
 }
+export declare enum WriteOperationType {
+    DELETE = "DELETE",
+    INSERT = "INSERT",
+    UPDATE = "UPDATE",
+    UPSERT = "UPSERT"
+}
 
 export interface ConnectorConfiguration {
     
@@ -332,12 +495,77 @@ export interface ConnectorConfiguration {
     supportedTriggerTypes?: (TriggerType | string)[];
     
     connectorMetadata?: ConnectorMetadata;
+    
+    connectorType?: ConnectorType | string;
+    
+    connectorLabel?: string;
+    
+    connectorDescription?: string;
+    
+    connectorOwner?: string;
+    
+    connectorName?: string;
+    
+    connectorVersion?: string;
+    
+    connectorArn?: string;
+    
+    connectorModes?: string[];
+    
+    authenticationConfig?: AuthenticationConfig;
+    
+    connectorRuntimeSettings?: ConnectorRuntimeSetting[];
+    
+    supportedApiVersions?: string[];
+    
+    supportedOperators?: (Operators | string)[];
+    
+    supportedWriteOperations?: (WriteOperationType | string)[];
+    
+    connectorProvisioningType?: ConnectorProvisioningType | string;
+    
+    connectorProvisioningConfig?: ConnectorProvisioningConfig;
+    
+    logoURL?: string;
+    
+    registeredAt?: Date;
+    
+    registeredBy?: string;
 }
 export declare namespace ConnectorConfiguration {
     
     const filterSensitiveLog: (obj: ConnectorConfiguration) => any;
 }
 
+export interface ConnectorDetail {
+    
+    connectorDescription?: string;
+    
+    connectorName?: string;
+    
+    connectorOwner?: string;
+    
+    connectorVersion?: string;
+    
+    applicationType?: string;
+    
+    connectorType?: ConnectorType | string;
+    
+    connectorLabel?: string;
+    
+    registeredAt?: Date;
+    
+    registeredBy?: string;
+    
+    connectorProvisioningType?: ConnectorProvisioningType | string;
+    
+    connectorModes?: string[];
+}
+export declare namespace ConnectorDetail {
+    
+    const filterSensitiveLog: (obj: ConnectorDetail) => any;
+}
+
 export interface ConnectorEntity {
     
     name: string | undefined;
@@ -350,11 +578,6 @@ export declare namespace ConnectorEntity {
     
     const filterSensitiveLog: (obj: ConnectorEntity) => any;
 }
-export declare enum WriteOperationType {
-    INSERT = "INSERT",
-    UPDATE = "UPDATE",
-    UPSERT = "UPSERT"
-}
 
 export interface DestinationFieldProperties {
     
@@ -366,6 +589,8 @@ export interface DestinationFieldProperties {
     
     isUpdatable?: boolean;
     
+    isDefaultedOnCreate?: boolean;
+    
     supportedWriteOperations?: (WriteOperationType | string)[];
 }
 export declare namespace DestinationFieldProperties {
@@ -378,11 +603,24 @@ export interface SourceFieldProperties {
     isRetrievable?: boolean;
     
     isQueryable?: boolean;
+    
+    isTimestampFieldForIncrementalQueries?: boolean;
 }
 export declare namespace SourceFieldProperties {
     
     const filterSensitiveLog: (obj: SourceFieldProperties) => any;
 }
+
+export interface Range {
+    
+    maximum?: number;
+    
+    minimum?: number;
+}
+export declare namespace Range {
+    
+    const filterSensitiveLog: (obj: Range) => any;
+}
 export declare enum Operator {
     ADDITION = "ADDITION",
     BETWEEN = "BETWEEN",
@@ -414,6 +652,14 @@ export interface FieldTypeDetails {
     filterOperators: (Operator | string)[] | undefined;
     
     supportedValues?: string[];
+    
+    valueRegexPattern?: string;
+    
+    supportedDateFormat?: string;
+    
+    fieldValueRange?: Range;
+    
+    fieldLengthRange?: Range;
 }
 export declare namespace FieldTypeDetails {
     
@@ -433,8 +679,16 @@ export interface ConnectorEntityField {
     
     identifier: string | undefined;
     
+    parentIdentifier?: string;
+    
     label?: string;
     
+    isPrimaryKey?: boolean;
+    
+    defaultValue?: string;
+    
+    isDeprecated?: boolean;
+    
     supportedFieldTypeDetails?: SupportedFieldTypeDetails;
     
     description?: string;
@@ -442,6 +696,10 @@ export interface ConnectorEntityField {
     sourceProperties?: SourceFieldProperties;
     
     destinationProperties?: DestinationFieldProperties;
+    
+    customProperties?: {
+        [key: string]: string;
+    };
 }
 export declare namespace ConnectorEntityField {
     
@@ -746,12 +1004,38 @@ export interface ConnectorOperator {
     Zendesk?: ZendeskConnectorOperator | string;
     
     SAPOData?: SAPODataConnectorOperator | string;
+    
+    CustomConnector?: Operator | string;
 }
 export declare namespace ConnectorOperator {
     
     const filterSensitiveLog: (obj: ConnectorOperator) => any;
 }
 
+export interface OAuth2Properties {
+    
+    tokenUrl: string | undefined;
+    
+    oAuth2GrantType: OAuth2GrantType | string | undefined;
+}
+export declare namespace OAuth2Properties {
+    
+    const filterSensitiveLog: (obj: OAuth2Properties) => any;
+}
+
+export interface CustomConnectorProfileProperties {
+    
+    profileProperties?: {
+        [key: string]: string;
+    };
+    
+    oAuth2Properties?: OAuth2Properties;
+}
+export declare namespace CustomConnectorProfileProperties {
+    
+    const filterSensitiveLog: (obj: CustomConnectorProfileProperties) => any;
+}
+
 export interface DatadogConnectorProfileProperties {
     
     instanceUrl: string | undefined;
@@ -968,6 +1252,8 @@ export interface ConnectorProfileProperties {
     Zendesk?: ZendeskConnectorProfileProperties;
     
     SAPOData?: SAPODataConnectorProfileProperties;
+    
+    CustomConnector?: CustomConnectorProfileProperties;
 }
 export declare namespace ConnectorProfileProperties {
     
@@ -1007,6 +1293,8 @@ export interface ConnectorProfile {
     
     connectorType?: ConnectorType | string;
     
+    connectorLabel?: string;
+    
     connectionMode?: ConnectionMode | string;
     
     credentialsArn?: string;
@@ -1024,6 +1312,53 @@ export declare namespace ConnectorProfile {
     const filterSensitiveLog: (obj: ConnectorProfile) => any;
 }
 
+export interface CustomAuthCredentials {
+    
+    customAuthenticationType: string | undefined;
+    
+    credentialsMap?: {
+        [key: string]: string;
+    };
+}
+export declare namespace CustomAuthCredentials {
+    
+    const filterSensitiveLog: (obj: CustomAuthCredentials) => any;
+}
+
+export interface OAuth2Credentials {
+    
+    clientId?: string;
+    
+    clientSecret?: string;
+    
+    accessToken?: string;
+    
+    refreshToken?: string;
+    
+    oAuthRequest?: ConnectorOAuthRequest;
+}
+export declare namespace OAuth2Credentials {
+    
+    const filterSensitiveLog: (obj: OAuth2Credentials) => any;
+}
+
+export interface CustomConnectorProfileCredentials {
+    
+    authenticationType: AuthenticationType | string | undefined;
+    
+    basic?: BasicAuthCredentials;
+    
+    oauth2?: OAuth2Credentials;
+    
+    apiKey?: ApiKeyCredentials;
+    
+    custom?: CustomAuthCredentials;
+}
+export declare namespace CustomConnectorProfileCredentials {
+    
+    const filterSensitiveLog: (obj: CustomConnectorProfileCredentials) => any;
+}
+
 export interface DatadogConnectorProfileCredentials {
     
     apiKey: string | undefined;
@@ -1274,6 +1609,8 @@ export interface ConnectorProfileCredentials {
     Zendesk?: ZendeskConnectorProfileCredentials;
     
     SAPOData?: SAPODataConnectorProfileCredentials;
+    
+    CustomConnector?: CustomConnectorProfileCredentials;
 }
 export declare namespace ConnectorProfileCredentials {
     
@@ -1304,6 +1641,8 @@ export interface CreateConnectorProfileRequest {
     
     connectorType: ConnectorType | string | undefined;
     
+    connectorLabel?: string;
+    
     connectionMode: ConnectionMode | string | undefined;
     
     connectorProfileConfig: ConnectorProfileConfig | undefined;
@@ -1339,17 +1678,6 @@ export interface ValidationException extends __SmithyException, $MetadataBearer
     message?: string;
 }
 
-export interface CustomerProfilesDestinationProperties {
-    
-    domainName: string | undefined;
-    
-    objectTypeName?: string;
-}
-export declare namespace CustomerProfilesDestinationProperties {
-    
-    const filterSensitiveLog: (obj: CustomerProfilesDestinationProperties) => any;
-}
-
 export interface ErrorHandlingConfig {
     
     failOnFirstDestinationError?: boolean;
@@ -1363,6 +1691,36 @@ export declare namespace ErrorHandlingConfig {
     const filterSensitiveLog: (obj: ErrorHandlingConfig) => any;
 }
 
+export interface CustomConnectorDestinationProperties {
+    
+    entityName: string | undefined;
+    
+    errorHandlingConfig?: ErrorHandlingConfig;
+    
+    writeOperationType?: WriteOperationType | string;
+    
+    idFieldNames?: string[];
+    
+    customProperties?: {
+        [key: string]: string;
+    };
+}
+export declare namespace CustomConnectorDestinationProperties {
+    
+    const filterSensitiveLog: (obj: CustomConnectorDestinationProperties) => any;
+}
+
+export interface CustomerProfilesDestinationProperties {
+    
+    domainName: string | undefined;
+    
+    objectTypeName?: string;
+}
+export declare namespace CustomerProfilesDestinationProperties {
+    
+    const filterSensitiveLog: (obj: CustomerProfilesDestinationProperties) => any;
+}
+
 export interface EventBridgeDestinationProperties {
     
     object: string | undefined;
@@ -1476,6 +1834,34 @@ export declare namespace SalesforceDestinationProperties {
     const filterSensitiveLog: (obj: SalesforceDestinationProperties) => any;
 }
 
+export interface SuccessResponseHandlingConfig {
+    
+    bucketPrefix?: string;
+    
+    bucketName?: string;
+}
+export declare namespace SuccessResponseHandlingConfig {
+    
+    const filterSensitiveLog: (obj: SuccessResponseHandlingConfig) => any;
+}
+
+export interface SAPODataDestinationProperties {
+    
+    objectPath: string | undefined;
+    
+    successResponseHandlingConfig?: SuccessResponseHandlingConfig;
+    
+    idFieldNames?: string[];
+    
+    errorHandlingConfig?: ErrorHandlingConfig;
+    
+    writeOperationType?: WriteOperationType | string;
+}
+export declare namespace SAPODataDestinationProperties {
+    
+    const filterSensitiveLog: (obj: SAPODataDestinationProperties) => any;
+}
+
 export interface SnowflakeDestinationProperties {
     
     object: string | undefined;
@@ -1553,6 +1939,10 @@ export interface DestinationConnectorProperties {
     CustomerProfiles?: CustomerProfilesDestinationProperties;
     
     Zendesk?: ZendeskDestinationProperties;
+    
+    CustomConnector?: CustomConnectorDestinationProperties;
+    
+    SAPOData?: SAPODataDestinationProperties;
 }
 export declare namespace DestinationConnectorProperties {
     
@@ -1563,6 +1953,8 @@ export interface DestinationFlowConfig {
     
     connectorType: ConnectorType | string | undefined;
     
+    apiVersion?: string;
+    
     connectorProfileName?: string;
     
     destinationConnectorProperties: DestinationConnectorProperties | undefined;
@@ -1581,6 +1973,19 @@ export declare namespace IncrementalPullConfig {
     const filterSensitiveLog: (obj: IncrementalPullConfig) => any;
 }
 
+export interface CustomConnectorSourceProperties {
+    
+    entityName: string | undefined;
+    
+    customProperties?: {
+        [key: string]: string;
+    };
+}
+export declare namespace CustomConnectorSourceProperties {
+    
+    const filterSensitiveLog: (obj: CustomConnectorSourceProperties) => any;
+}
+
 export interface DatadogSourceProperties {
     
     object: string | undefined;
@@ -1767,6 +2172,8 @@ export interface SourceConnectorProperties {
     Zendesk?: ZendeskSourceProperties;
     
     SAPOData?: SAPODataSourceProperties;
+    
+    CustomConnector?: CustomConnectorSourceProperties;
 }
 export declare namespace SourceConnectorProperties {
     
@@ -1777,6 +2184,8 @@ export interface SourceFlowConfig {
     
     connectorType: ConnectorType | string | undefined;
     
+    apiVersion?: string;
+    
     connectorProfileName?: string;
     
     sourceConnectorProperties: SourceConnectorProperties | undefined;
@@ -1811,6 +2220,7 @@ export declare enum TaskType {
     MAP_ALL = "Map_all",
     MASK = "Mask",
     MERGE = "Merge",
+    PASSTHROUGH = "Passthrough",
     TRUNCATE = "Truncate",
     VALIDATE = "Validate"
 }
@@ -1958,6 +2368,24 @@ export declare namespace DeleteFlowResponse {
     
     const filterSensitiveLog: (obj: DeleteFlowResponse) => any;
 }
+export interface DescribeConnectorRequest {
+    
+    connectorType: ConnectorType | string | undefined;
+    
+    connectorLabel?: string;
+}
+export declare namespace DescribeConnectorRequest {
+    
+    const filterSensitiveLog: (obj: DescribeConnectorRequest) => any;
+}
+export interface DescribeConnectorResponse {
+    
+    connectorConfiguration?: ConnectorConfiguration;
+}
+export declare namespace DescribeConnectorResponse {
+    
+    const filterSensitiveLog: (obj: DescribeConnectorResponse) => any;
+}
 export interface DescribeConnectorEntityRequest {
     
     connectorEntityName: string | undefined;
@@ -1965,6 +2393,8 @@ export interface DescribeConnectorEntityRequest {
     connectorType?: ConnectorType | string;
     
     connectorProfileName?: string;
+    
+    apiVersion?: string;
 }
 export declare namespace DescribeConnectorEntityRequest {
     
@@ -1984,6 +2414,8 @@ export interface DescribeConnectorProfilesRequest {
     
     connectorType?: ConnectorType | string;
     
+    connectorLabel?: string;
+    
     maxResults?: number;
     
     nextToken?: string;
@@ -2006,6 +2438,8 @@ export interface DescribeConnectorsRequest {
     
     connectorTypes?: (ConnectorType | string)[];
     
+    maxResults?: number;
+    
     nextToken?: string;
 }
 export declare namespace DescribeConnectorsRequest {
@@ -2018,6 +2452,8 @@ export interface DescribeConnectorsResponse {
         [key: string]: ConnectorConfiguration;
     };
     
+    connectors?: ConnectorDetail[];
+    
     nextToken?: string;
 }
 export declare namespace DescribeConnectorsResponse {
@@ -2172,8 +2608,12 @@ export interface FlowDefinition {
     
     sourceConnectorType?: ConnectorType | string;
     
+    sourceConnectorLabel?: string;
+    
     destinationConnectorType?: ConnectorType | string;
     
+    destinationConnectorLabel?: string;
+    
     triggerType?: TriggerType | string;
     
     createdAt?: Date;
@@ -2201,6 +2641,8 @@ export interface ListConnectorEntitiesRequest {
     connectorType?: ConnectorType | string;
     
     entitiesPath?: string;
+    
+    apiVersion?: string;
 }
 export declare namespace ListConnectorEntitiesRequest {
     
@@ -2216,6 +2658,26 @@ export declare namespace ListConnectorEntitiesResponse {
     
     const filterSensitiveLog: (obj: ListConnectorEntitiesResponse) => any;
 }
+export interface ListConnectorsRequest {
+    
+    maxResults?: number;
+    
+    nextToken?: string;
+}
+export declare namespace ListConnectorsRequest {
+    
+    const filterSensitiveLog: (obj: ListConnectorsRequest) => any;
+}
+export interface ListConnectorsResponse {
+    
+    connectors?: ConnectorDetail[];
+    
+    nextToken?: string;
+}
+export declare namespace ListConnectorsResponse {
+    
+    const filterSensitiveLog: (obj: ListConnectorsResponse) => any;
+}
 export interface ListFlowsRequest {
     
     maxResults?: number;
@@ -2254,6 +2716,34 @@ export declare namespace ListTagsForResourceResponse {
     
     const filterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
 }
+export interface RegisterConnectorRequest {
+    
+    connectorLabel?: string;
+    
+    description?: string;
+    
+    connectorProvisioningType?: ConnectorProvisioningType | string;
+    
+    connectorProvisioningConfig?: ConnectorProvisioningConfig;
+}
+export declare namespace RegisterConnectorRequest {
+    
+    const filterSensitiveLog: (obj: RegisterConnectorRequest) => any;
+}
+export interface RegisterConnectorResponse {
+    
+    connectorArn?: string;
+}
+export declare namespace RegisterConnectorResponse {
+    
+    const filterSensitiveLog: (obj: RegisterConnectorResponse) => any;
+}
+
+export interface ThrottlingException extends __SmithyException, $MetadataBearer {
+    name: "ThrottlingException";
+    $fault: "client";
+    message?: string;
+}
 export interface StartFlowRequest {
     
     flowName: string | undefined;
@@ -2316,6 +2806,22 @@ export declare namespace TagResourceResponse {
     
     const filterSensitiveLog: (obj: TagResourceResponse) => any;
 }
+export interface UnregisterConnectorRequest {
+    
+    connectorLabel: string | undefined;
+    
+    forceDelete?: boolean;
+}
+export declare namespace UnregisterConnectorRequest {
+    
+    const filterSensitiveLog: (obj: UnregisterConnectorRequest) => any;
+}
+export interface UnregisterConnectorResponse {
+}
+export declare namespace UnregisterConnectorResponse {
+    
+    const filterSensitiveLog: (obj: UnregisterConnectorResponse) => any;
+}
 export interface UntagResourceRequest {
     
     resourceArn: string | undefined;