com.amazonaws.services.ec2instanceconnect

Interface AWSEC2InstanceConnect

All Known Subinterfaces:

AWSEC2InstanceConnectAsync

All Known Implementing Classes:

AbstractAWSEC2InstanceConnect, AbstractAWSEC2InstanceConnectAsync, AWSEC2InstanceConnectAsyncClient, AWSEC2InstanceConnectClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSEC2InstanceConnect

Interface for accessing EC2 Instance Connect.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSEC2InstanceConnect instead.

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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
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 sendSSHPublicKeyRequest) Pushes an SSH public key to a particular OS user on a given EC2 instance for 60 seconds.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

sendSSHPublicKey

SendSSHPublicKeyResult sendSSHPublicKey(SendSSHPublicKeyRequest sendSSHPublicKeyRequest)

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

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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