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
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.
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)
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
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("appflow").close
method.
boto3 documentation
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
def create_connector_profile(
self,
*,
connectorProfileName: str,
connectorType: ConnectorTypeType, # (1)
connectionMode: ConnectionModeType, # (2)
connectorProfileConfig: ConnectorProfileConfigTypeDef, # (3)
kmsArn: str = ...,
connectorLabel: str = ...,
) -> CreateConnectorProfileResponseTypeDef: # (4)
...
- See ConnectorTypeType
- See ConnectionModeType
- See ConnectorProfileConfigTypeDef
- See CreateConnectorProfileResponseTypeDef
kwargs: CreateConnectorProfileRequestRequestTypeDef = { # (1)
"connectorProfileName": ...,
"connectorType": ...,
"connectionMode": ...,
"connectorProfileConfig": ...,
}
parent.create_connector_profile(**kwargs)
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
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] = ...,
metadataCatalogConfig: MetadataCatalogConfigTypeDef = ..., # (5)
) -> CreateFlowResponseTypeDef: # (6)
...
- See TriggerConfigTypeDef
- See SourceFlowConfigTypeDef
- See DestinationFlowConfigTypeDef
- See TaskTypeDef
- See MetadataCatalogConfigTypeDef
- See CreateFlowResponseTypeDef
kwargs: CreateFlowRequestRequestTypeDef = { # (1)
"flowName": ...,
"triggerConfig": ...,
"sourceFlowConfig": ...,
"destinationFlowConfigList": ...,
"tasks": ...,
}
parent.create_flow(**kwargs)
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
def delete_connector_profile(
self,
*,
connectorProfileName: str,
forceDelete: bool = ...,
) -> Dict[str, Any]:
...
kwargs: DeleteConnectorProfileRequestRequestTypeDef = { # (1)
"connectorProfileName": ...,
}
parent.delete_connector_profile(**kwargs)
delete_flow
Enables your application to delete an existing flow.
Type annotations and code completion for boto3.client("appflow").delete_flow
method.
boto3 documentation
def delete_flow(
self,
*,
flowName: str,
forceDelete: bool = ...,
) -> Dict[str, Any]:
...
kwargs: DeleteFlowRequestRequestTypeDef = { # (1)
"flowName": ...,
}
parent.delete_flow(**kwargs)
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
def describe_connector(
self,
*,
connectorType: ConnectorTypeType, # (1)
connectorLabel: str = ...,
) -> DescribeConnectorResponseTypeDef: # (2)
...
kwargs: DescribeConnectorRequestRequestTypeDef = { # (1)
"connectorType": ...,
}
parent.describe_connector(**kwargs)
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
def describe_connector_entity(
self,
*,
connectorEntityName: str,
connectorType: ConnectorTypeType = ..., # (1)
connectorProfileName: str = ...,
apiVersion: str = ...,
) -> DescribeConnectorEntityResponseTypeDef: # (2)
...
kwargs: DescribeConnectorEntityRequestRequestTypeDef = { # (1)
"connectorEntityName": ...,
}
parent.describe_connector_entity(**kwargs)
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
def describe_connector_profiles(
self,
*,
connectorProfileNames: Sequence[str] = ...,
connectorType: ConnectorTypeType = ..., # (1)
connectorLabel: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> DescribeConnectorProfilesResponseTypeDef: # (2)
...
kwargs: DescribeConnectorProfilesRequestRequestTypeDef = { # (1)
"connectorProfileNames": ...,
}
parent.describe_connector_profiles(**kwargs)
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
def describe_connectors(
self,
*,
connectorTypes: Sequence[ConnectorTypeType] = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> DescribeConnectorsResponseTypeDef: # (2)
...
kwargs: DescribeConnectorsRequestRequestTypeDef = { # (1)
"connectorTypes": ...,
}
parent.describe_connectors(**kwargs)
describe_flow
Provides a description of the specified flow.
Type annotations and code completion for boto3.client("appflow").describe_flow
method.
boto3 documentation
def describe_flow(
self,
*,
flowName: str,
) -> DescribeFlowResponseTypeDef: # (1)
...
kwargs: DescribeFlowRequestRequestTypeDef = { # (1)
"flowName": ...,
}
parent.describe_flow(**kwargs)
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
def describe_flow_execution_records(
self,
*,
flowName: str,
maxResults: int = ...,
nextToken: str = ...,
) -> DescribeFlowExecutionRecordsResponseTypeDef: # (1)
...
kwargs: DescribeFlowExecutionRecordsRequestRequestTypeDef = { # (1)
"flowName": ...,
}
parent.describe_flow_execution_records(**kwargs)
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
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
def list_connector_entities(
self,
*,
connectorProfileName: str = ...,
connectorType: ConnectorTypeType = ..., # (1)
entitiesPath: str = ...,
apiVersion: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListConnectorEntitiesResponseTypeDef: # (2)
...
kwargs: ListConnectorEntitiesRequestRequestTypeDef = { # (1)
"connectorProfileName": ...,
}
parent.list_connector_entities(**kwargs)
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
def list_connectors(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListConnectorsResponseTypeDef: # (1)
...
kwargs: ListConnectorsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_connectors(**kwargs)
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
def list_flows(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListFlowsResponseTypeDef: # (1)
...
kwargs: ListFlowsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_flows(**kwargs)
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
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
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
def register_connector(
self,
*,
connectorLabel: str = ...,
description: str = ...,
connectorProvisioningType: ConnectorProvisioningTypeType = ..., # (1)
connectorProvisioningConfig: ConnectorProvisioningConfigTypeDef = ..., # (2)
) -> RegisterConnectorResponseTypeDef: # (3)
...
- See ConnectorProvisioningTypeType
- See ConnectorProvisioningConfigTypeDef
- See RegisterConnectorResponseTypeDef
kwargs: RegisterConnectorRequestRequestTypeDef = { # (1)
"connectorLabel": ...,
}
parent.register_connector(**kwargs)
start_flow
Activates an existing flow.
Type annotations and code completion for boto3.client("appflow").start_flow
method.
boto3 documentation
kwargs: StartFlowRequestRequestTypeDef = { # (1)
"flowName": ...,
}
parent.start_flow(**kwargs)
stop_flow
Deactivates the existing flow.
Type annotations and code completion for boto3.client("appflow").stop_flow
method.
boto3 documentation
kwargs: StopFlowRequestRequestTypeDef = { # (1)
"flowName": ...,
}
parent.stop_flow(**kwargs)
tag_resource
Applies a tag to the specified flow.
Type annotations and code completion for boto3.client("appflow").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
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
def unregister_connector(
self,
*,
connectorLabel: str,
forceDelete: bool = ...,
) -> Dict[str, Any]:
...
kwargs: UnregisterConnectorRequestRequestTypeDef = { # (1)
"connectorLabel": ...,
}
parent.unregister_connector(**kwargs)
untag_resource
Removes a tag from the specified flow.
Type annotations and code completion for boto3.client("appflow").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
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
def update_connector_profile(
self,
*,
connectorProfileName: str,
connectionMode: ConnectionModeType, # (1)
connectorProfileConfig: ConnectorProfileConfigTypeDef, # (2)
) -> UpdateConnectorProfileResponseTypeDef: # (3)
...
kwargs: UpdateConnectorProfileRequestRequestTypeDef = { # (1)
"connectorProfileName": ...,
"connectionMode": ...,
"connectorProfileConfig": ...,
}
parent.update_connector_profile(**kwargs)
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
def update_connector_registration(
self,
*,
connectorLabel: str,
description: str = ...,
connectorProvisioningConfig: ConnectorProvisioningConfigTypeDef = ..., # (1)
) -> UpdateConnectorRegistrationResponseTypeDef: # (2)
...
kwargs: UpdateConnectorRegistrationRequestRequestTypeDef = { # (1)
"connectorLabel": ...,
}
parent.update_connector_registration(**kwargs)
update_flow
Updates an existing flow.
Type annotations and code completion for boto3.client("appflow").update_flow
method.
boto3 documentation
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)
) -> UpdateFlowResponseTypeDef: # (6)
...