Struct aws_sdk_appintegrations::Client

pub struct Client { /* private fields */ }

Client for Amazon AppIntegrations Service

Client for invoking operations on Amazon AppIntegrations Service. Each operation on Amazon AppIntegrations Service 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_appintegrations::Client::new(&config);

Occasionally, SDKs may have additional service-specific 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_appintegrations::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 CreateDataIntegration operation has a Client::create_data_integration, function which returns a builder for that operation. The fluent builder ultimately has a call() function that returns an async future that returns a result, as illustrated below:

let result = client.create_data_integration()
    .name("example")
    .call()
    .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 create_data_integration(&self) -> CreateDataIntegrationFluentBuilder

Constructs a fluent builder for the CreateDataIntegration operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the DataIntegration.

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

    A description of the DataIntegration.

  • kms_key(impl Into<String>) / set_kms_key(Option<String>):

    The KMS key for the DataIntegration.

  • source_uri(impl Into<String>) / set_source_uri(Option<String>):

    The URI of the data source.

  • schedule_config(ScheduleConfiguration) / set_schedule_config(Option<ScheduleConfiguration>):

    The name of the data and how often it should be pulled from the source.

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

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

  • file_configuration(FileConfiguration) / set_file_configuration(Option<FileConfiguration>):

    The configuration for what files should be pulled from the source.

  • object_configuration(HashMap<String, HashMap<String, Vec<String>>>) / set_object_configuration(Option<HashMap<String, HashMap<String, Vec<String>>>>):

    The configuration for what data should be pulled from the source.

• On success, responds with CreateDataIntegrationOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN)

  • id(Option<String>):

    A unique identifier.

  • name(Option<String>):

    The name of the DataIntegration.

  • description(Option<String>):

    A description of the DataIntegration.

  • kms_key(Option<String>):

    The KMS key for the DataIntegration.

  • source_uri(Option<String>):

    The URI of the data source.

  • schedule_configuration(Option<ScheduleConfiguration>):

    The name of the data and how often it should be pulled from the source.

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

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

  • client_token(Option<String>):

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

  • file_configuration(Option<FileConfiguration>):

    The configuration for what files should be pulled from the source.

  • object_configuration(Option<HashMap<String, HashMap<String, Vec<String>>>>):

    The configuration for what data should be pulled from the source.

• On failure, responds with SdkError<CreateDataIntegrationError>

impl Client

pub fn create_event_integration(&self) -> CreateEventIntegrationFluentBuilder

Constructs a fluent builder for the CreateEventIntegration operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the event integration.

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

    The description of the event integration.

  • event_filter(EventFilter) / set_event_filter(Option<EventFilter>):

    The event filter.

  • event_bridge_bus(impl Into<String>) / set_event_bridge_bus(Option<String>):

    The EventBridge bus.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

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

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

• On success, responds with CreateEventIntegrationOutput with field(s):
  • event_integration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the event integration.

• On failure, responds with SdkError<CreateEventIntegrationError>

impl Client

pub fn delete_data_integration(&self) -> DeleteDataIntegrationFluentBuilder

Constructs a fluent builder for the DeleteDataIntegration operation.

• The fluent builder is configurable:
  • data_integration_identifier(impl Into<String>) / set_data_integration_identifier(Option<String>):

    A unique identifier for the DataIntegration.

• On success, responds with DeleteDataIntegrationOutput
• On failure, responds with SdkError<DeleteDataIntegrationError>

impl Client

pub fn delete_event_integration(&self) -> DeleteEventIntegrationFluentBuilder

Constructs a fluent builder for the DeleteEventIntegration operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the event integration.

• On success, responds with DeleteEventIntegrationOutput
• On failure, responds with SdkError<DeleteEventIntegrationError>

impl Client

pub fn get_data_integration(&self) -> GetDataIntegrationFluentBuilder

Constructs a fluent builder for the GetDataIntegration operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):

    A unique identifier.

• On success, responds with GetDataIntegrationOutput with field(s):
  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the DataIntegration.

  • id(Option<String>):

    A unique identifier.

  • name(Option<String>):

    The name of the DataIntegration.

  • description(Option<String>):

    The KMS key for the DataIntegration.

  • kms_key(Option<String>):

    The KMS key for the DataIntegration.

  • source_uri(Option<String>):

    The URI of the data source.

  • schedule_configuration(Option<ScheduleConfiguration>):

    The name of the data and how often it should be pulled from the source.

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

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

  • file_configuration(Option<FileConfiguration>):

    The configuration for what files should be pulled from the source.

  • object_configuration(Option<HashMap<String, HashMap<String, Vec<String>>>>):

    The configuration for what data should be pulled from the source.

• On failure, responds with SdkError<GetDataIntegrationError>

impl Client

pub fn get_event_integration(&self) -> GetEventIntegrationFluentBuilder

Constructs a fluent builder for the GetEventIntegration operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the event integration.

• On success, responds with GetEventIntegrationOutput with field(s):
  • name(Option<String>):

    The name of the event integration.

  • description(Option<String>):

    The description of the event integration.

  • event_integration_arn(Option<String>):

    The Amazon Resource Name (ARN) for the event integration.

  • event_bridge_bus(Option<String>):

    The EventBridge bus.

  • event_filter(Option<EventFilter>):

    The event filter.

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

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

• On failure, responds with SdkError<GetEventIntegrationError>

impl Client

pub fn list_data_integration_associations( &self ) -> ListDataIntegrationAssociationsFluentBuilder

Constructs a fluent builder for the ListDataIntegrationAssociations operation.

• The fluent builder is configurable:
  • data_integration_identifier(impl Into<String>) / set_data_integration_identifier(Option<String>):

    A unique identifier for the DataIntegration.

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

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

    The maximum number of results to return per page.

• On success, responds with ListDataIntegrationAssociationsOutput with field(s):
  • data_integration_associations(Option<Vec<DataIntegrationAssociationSummary>>):

    The Amazon Resource Name (ARN) and unique ID of the DataIntegration association.

  • next_token(Option<String>):

    If there are additional results, this is the token for the next set of results.

• On failure, responds with SdkError<ListDataIntegrationAssociationsError>

impl Client

pub fn list_data_integrations(&self) -> ListDataIntegrationsFluentBuilder

Constructs a fluent builder for the ListDataIntegrations operation.

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

    The maximum number of results to return per page.

• On success, responds with ListDataIntegrationsOutput with field(s):
  • data_integrations(Option<Vec<DataIntegrationSummary>>):

    The DataIntegrations associated with this account.

  • next_token(Option<String>):

    If there are additional results, this is the token for the next set of results.

• On failure, responds with SdkError<ListDataIntegrationsError>

impl Client

pub fn list_event_integration_associations( &self ) -> ListEventIntegrationAssociationsFluentBuilder

Constructs a fluent builder for the ListEventIntegrationAssociations operation.

• The fluent builder is configurable:
  • event_integration_name(impl Into<String>) / set_event_integration_name(Option<String>):

    The name of the event integration.

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

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

    The maximum number of results to return per page.

• On success, responds with ListEventIntegrationAssociationsOutput with field(s):
  • event_integration_associations(Option<Vec<EventIntegrationAssociation>>):

    The event integration associations.

  • next_token(Option<String>):

    If there are additional results, this is the token for the next set of results.

• On failure, responds with SdkError<ListEventIntegrationAssociationsError>

impl Client

pub fn list_event_integrations(&self) -> ListEventIntegrationsFluentBuilder

Constructs a fluent builder for the ListEventIntegrations operation.

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

    The maximum number of results to return per page.

• On success, responds with ListEventIntegrationsOutput with field(s):
  • event_integrations(Option<Vec<EventIntegration>>):

    The event integrations.

  • next_token(Option<String>):

    If there are additional results, this is the token for the next set of results.

• On failure, responds with SdkError<ListEventIntegrationsError>

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

    The Amazon Resource Name (ARN) of the resource.

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

    Information about the tags.

• On failure, responds with SdkError<ListTagsForResourceError>

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

    The Amazon Resource Name (ARN) of the resource.

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

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:“value1”, “key2”:“value2”} }.

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

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

    The Amazon Resource Name (ARN) of the resource.

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    The tag keys.

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

impl Client

pub fn update_data_integration(&self) -> UpdateDataIntegrationFluentBuilder

Constructs a fluent builder for the UpdateDataIntegration operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):

    A unique identifier for the DataIntegration.

  • name(impl Into<String>) / set_name(Option<String>):

    The name of the DataIntegration.

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

    A description of the DataIntegration.

• On success, responds with UpdateDataIntegrationOutput
• On failure, responds with SdkError<UpdateDataIntegrationError>

impl Client

pub fn update_event_integration(&self) -> UpdateEventIntegrationFluentBuilder

Constructs a fluent builder for the UpdateEventIntegration operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the event integration.

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

    The description of the event inegration.

• On success, responds with UpdateEventIntegrationOutput
• On failure, responds with SdkError<UpdateEventIntegrationError>

impl Client

pub fn with_config( client: Client<DynConnector, DynMiddleware<DynConnector>>, conf: Config ) -> Self

Creates a client with the given service configuration.

pub fn conf(&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.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

• This method will panic if the conf 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 conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

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.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.