Struct aws_sdk_appflow::client::Client

source · [−]

pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Expand description

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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_appflow::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_appflow::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_appflow::Client::from_conf(config);

Implementations

source

impl<C, M, R> Client<C, M, R>

source

pub fn with_config(client: Client<C, M, R>, conf: Config) -> Self

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source

impl<C, M, R> Client<C, M, R> where
 C: SmithyConnector,
 M: SmithyMiddleware<C>,
 R: NewRequestPolicy,

source

pub fn create_connector_profile(&self) -> CreateConnectorProfile<C, M, R>

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>):
 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>):
 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>):
 The type of connector, such as Salesforce, Amplitude, and so on.
- connection_mode(ConnectionMode) / set_connection_mode(Option<ConnectionMode>):
 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>):
 Defines the connector-specific configuration and credentials.
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>

source

pub fn create_flow(&self) -> CreateFlow<C, M, R>

Constructs a fluent builder for the CreateFlow operation.

The fluent builder is configurable:
- flow_name(impl Into<String>) / set_flow_name(Option<String>):
 The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
- description(impl Into<String>) / set_description(Option<String>):
 A description of the flow you want to create.
- kms_arn(impl Into<String>) / set_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.
- trigger_config(TriggerConfig) / set_trigger_config(Option<TriggerConfig>):
 The trigger settings that determine how and when the flow runs.
- source_flow_config(SourceFlowConfig) / set_source_flow_config(Option<SourceFlowConfig>):
 The configuration that controls how Amazon AppFlow retrieves data from the source connector.
- destination_flow_config_list(Vec<DestinationFlowConfig>) / set_destination_flow_config_list(Option<Vec<DestinationFlowConfig>>):
 The configuration that controls how Amazon AppFlow places data in the destination connector.
- tasks(Vec<Task>) / set_tasks(Option<Vec<Task>>):
 A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
- tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
 The tags used to organize, track, or control access for your flow.
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>

source

pub fn delete_connector_profile(&self) -> DeleteConnectorProfile<C, M, R>

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>):
 The name of the connector profile. The name is unique for each ConnectorProfile in your account.
- force_delete(bool) / set_force_delete(bool):
 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>

source

pub fn delete_flow(&self) -> DeleteFlow<C, M, R>

Constructs a fluent builder for the DeleteFlow operation.

The fluent builder is configurable:
- flow_name(impl Into<String>) / set_flow_name(Option<String>):
 The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
- force_delete(bool) / set_force_delete(bool):
 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>

source

pub fn describe_connector_entity(&self) -> DescribeConnectorEntity<C, M, R>

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>):
 The entity name for that connector.
- connector_type(ConnectorType) / set_connector_type(Option<ConnectorType>):
 The type of connector application, such as Salesforce, Amplitude, and so on.
- connector_profile_name(impl Into<String>) / set_connector_profile_name(Option<String>):
 The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account.
On success, responds with DescribeConnectorEntityOutput with field(s):
- connector_entity_fields(Option<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>

source

pub fn describe_connector_profiles(&self) -> DescribeConnectorProfiles<C, M, R>

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

The fluent builder is configurable:
- connector_profile_names(Vec<String>) / set_connector_profile_names(Option<Vec<String>>):
 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>):
 The type of connector, such as Salesforce, Amplitude, and so on.
- max_results(i32) / set_max_results(Option<i32>):
 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>):
 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>

source

pub fn describe_connectors(&self) -> DescribeConnectors<C, M, R>

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

The fluent builder is configurable:
- connector_types(Vec<ConnectorType>) / set_connector_types(Option<Vec<ConnectorType>>):
 The type of connector, such as Salesforce, Amplitude, and so on.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 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.
- next_token(Option<String>):
 The pagination token for the next page of data.
On failure, responds with SdkError<DescribeConnectorsError>

source

pub fn describe_flow(&self) -> DescribeFlow<C, M, R>

Constructs a fluent builder for the DescribeFlow operation.

The fluent builder is configurable:
- flow_name(impl Into<String>) / set_flow_name(Option<String>):
 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.
On failure, responds with SdkError<DescribeFlowError>

source

pub fn describe_flow_execution_records(
&self
) -> DescribeFlowExecutionRecords<C, M, R>

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>):
 The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
- max_results(i32) / set_max_results(Option<i32>):
 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>):
 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>

source

pub fn list_connector_entities(&self) -> ListConnectorEntities<C, M, R>

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>):
 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>):
 The type of connector, such as Salesforce, Amplitude, and so on.
- entities_path(impl Into<String>) / set_entities_path(Option<String>):
 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.
On success, responds with ListConnectorEntitiesOutput with field(s):
- connector_entity_map(Option<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.
On failure, responds with SdkError<ListConnectorEntitiesError>

source

pub fn list_flows(&self) -> ListFlows<C, M, R>

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>):
 Specifies the maximum number of items that should be returned in the result set.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 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>

source

pub fn list_tags_for_resource(&self) -> ListTagsForResource<C, M, R>

Constructs a fluent builder for the ListTagsForResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 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>

source

pub fn start_flow(&self) -> StartFlow<C, M, R>

Constructs a fluent builder for the StartFlow operation.

The fluent builder is configurable:
- flow_name(impl Into<String>) / set_flow_name(Option<String>):
 The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
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>

source

pub fn stop_flow(&self) -> StopFlow<C, M, R>

Constructs a fluent builder for the StopFlow operation.

The fluent builder is configurable:
- flow_name(impl Into<String>) / set_flow_name(Option<String>):
 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>