Struct aws_sdk_transfer::client::Client

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

Client for AWS Transfer Family

Client for invoking operations on AWS Transfer Family. Each operation on AWS Transfer Family 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_transfer::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_transfer::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_transfer::Client::from_conf(config);

Implementations

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

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

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

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

pub fn create_access(&self) -> CreateAccess<C, M, R>

Constructs a fluent builder for the CreateAccess operation.

See CreateAccess for more information about the operation and its arguments.

pub fn create_server(&self) -> CreateServer<C, M, R>

Constructs a fluent builder for the CreateServer operation.

See CreateServer for more information about the operation and its arguments.

pub fn create_user(&self) -> CreateUser<C, M, R>

Constructs a fluent builder for the CreateUser operation.

See CreateUser for more information about the operation and its arguments.

pub fn create_workflow(&self) -> CreateWorkflow<C, M, R>

Constructs a fluent builder for the CreateWorkflow operation.

See CreateWorkflow for more information about the operation and its arguments.

pub fn delete_access(&self) -> DeleteAccess<C, M, R>

Constructs a fluent builder for the DeleteAccess operation.

See DeleteAccess for more information about the operation and its arguments.

pub fn delete_server(&self) -> DeleteServer<C, M, R>

Constructs a fluent builder for the DeleteServer operation.

See DeleteServer for more information about the operation and its arguments.

pub fn delete_ssh_public_key(&self) -> DeleteSshPublicKey<C, M, R>

Constructs a fluent builder for the DeleteSshPublicKey operation.

See DeleteSshPublicKey for more information about the operation and its arguments.

pub fn delete_user(&self) -> DeleteUser<C, M, R>

Constructs a fluent builder for the DeleteUser operation.

See DeleteUser for more information about the operation and its arguments.

pub fn delete_workflow(&self) -> DeleteWorkflow<C, M, R>

Constructs a fluent builder for the DeleteWorkflow operation.

See DeleteWorkflow for more information about the operation and its arguments.

pub fn describe_access(&self) -> DescribeAccess<C, M, R>

Constructs a fluent builder for the DescribeAccess operation.

See DescribeAccess for more information about the operation and its arguments.

pub fn describe_execution(&self) -> DescribeExecution<C, M, R>

Constructs a fluent builder for the DescribeExecution operation.

See DescribeExecution for more information about the operation and its arguments.

pub fn describe_security_policy(&self) -> DescribeSecurityPolicy<C, M, R>

Constructs a fluent builder for the DescribeSecurityPolicy operation.

See DescribeSecurityPolicy for more information about the operation and its arguments.

pub fn describe_server(&self) -> DescribeServer<C, M, R>

Constructs a fluent builder for the DescribeServer operation.

See DescribeServer for more information about the operation and its arguments.

pub fn describe_user(&self) -> DescribeUser<C, M, R>

Constructs a fluent builder for the DescribeUser operation.

See DescribeUser for more information about the operation and its arguments.

pub fn describe_workflow(&self) -> DescribeWorkflow<C, M, R>

Constructs a fluent builder for the DescribeWorkflow operation.

See DescribeWorkflow for more information about the operation and its arguments.

pub fn import_ssh_public_key(&self) -> ImportSshPublicKey<C, M, R>

Constructs a fluent builder for the ImportSshPublicKey operation.

See ImportSshPublicKey for more information about the operation and its arguments.

pub fn list_accesses(&self) -> ListAccesses<C, M, R>

Constructs a fluent builder for the ListAccesses operation.

See ListAccesses for more information about the operation and its arguments. This operation supports pagination. See into_paginator().

pub fn list_executions(&self) -> ListExecutions<C, M, R>

Constructs a fluent builder for the ListExecutions operation.

See ListExecutions for more information about the operation and its arguments. This operation supports pagination. See into_paginator().

pub fn list_security_policies(&self) -> ListSecurityPolicies<C, M, R>

Constructs a fluent builder for the ListSecurityPolicies operation.

See ListSecurityPolicies for more information about the operation and its arguments. This operation supports pagination. See into_paginator().

pub fn list_servers(&self) -> ListServers<C, M, R>

Constructs a fluent builder for the ListServers operation.

See ListServers for more information about the operation and its arguments. This operation supports pagination. See into_paginator().

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

Constructs a fluent builder for the ListTagsForResource operation.

See ListTagsForResource for more information about the operation and its arguments. This operation supports pagination. See into_paginator().

pub fn list_users(&self) -> ListUsers<C, M, R>

Constructs a fluent builder for the ListUsers operation.

See ListUsers for more information about the operation and its arguments. This operation supports pagination. See into_paginator().

pub fn list_workflows(&self) -> ListWorkflows<C, M, R>

Constructs a fluent builder for the ListWorkflows operation.

See ListWorkflows for more information about the operation and its arguments. This operation supports pagination. See into_paginator().

pub fn send_workflow_step_state(&self) -> SendWorkflowStepState<C, M, R>

Constructs a fluent builder for the SendWorkflowStepState operation.

See SendWorkflowStepState for more information about the operation and its arguments.

pub fn start_server(&self) -> StartServer<C, M, R>

Constructs a fluent builder for the StartServer operation.

See StartServer for more information about the operation and its arguments.

pub fn stop_server(&self) -> StopServer<C, M, R>

Constructs a fluent builder for the StopServer operation.

See StopServer for more information about the operation and its arguments.

pub fn tag_resource(&self) -> TagResource<C, M, R>

Constructs a fluent builder for the TagResource operation.

See TagResource for more information about the operation and its arguments.

pub fn test_identity_provider(&self) -> TestIdentityProvider<C, M, R>

Constructs a fluent builder for the TestIdentityProvider operation.

See TestIdentityProvider for more information about the operation and its arguments.

pub fn untag_resource(&self) -> UntagResource<C, M, R>

Constructs a fluent builder for the UntagResource operation.

See UntagResource for more information about the operation and its arguments.

pub fn update_access(&self) -> UpdateAccess<C, M, R>

Constructs a fluent builder for the UpdateAccess operation.

See UpdateAccess for more information about the operation and its arguments.

pub fn update_server(&self) -> UpdateServer<C, M, R>

Constructs a fluent builder for the UpdateServer operation.

See UpdateServer for more information about the operation and its arguments.

pub fn update_user(&self) -> UpdateUser<C, M, R>

Constructs a fluent builder for the UpdateUser operation.

See UpdateUser for more information about the operation and its arguments.

impl<C> Client<C, DefaultMiddleware, Standard>

pub fn from_conf_conn(conf: Config, conn: C) -> Self

Creates a client with the given service config and connector override.

impl Client<DynConnector, DefaultMiddleware, Standard>

pub fn new(config: &Config) -> Self

Creates a new client from a shared config.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Trait Implementations

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for Client<C, M, R>

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

Formats the value using the given formatter.

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

fn from(client: Client<C, M, R>) -> Self

Performs the conversion.