Skip to content

AppflowClient

Index > Appflow > AppflowClient

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

AppflowClient

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

Usage example
from boto3.session import Session
from mypy_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.

Usage example
client = boto3.client("appflow")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.ConnectorAuthenticationException,
    client.ConnectorServerException,
    client.InternalServerException,
    client.ResourceNotFoundException,
    client.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.UnsupportedOperationException,
    client.ValidationException,
) as e:
    print(e)
Type checking example
from mypy_boto3_appflow.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

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

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

close

Closes underlying endpoint connections.

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

Method definition
def close(
    self,
) -> None:
    ...

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

Method definition
def create_connector_profile(
    self,
    *,
    connectorProfileName: str,
    connectorType: ConnectorTypeType,  # (1)
    connectionMode: ConnectionModeType,  # (2)
    connectorProfileConfig: ConnectorProfileConfigTypeDef,  # (3)
    kmsArn: str = ...,
    connectorLabel: str = ...,
) -> CreateConnectorProfileResponseTypeDef:  # (4)
    ...
  1. See ConnectorTypeType
  2. See ConnectionModeType
  3. See ConnectorProfileConfigTypeDef
  4. See CreateConnectorProfileResponseTypeDef
Usage example with kwargs
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

Method definition
def create_flow(
    self,
    *,
    flowName: str,
    triggerConfig: TriggerConfigTypeDef,  # (1)
    sourceFlowConfig: SourceFlowConfigTypeDef,  # (2)
    destinationFlowConfigList: Sequence[DestinationFlowConfigTypeDef],  # (3)
    tasks: Sequence[TaskTypeDef],  # (4)
    description: str = ...,
    kmsArn: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateFlowResponseTypeDef:  # (5)
    ...
  1. See TriggerConfigTypeDef
  2. See SourceFlowConfigTypeDef
  3. See DestinationFlowConfigTypeDef
  4. See TaskTypeDef
  5. See CreateFlowResponseTypeDef
Usage example with kwargs
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

Method definition
def delete_connector_profile(
    self,
    *,
    connectorProfileName: str,
    forceDelete: bool = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

Method definition
def delete_flow(
    self,
    *,
    flowName: str,
    forceDelete: bool = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

Method definition
def describe_connector(
    self,
    *,
    connectorType: ConnectorTypeType,  # (1)
    connectorLabel: str = ...,
) -> DescribeConnectorResponseTypeDef:  # (2)
    ...
  1. See ConnectorTypeType
  2. See DescribeConnectorResponseTypeDef
Usage example with kwargs
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

Method definition
def describe_connector_entity(
    self,
    *,
    connectorEntityName: str,
    connectorType: ConnectorTypeType = ...,  # (1)
    connectorProfileName: str = ...,
    apiVersion: str = ...,
) -> DescribeConnectorEntityResponseTypeDef:  # (2)
    ...
  1. See ConnectorTypeType
  2. See DescribeConnectorEntityResponseTypeDef
Usage example with kwargs
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

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
Usage example with kwargs
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

Method definition
def describe_connectors(
    self,
    *,
    connectorTypes: Sequence[ConnectorTypeType] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeConnectorsResponseTypeDef:  # (2)
    ...
  1. See ConnectorTypeType
  2. See DescribeConnectorsResponseTypeDef
Usage example with kwargs
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

Method definition
def describe_flow(
    self,
    *,
    flowName: str,
) -> DescribeFlowResponseTypeDef:  # (1)
    ...
  1. See DescribeFlowResponseTypeDef
Usage example with kwargs
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

Method definition
def describe_flow_execution_records(
    self,
    *,
    flowName: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeFlowExecutionRecordsResponseTypeDef:  # (1)
    ...
  1. See DescribeFlowExecutionRecordsResponseTypeDef
Usage example with kwargs
kwargs: DescribeFlowExecutionRecordsRequestRequestTypeDef = {  # (1)
    "flowName": ...,
}

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

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

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

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

Method definition
def list_connector_entities(
    self,
    *,
    connectorProfileName: str = ...,
    connectorType: ConnectorTypeType = ...,  # (1)
    entitiesPath: str = ...,
    apiVersion: str = ...,
) -> ListConnectorEntitiesResponseTypeDef:  # (2)
    ...
  1. See ConnectorTypeType
  2. See ListConnectorEntitiesResponseTypeDef
Usage example with kwargs
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

Method definition
def list_connectors(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListConnectorsResponseTypeDef:  # (1)
    ...
  1. See ListConnectorsResponseTypeDef
Usage example with kwargs
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

Method definition
def list_flows(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListFlowsResponseTypeDef:  # (1)
    ...
  1. See ListFlowsResponseTypeDef
Usage example with kwargs
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

Method definition
def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

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

register_connector

Registers a new connector with your Amazon Web Services account.

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

Method definition
def register_connector(
    self,
    *,
    connectorLabel: str = ...,
    description: str = ...,
    connectorProvisioningType: ConnectorProvisioningTypeType = ...,  # (1)
    connectorProvisioningConfig: ConnectorProvisioningConfigTypeDef = ...,  # (2)
) -> RegisterConnectorResponseTypeDef:  # (3)
    ...
  1. See ConnectorProvisioningTypeType
  2. See ConnectorProvisioningConfigTypeDef
  3. See RegisterConnectorResponseTypeDef
Usage example with kwargs
kwargs: RegisterConnectorRequestRequestTypeDef = {  # (1)
    "connectorLabel": ...,
}

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

start_flow

Activates an existing flow.

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

Method definition
def start_flow(
    self,
    *,
    flowName: str,
) -> StartFlowResponseTypeDef:  # (1)
    ...
  1. See StartFlowResponseTypeDef
Usage example with kwargs
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

Method definition
def stop_flow(
    self,
    *,
    flowName: str,
) -> StopFlowResponseTypeDef:  # (1)
    ...
  1. See StopFlowResponseTypeDef
Usage example with kwargs
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

Method definition
def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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 connectorLabel provided in the request.

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

Method definition
def unregister_connector(
    self,
    *,
    connectorLabel: str,
    forceDelete: bool = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

Method definition
def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
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

Method definition
def update_connector_profile(
    self,
    *,
    connectorProfileName: str,
    connectionMode: ConnectionModeType,  # (1)
    connectorProfileConfig: ConnectorProfileConfigTypeDef,  # (2)
) -> UpdateConnectorProfileResponseTypeDef:  # (3)
    ...
  1. See ConnectionModeType
  2. See ConnectorProfileConfigTypeDef
  3. See UpdateConnectorProfileResponseTypeDef
Usage example with kwargs
kwargs: UpdateConnectorProfileRequestRequestTypeDef = {  # (1)
    "connectorProfileName": ...,
    "connectionMode": ...,
    "connectorProfileConfig": ...,
}

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

update_flow

Updates an existing flow.

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

Method definition
def update_flow(
    self,
    *,
    flowName: str,
    triggerConfig: TriggerConfigTypeDef,  # (1)
    sourceFlowConfig: SourceFlowConfigTypeDef,  # (2)
    destinationFlowConfigList: Sequence[DestinationFlowConfigTypeDef],  # (3)
    tasks: Sequence[TaskTypeDef],  # (4)
    description: str = ...,
) -> UpdateFlowResponseTypeDef:  # (5)
    ...
  1. See TriggerConfigTypeDef
  2. See SourceFlowConfigTypeDef
  3. See DestinationFlowConfigTypeDef
  4. See TaskTypeDef
  5. See UpdateFlowResponseTypeDef
Usage example with kwargs
kwargs: UpdateFlowRequestRequestTypeDef = {  # (1)
    "flowName": ...,
    "triggerConfig": ...,
    "sourceFlowConfig": ...,
    "destinationFlowConfigList": ...,
    "tasks": ...,
}

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