Struct aws_sdk_appflow::client::Client

pub struct Client { /* private fields */ }

Client for Amazon Appflow

Client for invoking operations on Amazon Appflow. Each operation on Amazon Appflow is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_appflow::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_appflow::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CancelFlowExecutions operation has a Client::cancel_flow_executions, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.cancel_flow_executions()
    .flow_name("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn cancel_flow_executions(&self) -> CancelFlowExecutionsFluentBuilder

Constructs a fluent builder for the CancelFlowExecutions operation.

• The fluent builder is configurable:
  • flow_name(impl Into<String>) / set_flow_name(Option<String>):
    required: true
    

    The name of a flow with active runs that you want to cancel.

    
    
  • execution_ids(impl Into<String>) / set_execution_ids(Option<Vec::<String>>):
    required: false
    

    The ID of each active run to cancel. These runs must belong to the flow you specify in your request.

    If you omit this parameter, your request ends all active runs that belong to the flow.

    
    
• On success, responds with CancelFlowExecutionsOutput with field(s):
  • invalid_executions(Option<Vec::<String>>):

    The IDs of runs that Amazon AppFlow couldn’t cancel. These runs might be ineligible for canceling because they haven’t started yet or have already completed.

• On failure, responds with SdkError<CancelFlowExecutionsError>

impl Client

pub fn create_connector_profile(&self) -> CreateConnectorProfileFluentBuilder

Constructs a fluent builder for the CreateConnectorProfile operation.

• The fluent builder is configurable:
  • connector_profile_name(impl Into<String>) / set_connector_profile_name(Option<String>):
    required: true
    

    The name of the connector profile. The name is unique for each ConnectorProfile in your Amazon Web Services account.

    
    
  • kms_arn(impl Into<String>) / set_kms_arn(Option<String>):
    required: false
    

    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.

    
    
  • connector_type(ConnectorType) / set_connector_type(Option<ConnectorType>):
    required: true
    

    The type of connector, such as Salesforce, Amplitude, and so on.

    
    
  • connector_label(impl Into<String>) / set_connector_label(Option<String>):
    required: false
    

    The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.

    
    
  • connection_mode(ConnectionMode) / set_connection_mode(Option<ConnectionMode>):
    required: true
    

    Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the public internet.

    
    
  • connector_profile_config(ConnectorProfileConfig) / set_connector_profile_config(Option<ConnectorProfileConfig>):
    required: true
    

    Defines the connector-specific configuration and credentials.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The clientToken parameter is an idempotency token. It ensures that your CreateConnectorProfile request completes only once. You choose the value to pass. For example, if you don’t receive a response from your request, you can safely retry the request with the same clientToken parameter value.

    If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

    If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to CreateConnectorProfile. The token is active for 8 hours.

    
    
• On success, responds with CreateConnectorProfileOutput with field(s):
  • connector_profile_arn(Option<String>):

    The Amazon Resource Name (ARN) of the connector profile.

• On failure, responds with SdkError<CreateConnectorProfileError>

impl Client

pub fn create_flow(&self) -> CreateFlowFluentBuilder

Constructs a fluent builder for the CreateFlow operation.

• The fluent builder is configurable:
  • flow_name(impl Into<String>) / set_flow_name(Option<String>):
    required: true
    

    The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the flow you want to create.

    
    
  • kms_arn(impl Into<String>) / set_kms_arn(Option<String>):
    required: false
    

    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.

    
    
  • trigger_config(TriggerConfig) / set_trigger_config(Option<TriggerConfig>):
    required: true
    

    The trigger settings that determine how and when the flow runs.

    
    
  • source_flow_config(SourceFlowConfig) / set_source_flow_config(Option<SourceFlowConfig>):
    required: true
    

    The configuration that controls how Amazon AppFlow retrieves data from the source connector.

    
    
  • destination_flow_config_list(DestinationFlowConfig) / set_destination_flow_config_list(Option<Vec::<DestinationFlowConfig>>):
    required: true
    

    The configuration that controls how Amazon AppFlow places data in the destination connector.

    
    
  • tasks(Task) / set_tasks(Option<Vec::<Task>>):
    required: true
    

    A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags used to organize, track, or control access for your flow.

    
    
  • metadata_catalog_config(MetadataCatalogConfig) / set_metadata_catalog_config(Option<MetadataCatalogConfig>):
    required: false
    

    Specifies the configuration that Amazon AppFlow uses when it catalogs the data that’s transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The clientToken parameter is an idempotency token. It ensures that your CreateFlow request completes only once. You choose the value to pass. For example, if you don’t receive a response from your request, you can safely retry the request with the same clientToken parameter value.

    If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

    If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to CreateFlow. The token is active for 8 hours.

    
    
• On success, responds with CreateFlowOutput with field(s):
  • flow_arn(Option<String>):

    The flow’s Amazon Resource Name (ARN).

  • flow_status(Option<FlowStatus>):

    Indicates the current status of the flow.

• On failure, responds with SdkError<CreateFlowError>

impl Client

pub fn delete_connector_profile(&self) -> DeleteConnectorProfileFluentBuilder

Constructs a fluent builder for the DeleteConnectorProfile operation.

• The fluent builder is configurable:
  • connector_profile_name(impl Into<String>) / set_connector_profile_name(Option<String>):
    required: true
    

    The name of the connector profile. The name is unique for each ConnectorProfile in your account.

    
    
  • force_delete(bool) / set_force_delete(Option<bool>):
    required: false
    

    Indicates whether Amazon AppFlow should delete the profile, even if it is currently in use in one or more flows.

    
    
• On success, responds with DeleteConnectorProfileOutput
• On failure, responds with SdkError<DeleteConnectorProfileError>

impl Client

pub fn delete_flow(&self) -> DeleteFlowFluentBuilder

Constructs a fluent builder for the DeleteFlow operation.

• The fluent builder is configurable:
  • flow_name(impl Into<String>) / set_flow_name(Option<String>):
    required: true
    

    The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

    
    
  • force_delete(bool) / set_force_delete(Option<bool>):
    required: false
    

    Indicates whether Amazon AppFlow should delete the flow, even if it is currently in use.

    
    
• On success, responds with DeleteFlowOutput
• On failure, responds with SdkError<DeleteFlowError>

impl Client

pub fn describe_connector(&self) -> DescribeConnectorFluentBuilder

Constructs a fluent builder for the DescribeConnector operation.

• The fluent builder is configurable:
  • connector_type(ConnectorType) / set_connector_type(Option<ConnectorType>):
    required: true
    

    The connector type, such as CUSTOMCONNECTOR, Saleforce, Marketo. Please choose CUSTOMCONNECTOR for Lambda based custom connectors.

    
    
  • connector_label(impl Into<String>) / set_connector_label(Option<String>):
    required: false
    

    The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.

    
    
• On success, responds with DescribeConnectorOutput with field(s):
  • connector_configuration(Option<ConnectorConfiguration>):

    Configuration info of all the connectors that the user requested.

• On failure, responds with SdkError<DescribeConnectorError>

impl Client

pub fn describe_connector_entity(&self) -> DescribeConnectorEntityFluentBuilder

Constructs a fluent builder for the DescribeConnectorEntity operation.

• The fluent builder is configurable:
  • connector_entity_name(impl Into<String>) / set_connector_entity_name(Option<String>):
    required: true
    

    The entity name for that connector.

    
    
  • connector_type(ConnectorType) / set_connector_type(Option<ConnectorType>):
    required: false
    

    The type of connector application, such as Salesforce, Amplitude, and so on.

    
    
  • connector_profile_name(impl Into<String>) / set_connector_profile_name(Option<String>):
    required: false
    

    The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account.

    
    
  • api_version(impl Into<String>) / set_api_version(Option<String>):
    required: false
    

    The version of the API that’s used by the connector.

    
    
• On success, responds with DescribeConnectorEntityOutput with field(s):
  • connector_entity_fields(Vec::<ConnectorEntityField>):

    Describes the fields for that connector entity. For example, for an account entity, the fields would be account name, account ID, and so on.

• On failure, responds with SdkError<DescribeConnectorEntityError>

impl Client

pub fn describe_connector_profiles( &self ) -> DescribeConnectorProfilesFluentBuilder

Constructs a fluent builder for the DescribeConnectorProfiles operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • connector_profile_names(impl Into<String>) / set_connector_profile_names(Option<Vec::<String>>):
    required: false
    

    The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account.

    
    
  • connector_type(ConnectorType) / set_connector_type(Option<ConnectorType>):
    required: false
    

    The type of connector, such as Salesforce, Amplitude, and so on.

    
    
  • connector_label(impl Into<String>) / set_connector_label(Option<String>):
    required: false
    

    The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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).

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token for the next page of data.

    
    
• On success, responds with DescribeConnectorProfilesOutput with field(s):
  • connector_profile_details(Option<Vec::<ConnectorProfile>>):

    Returns information about the connector profiles associated with the flow.

  • next_token(Option<String>):

    The pagination token for the next page of data. If nextToken=null, this means that all records have been fetched.

• On failure, responds with SdkError<DescribeConnectorProfilesError>

impl Client

pub fn describe_connectors(&self) -> DescribeConnectorsFluentBuilder

Constructs a fluent builder for the DescribeConnectors operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • connector_types(ConnectorType) / set_connector_types(Option<Vec::<ConnectorType>>):
    required: false
    

    The type of connector, such as Salesforce, Amplitude, and so on.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items that should be returned in the result set. The default is 20.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token for the next page of data.

    
    
• On success, responds with DescribeConnectorsOutput with field(s):
  • connector_configurations(Option<HashMap::<ConnectorType, ConnectorConfiguration>>):

    The configuration that is applied to the connectors used in the flow.

  • connectors(Option<Vec::<ConnectorDetail>>):

    Information about the connectors supported in Amazon AppFlow.

  • next_token(Option<String>):

    The pagination token for the next page of data.

• On failure, responds with SdkError<DescribeConnectorsError>

impl Client

pub fn describe_flow(&self) -> DescribeFlowFluentBuilder

Constructs a fluent builder for the DescribeFlow operation.

• The fluent builder is configurable:
  • flow_name(impl Into<String>) / set_flow_name(Option<String>):
    required: true
    

    The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

    
    
• On success, responds with DescribeFlowOutput with field(s):
  • flow_arn(Option<String>):

    The flow’s Amazon Resource Name (ARN).

  • description(Option<String>):

    A description of the flow.

  • flow_name(Option<String>):

    The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

  • kms_arn(Option<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.

  • flow_status(Option<FlowStatus>):

    Indicates the current status of the flow.

  • flow_status_message(Option<String>):

    Contains an error message if the flow status is in a suspended or error state. This applies only to scheduled or event-triggered flows.

  • source_flow_config(Option<SourceFlowConfig>):

    The configuration that controls how Amazon AppFlow retrieves data from the source connector.

  • destination_flow_config_list(Option<Vec::<DestinationFlowConfig>>):

    The configuration that controls how Amazon AppFlow transfers data to the destination connector.

  • last_run_execution_details(Option<ExecutionDetails>):

    Describes the details of the most recent flow run.

  • trigger_config(Option<TriggerConfig>):

    The trigger settings that determine how and when the flow runs.

  • tasks(Option<Vec::<Task>>):

    A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

  • created_at(Option<DateTime>):

    Specifies when the flow was created.

  • last_updated_at(Option<DateTime>):

    Specifies when the flow was last updated.

  • created_by(Option<String>):

    The ARN of the user who created the flow.

  • last_updated_by(Option<String>):

    Specifies the user name of the account that performed the most recent update.

  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for your flow.

  • metadata_catalog_config(Option<MetadataCatalogConfig>):

    Specifies the configuration that Amazon AppFlow uses when it catalogs the data that’s transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.

  • last_run_metadata_catalog_details(Option<Vec::<MetadataCatalogDetail>>):

    Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.

  • schema_version(Option<i64>):

    The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:

    • Source-to-destination field mappings

    • Field data types

    • Partition keys

• On failure, responds with SdkError<DescribeFlowError>

impl Client

pub fn describe_flow_execution_records( &self ) -> DescribeFlowExecutionRecordsFluentBuilder

Constructs a fluent builder for the DescribeFlowExecutionRecords operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • flow_name(impl Into<String>) / set_flow_name(Option<String>):
    required: true
    

    The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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).

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token for the next page of data.

    
    
• On success, responds with DescribeFlowExecutionRecordsOutput with field(s):
  • flow_executions(Option<Vec::<ExecutionRecord>>):

    Returns a list of all instances when this flow was run.

  • next_token(Option<String>):

    The pagination token for the next page of data.

• On failure, responds with SdkError<DescribeFlowExecutionRecordsError>

impl Client

pub fn list_connector_entities(&self) -> ListConnectorEntitiesFluentBuilder

Constructs a fluent builder for the ListConnectorEntities operation.

• The fluent builder is configurable:
  • connector_profile_name(impl Into<String>) / set_connector_profile_name(Option<String>):
    required: false
    

    The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account, and is used to query the downstream connector.

    
    
  • connector_type(ConnectorType) / set_connector_type(Option<ConnectorType>):
    required: false
    

    The type of connector, such as Salesforce, Amplitude, and so on.

    
    
  • entities_path(impl Into<String>) / set_entities_path(Option<String>):
    required: false
    

    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.

    
    
  • api_version(impl Into<String>) / set_api_version(Option<String>):
    required: false
    

    The version of the API that’s used by the connector.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of items that the operation returns in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token that was provided by your prior ListConnectorEntities operation if the response was too big for the page size. You specify this token to get the next page of results in paginated response.

    
    
• On success, responds with ListConnectorEntitiesOutput with field(s):
  • connector_entity_map(HashMap::<String, Vec::<ConnectorEntity>>):

    The response of ListConnectorEntities lists entities grouped by category. This map’s key represents the group name, and its value contains the list of entities belonging to that group.

  • next_token(Option<String>):

    A token that you specify in your next ListConnectorEntities operation to get the next page of results in paginated response. The ListConnectorEntities operation provides this token if the response is too big for the page size.

• On failure, responds with SdkError<ListConnectorEntitiesError>

impl Client

pub fn list_connectors(&self) -> ListConnectorsFluentBuilder

Constructs a fluent builder for the ListConnectors operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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).

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token for the next page of data.

    
    
• On success, responds with ListConnectorsOutput with field(s):
  • connectors(Option<Vec::<ConnectorDetail>>):

    Contains information about the connectors supported by Amazon AppFlow.

  • next_token(Option<String>):

    The pagination token for the next page of data. If nextToken=null, this means that all records have been fetched.

• On failure, responds with SdkError<ListConnectorsError>

impl Client

pub fn list_flows(&self) -> ListFlowsFluentBuilder

Constructs a fluent builder for the ListFlows operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Specifies the maximum number of items that should be returned in the result set.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The pagination token for next page of data.

    
    
• On success, responds with ListFlowsOutput with field(s):
  • flows(Option<Vec::<FlowDefinition>>):

    The list of flows associated with your account.

  • next_token(Option<String>):

    The pagination token for next page of data.

• On failure, responds with SdkError<ListFlowsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the specified flow.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    The tags used to organize, track, or control access for your flow.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn register_connector(&self) -> RegisterConnectorFluentBuilder

Constructs a fluent builder for the RegisterConnector operation.

• The fluent builder is configurable:
  • connector_label(impl Into<String>) / set_connector_label(Option<String>):
    required: false
    

    The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web Services account.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description about the connector that’s being registered.

    
    
  • connector_provisioning_type(ConnectorProvisioningType) / set_connector_provisioning_type(Option<ConnectorProvisioningType>):
    required: false
    

    The provisioning type of the connector. Currently the only supported value is LAMBDA.

    
    
  • connector_provisioning_config(ConnectorProvisioningConfig) / set_connector_provisioning_config(Option<ConnectorProvisioningConfig>):
    required: false
    

    The provisioning type of the connector. Currently the only supported value is LAMBDA.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The clientToken parameter is an idempotency token. It ensures that your RegisterConnector request completes only once. You choose the value to pass. For example, if you don’t receive a response from your request, you can safely retry the request with the same clientToken parameter value.

    If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

    If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to RegisterConnector. The token is active for 8 hours.

    
    
• On success, responds with RegisterConnectorOutput with field(s):
  • connector_arn(Option<String>):

    The ARN of the connector being registered.

• On failure, responds with SdkError<RegisterConnectorError>

impl Client

pub fn reset_connector_metadata_cache( &self ) -> ResetConnectorMetadataCacheFluentBuilder

Constructs a fluent builder for the ResetConnectorMetadataCache operation.

• The fluent builder is configurable:
  • connector_profile_name(impl Into<String>) / set_connector_profile_name(Option<String>):
    required: false
    

    The name of the connector profile that you want to reset cached metadata for.

    You can omit this parameter if you’re resetting the cache for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you’re resetting the cache for any other connector, you must include this parameter in your request.

    
    
  • connector_type(ConnectorType) / set_connector_type(Option<ConnectorType>):
    required: false
    

    The type of connector to reset cached metadata for.

    You must include this parameter in your request if you’re resetting the cache for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you’re resetting the cache for any other connector, you can omit this parameter from your request.

    
    
  • connector_entity_name(impl Into<String>) / set_connector_entity_name(Option<String>):
    required: false
    

    Use this parameter if you want to reset cached metadata about the details for an individual entity.

    If you don’t include this parameter in your request, Amazon AppFlow only resets cached metadata about entity names, not entity details.

    
    
  • entities_path(impl Into<String>) / set_entities_path(Option<String>):
    required: false
    

    Use this parameter only if you’re resetting the cached metadata about a nested entity. Only some connectors support nested entities. A nested entity is one that has another entity as a parent. To use this parameter, specify the name of the parent entity.

    To look up the parent-child relationship of entities, you can send a ListConnectorEntities request that omits the entitiesPath parameter. Amazon AppFlow will return a list of top-level entities. For each one, it indicates whether the entity has nested entities. Then, in a subsequent ListConnectorEntities request, you can specify a parent entity name for the entitiesPath parameter. Amazon AppFlow will return a list of the child entities for that parent.

    
    
  • api_version(impl Into<String>) / set_api_version(Option<String>):
    required: false
    

    The API version that you specified in the connector profile that you’re resetting cached metadata for. You must use this parameter only if the connector supports multiple API versions or if the connector type is CustomConnector.

    To look up how many versions a connector supports, use the DescribeConnectors action. In the response, find the value that Amazon AppFlow returns for the connectorVersion parameter.

    To look up the connector type, use the DescribeConnectorProfiles action. In the response, find the value that Amazon AppFlow returns for the connectorType parameter.

    To look up the API version that you specified in a connector profile, use the DescribeConnectorProfiles action.

    
    
• On success, responds with ResetConnectorMetadataCacheOutput
• On failure, responds with SdkError<ResetConnectorMetadataCacheError>

impl Client

pub fn start_flow(&self) -> StartFlowFluentBuilder

Constructs a fluent builder for the StartFlow operation.

• The fluent builder is configurable:
  • flow_name(impl Into<String>) / set_flow_name(Option<String>):
    required: true
    

    The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The clientToken parameter is an idempotency token. It ensures that your StartFlow request completes only once. You choose the value to pass. For example, if you don’t receive a response from your request, you can safely retry the request with the same clientToken parameter value.

    If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

    If you specify input parameters that differ from your first request, an error occurs for flows that run on a schedule or based on an event. However, the error doesn’t occur for flows that run on demand. You set the conditions that initiate your flow for the triggerConfig parameter.

    If you use a different value for clientToken, Amazon AppFlow considers it a new call to StartFlow. The token is active for 8 hours.

    
    
• On success, responds with StartFlowOutput with field(s):
  • flow_arn(Option<String>):

    The flow’s Amazon Resource Name (ARN).

  • flow_status(Option<FlowStatus>):

    Indicates the current status of the flow.

  • execution_id(Option<String>):

    Returns the internal execution ID of an on-demand flow when the flow is started. For scheduled or event-triggered flows, this value is null.

• On failure, responds with SdkError<StartFlowError>

impl Client

pub fn stop_flow(&self) -> StopFlowFluentBuilder

Constructs a fluent builder for the StopFlow operation.

• The fluent builder is configurable:
  • flow_name(impl Into<String>) / set_flow_name(Option<String>):
    required: true
    

    The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

    
    
• On success, responds with StopFlowOutput with field(s):
  • flow_arn(Option<String>):

    The flow’s Amazon Resource Name (ARN).

  • flow_status(Option<FlowStatus>):

    Indicates the current status of the flow.

• On failure, responds with SdkError<StopFlowError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the flow that you want to tag.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The tags used to organize, track, or control access for your flow.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn unregister_connector(&self) -> UnregisterConnectorFluentBuilder

Constructs a fluent builder for the UnregisterConnector operation.

• The fluent builder is configurable:
  • connector_label(impl Into<String>) / set_connector_label(Option<String>):
    required: true
    

    The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web Services account.

    
    
  • force_delete(bool) / set_force_delete(Option<bool>):
    required: false
    

    Indicates whether Amazon AppFlow should unregister the connector, even if it is currently in use in one or more connector profiles. The default value is false.

    
    
• On success, responds with UnregisterConnectorOutput
• On failure, responds with SdkError<UnregisterConnectorError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the flow that you want to untag.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The tag keys associated with the tag that you want to remove from your flow.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_connector_profile(&self) -> UpdateConnectorProfileFluentBuilder

Constructs a fluent builder for the UpdateConnectorProfile operation.

• The fluent builder is configurable:
  • connector_profile_name(impl Into<String>) / set_connector_profile_name(Option<String>):
    required: true
    

    The name of the connector profile and is unique for each ConnectorProfile in the Amazon Web Services account.

    
    
  • connection_mode(ConnectionMode) / set_connection_mode(Option<ConnectionMode>):
    required: true
    

    Indicates the connection mode and if it is public or private.

    
    
  • connector_profile_config(ConnectorProfileConfig) / set_connector_profile_config(Option<ConnectorProfileConfig>):
    required: true
    

    Defines the connector-specific profile configuration and credentials.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The clientToken parameter is an idempotency token. It ensures that your UpdateConnectorProfile request completes only once. You choose the value to pass. For example, if you don’t receive a response from your request, you can safely retry the request with the same clientToken parameter value.

    If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

    If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to UpdateConnectorProfile. The token is active for 8 hours.

    
    
• On success, responds with UpdateConnectorProfileOutput with field(s):
  • connector_profile_arn(Option<String>):

    The Amazon Resource Name (ARN) of the connector profile.

• On failure, responds with SdkError<UpdateConnectorProfileError>

impl Client

pub fn update_connector_registration( &self ) -> UpdateConnectorRegistrationFluentBuilder

Constructs a fluent builder for the UpdateConnectorRegistration operation.

• The fluent builder is configurable:
  • connector_label(impl Into<String>) / set_connector_label(Option<String>):
    required: true
    

    The name of the connector. The name is unique for each connector registration in your AWS account.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description about the update that you’re applying to the connector.

    
    
  • connector_provisioning_config(ConnectorProvisioningConfig) / set_connector_provisioning_config(Option<ConnectorProvisioningConfig>):
    required: false
    

    Contains information about the configuration of the connector being registered.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The clientToken parameter is an idempotency token. It ensures that your UpdateConnectorRegistration request completes only once. You choose the value to pass. For example, if you don’t receive a response from your request, you can safely retry the request with the same clientToken parameter value.

    If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

    If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to UpdateConnectorRegistration. The token is active for 8 hours.

    
    
• On success, responds with UpdateConnectorRegistrationOutput with field(s):
  • connector_arn(Option<String>):

    The ARN of the connector being updated.

• On failure, responds with SdkError<UpdateConnectorRegistrationError>

impl Client

pub fn update_flow(&self) -> UpdateFlowFluentBuilder

Constructs a fluent builder for the UpdateFlow operation.

• The fluent builder is configurable:
  • flow_name(impl Into<String>) / set_flow_name(Option<String>):
    required: true
    

    The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the flow.

    
    
  • trigger_config(TriggerConfig) / set_trigger_config(Option<TriggerConfig>):
    required: true
    

    The trigger settings that determine how and when the flow runs.

    
    
  • source_flow_config(SourceFlowConfig) / set_source_flow_config(Option<SourceFlowConfig>):
    required: true
    

    Contains information about the configuration of the source connector used in the flow.

    
    
  • destination_flow_config_list(DestinationFlowConfig) / set_destination_flow_config_list(Option<Vec::<DestinationFlowConfig>>):
    required: true
    

    The configuration that controls how Amazon AppFlow transfers data to the destination connector.

    
    
  • tasks(Task) / set_tasks(Option<Vec::<Task>>):
    required: true
    

    A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

    
    
  • metadata_catalog_config(MetadataCatalogConfig) / set_metadata_catalog_config(Option<MetadataCatalogConfig>):
    required: false
    

    Specifies the configuration that Amazon AppFlow uses when it catalogs the data that’s transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The clientToken parameter is an idempotency token. It ensures that your UpdateFlow request completes only once. You choose the value to pass. For example, if you don’t receive a response from your request, you can safely retry the request with the same clientToken parameter value.

    If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

    If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to UpdateFlow. The token is active for 8 hours.

    
    
• On success, responds with UpdateFlowOutput with field(s):
  • flow_status(Option<FlowStatus>):

    Indicates the current status of the flow.

• On failure, responds with SdkError<UpdateFlowError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.