com.amazonaws.services.ec2instanceconnect

Class AWSEC2InstanceConnectClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.ec2instanceconnect.AWSEC2InstanceConnectClient

All Implemented Interfaces:

AWSEC2InstanceConnect

Direct Known Subclasses:

AWSEC2InstanceConnectAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSEC2InstanceConnectClient
extends AmazonWebServiceClient
implements AWSEC2InstanceConnect

Client for accessing EC2 Instance Connect. All service calls made using this client are blocking, and will not return until the service call completes.

AWS EC2 Connect Service is a service that enables system administrators to publish temporary SSH keys to their EC2 instances in order to establish connections to their instances without leaving a permanent authentication option.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.ec2instanceconnect.AWSEC2InstanceConnect

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSEC2InstanceConnectClientBuilder	builder()
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
SendSSHPublicKeyResult	sendSSHPublicKey(SendSSHPublicKeyRequest request) Pushes an SSH public key to a particular OS user on a given EC2 instance for 60 seconds.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.ec2instanceconnect.AWSEC2InstanceConnect

shutdown

Method Detail

builder

public static AWSEC2InstanceConnectClientBuilder builder()

sendSSHPublicKey

public SendSSHPublicKeyResult sendSSHPublicKey(SendSSHPublicKeyRequest request)

Pushes an SSH public key to a particular OS user on a given EC2 instance for 60 seconds.

Specified by:

sendSSHPublicKey in interface AWSEC2InstanceConnect

Parameters:

sendSSHPublicKeyRequest -

Returns:

Result of the SendSSHPublicKey operation returned by the service.

Throws:

AuthException - Indicates that either your AWS credentials are invalid or you do not have access to the EC2 instance.

InvalidArgsException - Indicates that you provided bad input. Ensure you have a valid instance ID, the correct zone, and a valid SSH public key.

ServiceException - Indicates that the service encountered an error. Follow the message's instructions and try again.

ThrottlingException - Indicates you have been making requests too frequently and have been throttled. Wait for a while and try again. If higher call volume is warranted contact AWS Support.

EC2InstanceNotFoundException - Indicates that the instance requested was not found in the given zone. Check that you have provided a valid instance ID and the correct zone.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSEC2InstanceConnect

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.