software.amazon.awssdk.services.ec2instanceconnect

Interface Ec2InstanceConnectAsyncClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
 @ThreadSafe
public interface Ec2InstanceConnectAsyncClient
extends AwsClient

Service client for accessing EC2 Instance Connect asynchronously. This can be created using the static builder() method.

Amazon EC2 Instance Connect enables system administrators to publish one-time use SSH public keys to EC2, providing users a simple and secure way to connect to their instances.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_METADATA_ID Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static Ec2InstanceConnectAsyncClientBuilder	builder() Create a builder that can be used to configure and create a Ec2InstanceConnectAsyncClient.
static Ec2InstanceConnectAsyncClient	create() Create a Ec2InstanceConnectAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<SendSerialConsoleSshPublicKeyResponse>	sendSerialConsoleSSHPublicKey(Consumer<SendSerialConsoleSshPublicKeyRequest.Builder> sendSerialConsoleSshPublicKeyRequest) Pushes an SSH public key to the specified EC2 instance.
default CompletableFuture<SendSerialConsoleSshPublicKeyResponse>	sendSerialConsoleSSHPublicKey(SendSerialConsoleSshPublicKeyRequest sendSerialConsoleSshPublicKeyRequest) Pushes an SSH public key to the specified EC2 instance.
default CompletableFuture<SendSshPublicKeyResponse>	sendSSHPublicKey(Consumer<SendSshPublicKeyRequest.Builder> sendSshPublicKeyRequest) Pushes an SSH public key to the specified EC2 instance for use by the specified user.
default CompletableFuture<SendSshPublicKeyResponse>	sendSSHPublicKey(SendSshPublicKeyRequest sendSshPublicKeyRequest) Pushes an SSH public key to the specified EC2 instance for use by the specified user.
default Ec2InstanceConnectServiceClientConfiguration	serviceClientConfiguration()

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

sendSSHPublicKey

default CompletableFuture<SendSshPublicKeyResponse> sendSSHPublicKey(SendSshPublicKeyRequest sendSshPublicKeyRequest)

Pushes an SSH public key to the specified EC2 instance for use by the specified user. The key remains for 60 seconds. For more information, see Connect to your Linux instance using EC2 Instance Connect in the Amazon EC2 User Guide.

Parameters:

sendSshPublicKeyRequest -

Returns:

A Java Future containing the result of the SendSSHPublicKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AuthException Either your AWS credentials are not valid or you do not have access to the EC2 instance.
• InvalidArgsException One of the parameters is not valid.
• ServiceException The service encountered an error. Follow the instructions in the error message and try again.
• ThrottlingException The requests were made too frequently and have been throttled. Wait a while and try again. To increase the limit on your request frequency, contact AWS Support.
• Ec2InstanceNotFoundException The specified instance was not found.
• Ec2InstanceStateInvalidException Unable to connect because the instance is not in a valid state. Connecting to a stopped or terminated instance is not supported. If the instance is stopped, start your instance, and try to connect again.
• Ec2InstanceUnavailableException The instance is currently unavailable. Wait a few minutes and try again.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• Ec2InstanceConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

sendSSHPublicKey

default CompletableFuture<SendSshPublicKeyResponse> sendSSHPublicKey(Consumer<SendSshPublicKeyRequest.Builder> sendSshPublicKeyRequest)

Pushes an SSH public key to the specified EC2 instance for use by the specified user. The key remains for 60 seconds. For more information, see Connect to your Linux instance using EC2 Instance Connect in the Amazon EC2 User Guide.

This is a convenience which creates an instance of the SendSshPublicKeyRequest.Builder avoiding the need to create one manually via SendSshPublicKeyRequest.builder()

Parameters:

sendSshPublicKeyRequest - A Consumer that will call methods on SendSSHPublicKeyRequest.Builder to create a request.

Returns:

A Java Future containing the result of the SendSSHPublicKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AuthException Either your AWS credentials are not valid or you do not have access to the EC2 instance.
• InvalidArgsException One of the parameters is not valid.
• ServiceException The service encountered an error. Follow the instructions in the error message and try again.
• ThrottlingException The requests were made too frequently and have been throttled. Wait a while and try again. To increase the limit on your request frequency, contact AWS Support.
• Ec2InstanceNotFoundException The specified instance was not found.
• Ec2InstanceStateInvalidException Unable to connect because the instance is not in a valid state. Connecting to a stopped or terminated instance is not supported. If the instance is stopped, start your instance, and try to connect again.
• Ec2InstanceUnavailableException The instance is currently unavailable. Wait a few minutes and try again.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• Ec2InstanceConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

sendSerialConsoleSSHPublicKey

default CompletableFuture<SendSerialConsoleSshPublicKeyResponse> sendSerialConsoleSSHPublicKey(SendSerialConsoleSshPublicKeyRequest sendSerialConsoleSshPublicKeyRequest)

Pushes an SSH public key to the specified EC2 instance. The key remains for 60 seconds, which gives you 60 seconds to establish a serial console connection to the instance using SSH. For more information, see EC2 Serial Console in the Amazon EC2 User Guide.

Parameters:

sendSerialConsoleSshPublicKeyRequest -

Returns:

A Java Future containing the result of the SendSerialConsoleSSHPublicKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AuthException Either your AWS credentials are not valid or you do not have access to the EC2 instance.
• SerialConsoleAccessDisabledException Your account is not authorized to use the EC2 Serial Console. To authorize your account, run the EnableSerialConsoleAccess API. For more information, see EnableSerialConsoleAccess in the Amazon EC2 API Reference.
• InvalidArgsException One of the parameters is not valid.
• ServiceException The service encountered an error. Follow the instructions in the error message and try again.
• ThrottlingException The requests were made too frequently and have been throttled. Wait a while and try again. To increase the limit on your request frequency, contact AWS Support.
• Ec2InstanceNotFoundException The specified instance was not found.
• Ec2InstanceTypeInvalidException The instance type is not supported for connecting via the serial console. Only Nitro instance types are currently supported.
• SerialConsoleSessionLimitExceededException The instance currently has 1 active serial console session. Only 1 session is supported at a time.
• SerialConsoleSessionUnavailableException Unable to start a serial console session. Please try again.
• Ec2InstanceStateInvalidException Unable to connect because the instance is not in a valid state. Connecting to a stopped or terminated instance is not supported. If the instance is stopped, start your instance, and try to connect again.
• Ec2InstanceUnavailableException The instance is currently unavailable. Wait a few minutes and try again.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• Ec2InstanceConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

sendSerialConsoleSSHPublicKey

default CompletableFuture<SendSerialConsoleSshPublicKeyResponse> sendSerialConsoleSSHPublicKey(Consumer<SendSerialConsoleSshPublicKeyRequest.Builder> sendSerialConsoleSshPublicKeyRequest)

Pushes an SSH public key to the specified EC2 instance. The key remains for 60 seconds, which gives you 60 seconds to establish a serial console connection to the instance using SSH. For more information, see EC2 Serial Console in the Amazon EC2 User Guide.

This is a convenience which creates an instance of the SendSerialConsoleSshPublicKeyRequest.Builder avoiding the need to create one manually via SendSerialConsoleSshPublicKeyRequest.builder()

Parameters:

sendSerialConsoleSshPublicKeyRequest - A Consumer that will call methods on SendSerialConsoleSSHPublicKeyRequest.Builder to create a request.

Returns:

A Java Future containing the result of the SendSerialConsoleSSHPublicKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• AuthException Either your AWS credentials are not valid or you do not have access to the EC2 instance.
• SerialConsoleAccessDisabledException Your account is not authorized to use the EC2 Serial Console. To authorize your account, run the EnableSerialConsoleAccess API. For more information, see EnableSerialConsoleAccess in the Amazon EC2 API Reference.
• InvalidArgsException One of the parameters is not valid.
• ServiceException The service encountered an error. Follow the instructions in the error message and try again.
• ThrottlingException The requests were made too frequently and have been throttled. Wait a while and try again. To increase the limit on your request frequency, contact AWS Support.
• Ec2InstanceNotFoundException The specified instance was not found.
• Ec2InstanceTypeInvalidException The instance type is not supported for connecting via the serial console. Only Nitro instance types are currently supported.
• SerialConsoleSessionLimitExceededException The instance currently has 1 active serial console session. Only 1 session is supported at a time.
• SerialConsoleSessionUnavailableException Unable to start a serial console session. Please try again.
• Ec2InstanceStateInvalidException Unable to connect because the instance is not in a valid state. Connecting to a stopped or terminated instance is not supported. If the instance is stopped, start your instance, and try to connect again.
• Ec2InstanceUnavailableException The instance is currently unavailable. Wait a few minutes and try again.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• Ec2InstanceConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

serviceClientConfiguration

default Ec2InstanceConnectServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

create

static Ec2InstanceConnectAsyncClient create()

Create a Ec2InstanceConnectAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static Ec2InstanceConnectAsyncClientBuilder builder()

Create a builder that can be used to configure and create a Ec2InstanceConnectAsyncClient.