getInstanceDescription: Gather descriptive information about a running instance

In whitwort/AWSTools: Tools for working with AWS on data analysis projects.

Gather descriptive information about a running instance

Description

This function checks to make sure a launched instance is 'running' then returns an instance description used by the other functions in this package. You won't normally need to call this function directly, but it is useful if you want to launch instances yourself using the Web console, AWS CLI, or paws SDK instead of using launchInstance.

Usage

getInstanceDescription(instanceId, throttle = 1, username = "ec2-user")

Arguments

instanceId	The InstanceID returned or displayed through whatever mechanism used to launch the EC2 instance
throttle	The amount of time to wait (in seconds) before repeating requests to the AWS API. The account-wide limit is 10,000 r/s, so this default is extremely conservative.
username	The administrator username to use when logging in over ssh. The user must have sudo privileges. Default is set for Amazon Linux AMIs.

Details

Note: this function only tests that the instance is running, it does not verify that an ssh connection is corretly setup and available. You may have to wait awhile after starting your instance with external tools before you can use the other functions in this package.

Value

An instance object used by the other functions in this package

whitwort/AWSTools documentation built on July 9, 2023, 2:56 a.m.