Skip to content

AppflowClient#

Index > Appflow > AppflowClient

Auto-generated documentation for Appflow type annotations stubs module types-boto3-appflow.

AppflowClient#

Type annotations and code completion for boto3.client("appflow"). boto3 documentation

# AppflowClient usage example

from boto3.session import Session
from types_boto3_appflow.client import AppflowClient

def get_appflow_client() -> AppflowClient:
    return Session().client("appflow")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("appflow").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("appflow")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.ConnectorAuthenticationException,
    client.exceptions.ConnectorServerException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.UnsupportedOperationException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_appflow.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("appflow").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("appflow").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

cancel_flow_executions#

Cancels active runs for a flow.

Type annotations and code completion for boto3.client("appflow").cancel_flow_executions method. boto3 documentation

# cancel_flow_executions method definition

def cancel_flow_executions(
    self,
    *,
    flowName: str,
    executionIds: Sequence[str] = ...,
) -> CancelFlowExecutionsResponseTypeDef:  # (1)
    ...
  1. See CancelFlowExecutionsResponseTypeDef 
# cancel_flow_executions method usage example with argument unpacking

kwargs: CancelFlowExecutionsRequestRequestTypeDef = {  # (1)
    "flowName": ...,
}

parent.cancel_flow_executions(**kwargs)
  1. See CancelFlowExecutionsRequestRequestTypeDef

create_connector_profile#

Creates a new connector profile associated with your Amazon Web Services account.

Type annotations and code completion for boto3.client("appflow").create_connector_profile method. boto3 documentation

# create_connector_profile method definition

def create_connector_profile(
    self,
    *,
    connectorProfileName: str,
    connectorType: ConnectorTypeType,  # (1)
    connectionMode: ConnectionModeType,  # (2)
    connectorProfileConfig: ConnectorProfileConfigTypeDef,  # (3)
    kmsArn: str = ...,
    connectorLabel: str = ...,
    clientToken: str = ...,
) -> CreateConnectorProfileResponseTypeDef:  # (4)
    ...
  1. See ConnectorTypeType
  2. See ConnectionModeType
  3. See ConnectorProfileConfigTypeDef
  4. See CreateConnectorProfileResponseTypeDef 
# create_connector_profile method usage example with argument unpacking

kwargs: CreateConnectorProfileRequestRequestTypeDef = {  # (1)
    "connectorProfileName": ...,
    "connectorType": ...,
    "connectionMode": ...,
    "connectorProfileConfig": ...,
}

parent.create_connector_profile(**kwargs)
  1. See CreateConnectorProfileRequestRequestTypeDef

create_flow#

Enables your application to create a new flow using Amazon AppFlow.

Type annotations and code completion for boto3.client("appflow").create_flow method. boto3 documentation

# create_flow method definition

def create_flow(
    self,
    *,
    flowName: str,
    triggerConfig: TriggerConfigTypeDef,  # (1)
    sourceFlowConfig: SourceFlowConfigTypeDef,  # (2)
    destinationFlowConfigList: Sequence[DestinationFlowConfigUnionTypeDef],  # (3)
    tasks: Sequence[TaskUnionTypeDef],  # (4)
    description: str = ...,
    kmsArn: str = ...,
    tags: Mapping[str, str] = ...,
    metadataCatalogConfig: MetadataCatalogConfigTypeDef = ...,  # (5)
    clientToken: str = ...,
) -> CreateFlowResponseTypeDef:  # (6)
    ...
  1. See TriggerConfigTypeDef
  2. See SourceFlowConfigTypeDef
  3. See DestinationFlowConfigTypeDef DestinationFlowConfigOutputTypeDef
  4. See TaskTypeDef TaskOutputTypeDef
  5. See MetadataCatalogConfigTypeDef
  6. See CreateFlowResponseTypeDef 
# create_flow method usage example with argument unpacking

kwargs: CreateFlowRequestRequestTypeDef = {  # (1)
    "flowName": ...,
    "triggerConfig": ...,
    "sourceFlowConfig": ...,
    "destinationFlowConfigList": ...,
    "tasks": ...,
}

parent.create_flow(**kwargs)
  1. See CreateFlowRequestRequestTypeDef

delete_connector_profile#

Enables you to delete an existing connector profile.

Type annotations and code completion for boto3.client("appflow").delete_connector_profile method. boto3 documentation

# delete_connector_profile method definition

def delete_connector_profile(
    self,
    *,
    connectorProfileName: str,
    forceDelete: bool = ...,
) -> dict[str, Any]:
    ...
# delete_connector_profile method usage example with argument unpacking

kwargs: DeleteConnectorProfileRequestRequestTypeDef = {  # (1)
    "connectorProfileName": ...,
}

parent.delete_connector_profile(**kwargs)
  1. See DeleteConnectorProfileRequestRequestTypeDef

delete_flow#

Enables your application to delete an existing flow.

Type annotations and code completion for boto3.client("appflow").delete_flow method. boto3 documentation

# delete_flow method definition

def delete_flow(
    self,
    *,
    flowName: str,
    forceDelete: bool = ...,
) -> dict[str, Any]:
    ...
# delete_flow method usage example with argument unpacking

kwargs: DeleteFlowRequestRequestTypeDef = {  # (1)
    "flowName": ...,
}

parent.delete_flow(**kwargs)
  1. See DeleteFlowRequestRequestTypeDef

describe_connector#

Describes the given custom connector registered in your Amazon Web Services account.

Type annotations and code completion for boto3.client("appflow").describe_connector method. boto3 documentation

# describe_connector method definition

def describe_connector(
    self,
    *,
    connectorType: ConnectorTypeType,  # (1)
    connectorLabel: str = ...,
) -> DescribeConnectorResponseTypeDef:  # (2)
    ...
  1. See ConnectorTypeType
  2. See DescribeConnectorResponseTypeDef 
# describe_connector method usage example with argument unpacking

kwargs: DescribeConnectorRequestRequestTypeDef = {  # (1)
    "connectorType": ...,
}

parent.describe_connector(**kwargs)
  1. See DescribeConnectorRequestRequestTypeDef

describe_connector_entity#

Provides details regarding the entity used with the connector, with a description of the data model for each field in that entity.

Type annotations and code completion for boto3.client("appflow").describe_connector_entity method. boto3 documentation

# describe_connector_entity method definition

def describe_connector_entity(
    self,
    *,
    connectorEntityName: str,
    connectorType: ConnectorTypeType = ...,  # (1)
    connectorProfileName: str = ...,
    apiVersion: str = ...,
) -> DescribeConnectorEntityResponseTypeDef:  # (2)
    ...
  1. See ConnectorTypeType
  2. See DescribeConnectorEntityResponseTypeDef 
# describe_connector_entity method usage example with argument unpacking

kwargs: DescribeConnectorEntityRequestRequestTypeDef = {  # (1)
    "connectorEntityName": ...,
}

parent.describe_connector_entity(**kwargs)
  1. See DescribeConnectorEntityRequestRequestTypeDef

describe_connector_profiles#

Returns a list of connector-profile details matching the provided connector-profile names and connector-types.

Type annotations and code completion for boto3.client("appflow").describe_connector_profiles method. boto3 documentation

# describe_connector_profiles method definition

def describe_connector_profiles(
    self,
    *,
    connectorProfileNames: Sequence[str] = ...,
    connectorType: ConnectorTypeType = ...,  # (1)
    connectorLabel: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeConnectorProfilesResponseTypeDef:  # (2)
    ...
  1. See ConnectorTypeType
  2. See DescribeConnectorProfilesResponseTypeDef 
# describe_connector_profiles method usage example with argument unpacking

kwargs: DescribeConnectorProfilesRequestRequestTypeDef = {  # (1)
    "connectorProfileNames": ...,
}

parent.describe_connector_profiles(**kwargs)
  1. See DescribeConnectorProfilesRequestRequestTypeDef

describe_connectors#

Describes the connectors vended by Amazon AppFlow for specified connector types.

Type annotations and code completion for boto3.client("appflow").describe_connectors method. boto3 documentation

# describe_connectors method definition

def describe_connectors(
    self,
    *,
    connectorTypes: Sequence[ConnectorTypeType] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeConnectorsResponseTypeDef:  # (2)
    ...
  1. See ConnectorTypeType
  2. See DescribeConnectorsResponseTypeDef 
# describe_connectors method usage example with argument unpacking

kwargs: DescribeConnectorsRequestRequestTypeDef = {  # (1)
    "connectorTypes": ...,
}

parent.describe_connectors(**kwargs)
  1. See DescribeConnectorsRequestRequestTypeDef

describe_flow#

Provides a description of the specified flow.

Type annotations and code completion for boto3.client("appflow").describe_flow method. boto3 documentation

# describe_flow method definition

def describe_flow(
    self,
    *,
    flowName: str,
) -> DescribeFlowResponseTypeDef:  # (1)
    ...
  1. See DescribeFlowResponseTypeDef 
# describe_flow method usage example with argument unpacking

kwargs: DescribeFlowRequestRequestTypeDef = {  # (1)
    "flowName": ...,
}

parent.describe_flow(**kwargs)
  1. See DescribeFlowRequestRequestTypeDef

describe_flow_execution_records#

Fetches the execution history of the flow.

Type annotations and code completion for boto3.client("appflow").describe_flow_execution_records method. boto3 documentation

# describe_flow_execution_records method definition

def describe_flow_execution_records(
    self,
    *,
    flowName: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeFlowExecutionRecordsResponseTypeDef:  # (1)
    ...
  1. See DescribeFlowExecutionRecordsResponseTypeDef 
# describe_flow_execution_records method usage example with argument unpacking

kwargs: DescribeFlowExecutionRecordsRequestRequestTypeDef = {  # (1)
    "flowName": ...,
}

parent.describe_flow_execution_records(**kwargs)
  1. See DescribeFlowExecutionRecordsRequestRequestTypeDef

list_connector_entities#

Returns the list of available connector entities supported by Amazon AppFlow.

Type annotations and code completion for boto3.client("appflow").list_connector_entities method. boto3 documentation

# list_connector_entities method definition

def list_connector_entities(
    self,
    *,
    connectorProfileName: str = ...,
    connectorType: ConnectorTypeType = ...,  # (1)
    entitiesPath: str = ...,
    apiVersion: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListConnectorEntitiesResponseTypeDef:  # (2)
    ...
  1. See ConnectorTypeType
  2. See ListConnectorEntitiesResponseTypeDef 
# list_connector_entities method usage example with argument unpacking

kwargs: ListConnectorEntitiesRequestRequestTypeDef = {  # (1)
    "connectorProfileName": ...,
}

parent.list_connector_entities(**kwargs)
  1. See ListConnectorEntitiesRequestRequestTypeDef

list_connectors#

Returns the list of all registered custom connectors in your Amazon Web Services account.

Type annotations and code completion for boto3.client("appflow").list_connectors method. boto3 documentation

# list_connectors method definition

def list_connectors(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListConnectorsResponseTypeDef:  # (1)
    ...
  1. See ListConnectorsResponseTypeDef 
# list_connectors method usage example with argument unpacking

kwargs: ListConnectorsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_connectors(**kwargs)
  1. See ListConnectorsRequestRequestTypeDef

list_flows#

Lists all of the flows associated with your account.

Type annotations and code completion for boto3.client("appflow").list_flows method. boto3 documentation

# list_flows method definition

def list_flows(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListFlowsResponseTypeDef:  # (1)
    ...
  1. See ListFlowsResponseTypeDef 
# list_flows method usage example with argument unpacking

kwargs: ListFlowsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_flows(**kwargs)
  1. See ListFlowsRequestRequestTypeDef

list_tags_for_resource#

Retrieves the tags that are associated with a specified flow.

Type annotations and code completion for boto3.client("appflow").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

register_connector#

Registers a new custom connector with your Amazon Web Services account.

Type annotations and code completion for boto3.client("appflow").register_connector method. boto3 documentation

# register_connector method definition

def register_connector(
    self,
    *,
    connectorLabel: str = ...,
    description: str = ...,
    connectorProvisioningType: ConnectorProvisioningTypeType = ...,  # (1)
    connectorProvisioningConfig: ConnectorProvisioningConfigTypeDef = ...,  # (2)
    clientToken: str = ...,
) -> RegisterConnectorResponseTypeDef:  # (3)
    ...
  1. See ConnectorProvisioningTypeType
  2. See ConnectorProvisioningConfigTypeDef
  3. See RegisterConnectorResponseTypeDef 
# register_connector method usage example with argument unpacking

kwargs: RegisterConnectorRequestRequestTypeDef = {  # (1)
    "connectorLabel": ...,
}

parent.register_connector(**kwargs)
  1. See RegisterConnectorRequestRequestTypeDef

reset_connector_metadata_cache#

Resets metadata about your connector entities that Amazon AppFlow stored in its cache.

Type annotations and code completion for boto3.client("appflow").reset_connector_metadata_cache method. boto3 documentation

# reset_connector_metadata_cache method definition

def reset_connector_metadata_cache(
    self,
    *,
    connectorProfileName: str = ...,
    connectorType: ConnectorTypeType = ...,  # (1)
    connectorEntityName: str = ...,
    entitiesPath: str = ...,
    apiVersion: str = ...,
) -> dict[str, Any]:
    ...
  1. See ConnectorTypeType 
# reset_connector_metadata_cache method usage example with argument unpacking

kwargs: ResetConnectorMetadataCacheRequestRequestTypeDef = {  # (1)
    "connectorProfileName": ...,
}

parent.reset_connector_metadata_cache(**kwargs)
  1. See ResetConnectorMetadataCacheRequestRequestTypeDef

start_flow#

Activates an existing flow.

Type annotations and code completion for boto3.client("appflow").start_flow method. boto3 documentation

# start_flow method definition

def start_flow(
    self,
    *,
    flowName: str,
    clientToken: str = ...,
) -> StartFlowResponseTypeDef:  # (1)
    ...
  1. See StartFlowResponseTypeDef 
# start_flow method usage example with argument unpacking

kwargs: StartFlowRequestRequestTypeDef = {  # (1)
    "flowName": ...,
}

parent.start_flow(**kwargs)
  1. See StartFlowRequestRequestTypeDef

stop_flow#

Deactivates the existing flow.

Type annotations and code completion for boto3.client("appflow").stop_flow method. boto3 documentation

# stop_flow method definition

def stop_flow(
    self,
    *,
    flowName: str,
) -> StopFlowResponseTypeDef:  # (1)
    ...
  1. See StopFlowResponseTypeDef 
# stop_flow method usage example with argument unpacking

kwargs: StopFlowRequestRequestTypeDef = {  # (1)
    "flowName": ...,
}

parent.stop_flow(**kwargs)
  1. See StopFlowRequestRequestTypeDef

tag_resource#

Applies a tag to the specified flow.

Type annotations and code completion for boto3.client("appflow").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

unregister_connector#

Unregisters the custom connector registered in your account that matches the connector label provided in the request.

Type annotations and code completion for boto3.client("appflow").unregister_connector method. boto3 documentation

# unregister_connector method definition

def unregister_connector(
    self,
    *,
    connectorLabel: str,
    forceDelete: bool = ...,
) -> dict[str, Any]:
    ...
# unregister_connector method usage example with argument unpacking

kwargs: UnregisterConnectorRequestRequestTypeDef = {  # (1)
    "connectorLabel": ...,
}

parent.unregister_connector(**kwargs)
  1. See UnregisterConnectorRequestRequestTypeDef

untag_resource#

Removes a tag from the specified flow.

Type annotations and code completion for boto3.client("appflow").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_connector_profile#

Updates a given connector profile associated with your account.

Type annotations and code completion for boto3.client("appflow").update_connector_profile method. boto3 documentation

# update_connector_profile method definition

def update_connector_profile(
    self,
    *,
    connectorProfileName: str,
    connectionMode: ConnectionModeType,  # (1)
    connectorProfileConfig: ConnectorProfileConfigTypeDef,  # (2)
    clientToken: str = ...,
) -> UpdateConnectorProfileResponseTypeDef:  # (3)
    ...
  1. See ConnectionModeType
  2. See ConnectorProfileConfigTypeDef
  3. See UpdateConnectorProfileResponseTypeDef 
# update_connector_profile method usage example with argument unpacking

kwargs: UpdateConnectorProfileRequestRequestTypeDef = {  # (1)
    "connectorProfileName": ...,
    "connectionMode": ...,
    "connectorProfileConfig": ...,
}

parent.update_connector_profile(**kwargs)
  1. See UpdateConnectorProfileRequestRequestTypeDef

update_connector_registration#

Updates a custom connector that you've previously registered.

Type annotations and code completion for boto3.client("appflow").update_connector_registration method. boto3 documentation

# update_connector_registration method definition

def update_connector_registration(
    self,
    *,
    connectorLabel: str,
    description: str = ...,
    connectorProvisioningConfig: ConnectorProvisioningConfigTypeDef = ...,  # (1)
    clientToken: str = ...,
) -> UpdateConnectorRegistrationResponseTypeDef:  # (2)
    ...
  1. See ConnectorProvisioningConfigTypeDef
  2. See UpdateConnectorRegistrationResponseTypeDef 
# update_connector_registration method usage example with argument unpacking

kwargs: UpdateConnectorRegistrationRequestRequestTypeDef = {  # (1)
    "connectorLabel": ...,
}

parent.update_connector_registration(**kwargs)
  1. See UpdateConnectorRegistrationRequestRequestTypeDef

update_flow#

Updates an existing flow.

Type annotations and code completion for boto3.client("appflow").update_flow method. boto3 documentation

# update_flow method definition

def update_flow(
    self,
    *,
    flowName: str,
    triggerConfig: TriggerConfigTypeDef,  # (1)
    sourceFlowConfig: SourceFlowConfigTypeDef,  # (2)
    destinationFlowConfigList: Sequence[DestinationFlowConfigTypeDef],  # (3)
    tasks: Sequence[TaskTypeDef],  # (4)
    description: str = ...,
    metadataCatalogConfig: MetadataCatalogConfigTypeDef = ...,  # (5)
    clientToken: str = ...,
) -> UpdateFlowResponseTypeDef:  # (6)
    ...
  1. See TriggerConfigTypeDef
  2. See SourceFlowConfigTypeDef
  3. See DestinationFlowConfigTypeDef
  4. See TaskTypeDef
  5. See MetadataCatalogConfigTypeDef
  6. See UpdateFlowResponseTypeDef 
# update_flow method usage example with argument unpacking

kwargs: UpdateFlowRequestRequestTypeDef = {  # (1)
    "flowName": ...,
    "triggerConfig": ...,
    "sourceFlowConfig": ...,
    "destinationFlowConfigList": ...,
    "tasks": ...,
}

parent.update_flow(**kwargs)
  1. See UpdateFlowRequestRequestTypeDef