Struct aws_sdk_ec2instanceconnect::Client

pub struct Client { /* private fields */ }

Client for AWS EC2 Instance Connect

Client for invoking operations on AWS EC2 Instance Connect. Each operation on AWS EC2 Instance Connect 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_ec2instanceconnect::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::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_ec2instanceconnect::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_ec2instanceconnect::Client::from_conf(config);

Implementations

impl Client

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

Creates a client with the given service configuration.

Examples found in repository

src/client.rs (line 70)

    fn from(
        client: aws_smithy_client::Client<
            aws_smithy_client::erase::DynConnector,
            aws_smithy_client::erase::DynMiddleware<aws_smithy_client::erase::DynConnector>,
        >,
    ) -> Self {
        Self::with_config(client, crate::Config::builder().build())
    }

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn send_serial_console_ssh_public_key(
    &self
) -> SendSerialConsoleSSHPublicKey

Constructs a fluent builder for the SendSerialConsoleSSHPublicKey operation.

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

    The ID of the EC2 instance.

  • serial_port(i32) / set_serial_port(i32):

    The serial port of the EC2 instance. Currently only port 0 is supported.

    Default: 0

  • ssh_public_key(impl Into<String>) / set_ssh_public_key(Option<String>):

    The public key material. To use the public key, you must have the matching private key. For information about the supported key formats and lengths, see Requirements for key pairs in the Amazon EC2 User Guide.

• On success, responds with SendSerialConsoleSshPublicKeyOutput with field(s):
  • request_id(Option<String>):

    The ID of the request. Please provide this ID when contacting AWS Support for assistance.

  • success(bool):

    Is true if the request succeeds and an error otherwise.

• On failure, responds with SdkError<SendSerialConsoleSSHPublicKeyError>

pub fn send_ssh_public_key(&self) -> SendSSHPublicKey

Constructs a fluent builder for the SendSSHPublicKey operation.

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

    The ID of the EC2 instance.

  • instance_os_user(impl Into<String>) / set_instance_os_user(Option<String>):

    The OS user on the EC2 instance for whom the key can be used to authenticate.

  • ssh_public_key(impl Into<String>) / set_ssh_public_key(Option<String>):

    The public key material. To use the public key, you must have the matching private key.

  • availability_zone(impl Into<String>) / set_availability_zone(Option<String>):

    The Availability Zone in which the EC2 instance was launched.

• On success, responds with SendSshPublicKeyOutput with field(s):
  • request_id(Option<String>):

    The ID of the request. Please provide this ID when contacting AWS Support for assistance.

  • success(bool):

    Is true if the request succeeds and an error otherwise.

• On failure, responds with SdkError<SendSSHPublicKeyError>

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.

Examples found in repository

src/client.rs (line 353)

    pub fn new(sdk_config: &aws_types::sdk_config::SdkConfig) -> Self {
        Self::from_conf(sdk_config.into())
    }

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.