EC2Manager (Taskcluster Client (java port) 1.0.311 API)

java.lang.Object
- org.mozilla.taskcluster.client.TaskclusterRequestHandler
- - org.mozilla.taskcluster.client.ec2manager.EC2Manager

```
public class EC2Manager
extends TaskclusterRequestHandler
```
A taskcluster service which manages EC2 instances. This service does not understand any taskcluster concepts intrinsicaly other than using the name workerType to refer to a group of associated instances. Unless you are working on building a provisioner for AWS, you almost certainly do not want to use this service

See Also:

EC2Manager API Documentation

Field Summary

Fields
Modifier and Type Field and Description

protected static String defaultBaseURL

Fields
Modifier and Type	Field and Description
`protected static String`	`defaultBaseURL`

Constructor Summary

Constructors
Constructor and Description
`EC2Manager()`
`EC2Manager(Credentials credentials)`
`EC2Manager(Credentials credentials, String baseURL)`
`EC2Manager(String baseURL)`
`EC2Manager(String clientId, String accessToken)`
`EC2Manager(String clientId, String accessToken, String certificate)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CallSummary<EmptyPayload,EmptyPayload>`	`allState()` This method is only for debugging the ec2-managerRequired scopes: ec2-manager:internals
`CallSummary<EmptyPayload,EmptyPayload>`	`amiUsage()` List AMIs and their usage by returning a list of objects in the form: { region: string volumetype: string lastused: timestamp }Required scopes: ec2-manager:internals
`CallSummary<EmptyPayload,EmptyPayload>`	`apiReference()` Generate an API reference for this service
`CallSummary<EmptyPayload,EmptyPayload>`	`dbpoolStats()` This method is only for debugging the ec2-managerRequired scopes: ec2-manager:internals
`CallSummary<EmptyPayload,EmptyPayload>`	`ebsUsage()` Lists current EBS volume usage by returning a list of objects that are uniquely defined by {region, volumetype, state} in the form: { region: string, volumetype: string, state: string, totalcount: integer, totalgb: integer, touched: timestamp (last time that information was updated), }Required scopes: ec2-manager:internals
`CallSummary<SshPublicKey,EmptyPayload>`	`ensureKeyPair(String name, SshPublicKey payload)` Idempotently ensure that a keypair of a given name existsRequired scopes: ec2-manager:manage-key-pairs:
`CallSummary<EmptyPayload,HealthOfTheEC2Account>`	`getHealth()` Give some basic stats on the health of our EC2 account
`CallSummary<EmptyPayload,Entry1[]>`	`getPrices()` Return a list of possible prices for EC2
`CallSummary<EmptyPayload,Errors>`	`getRecentErrors()` Return a list of recent errors encountered
`CallSummary<Entry2[],Entry1[]>`	`getSpecificPrices(Entry2[] payload)` Return a list of possible prices for EC2
`CallSummary<EmptyPayload,String[]>`	`listWorkerTypes()` This method is only for debugging the ec2-manager
`CallSummary<EmptyPayload,EmptyPayload>`	`ping()` Respond without doing anything.
`CallSummary<EmptyPayload,EmptyPayload>`	`purgeQueues()` This method is only for debugging the ec2-managerRequired scopes: ec2-manager:internals
`CallSummary<EmptyPayload,EmptyPayload>`	`regions()` This method is only for debugging the ec2-managerRequired scopes: ec2-manager:internals
`CallSummary<EmptyPayload,EmptyPayload>`	`removeKeyPair(String name)` Ensure that a keypair of a given name does not exist.
`CallSummary<MakeASpotRequest,EmptyPayload>`	`runInstance(String workerType, MakeASpotRequest payload)` Request an instance of a worker typeRequired scopes: ec2-manager:manage-resources:
`CallSummary<EmptyPayload,EmptyPayload>`	`sqsStats()` This method is only for debugging the ec2-managerRequired scopes: ec2-manager:internals
`CallSummary<EmptyPayload,EmptyPayload>`	`terminateInstance(String region, String instanceId)` Terminate an instance in a specified regionRequired scopes: Any of: - ec2-manager:manage-instances:: - ec2-manager:manage-resources:
`CallSummary<EmptyPayload,EmptyPayload>`	`terminateWorkerType(String workerType)` Terminate all instances for this worker typeRequired scopes: ec2-manager:manage-resources:
`CallSummary<EmptyPayload,Errors>`	`workerTypeErrors(String workerType)` Return a list of the most recent errors encountered by a worker type
`CallSummary<EmptyPayload,HealthOfTheEC2Account>`	`workerTypeHealth(String workerType)` Return a view of the health of a given worker type
`CallSummary<EmptyPayload,OverviewOfComputationalResources1>`	`workerTypeState(String workerType)` Return state information for a given worker type
`CallSummary<EmptyPayload,OverviewOfComputationalResources>`	`workerTypeStats(String workerType)` Return an object which has a generic state description.

Methods inherited from class org.mozilla.taskcluster.client.TaskclusterRequestHandler
apiCall, setBaseURL, uriEncode

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - defaultBaseURL
```
protected static final String defaultBaseURL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - EC2Manager
```
public EC2Manager(Credentials credentials)
```
  - EC2Manager
```
public EC2Manager(Credentials credentials,
                  String baseURL)
```
  - EC2Manager
```
public EC2Manager(String clientId,
                  String accessToken)
```
  - EC2Manager
```
public EC2Manager(String clientId,
                  String accessToken,
                  String certificate)
```
  - EC2Manager
```
public EC2Manager(String baseURL)
```
  - EC2Manager
```
public EC2Manager()
```
- Method Detail
  - listWorkerTypes
```
public CallSummary<EmptyPayload,String[]> listWorkerTypes()
                                                   throws APICallFailure
```
    This method is only for debugging the ec2-manager
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    See the list of worker types which are known to be managed API Documentation
  - runInstance
```
public CallSummary<MakeASpotRequest,EmptyPayload> runInstance(String workerType,
                                                              MakeASpotRequest payload)
                                                       throws APICallFailure
```
    Request an instance of a worker type
    Required scopes: ec2-manager:manage-resources:
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    Run an instance API Documentation
  - terminateWorkerType
```
public CallSummary<EmptyPayload,EmptyPayload> terminateWorkerType(String workerType)
                                                           throws APICallFailure
```
    Terminate all instances for this worker type
    Required scopes: ec2-manager:manage-resources:
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    Terminate all resources from a worker type API Documentation
  - workerTypeStats
```
public CallSummary<EmptyPayload,OverviewOfComputationalResources> workerTypeStats(String workerType)
                                                                           throws APICallFailure
```
    Return an object which has a generic state description. This only contains counts of instances
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    Look up the resource stats for a workerType API Documentation
  - workerTypeHealth
```
public CallSummary<EmptyPayload,HealthOfTheEC2Account> workerTypeHealth(String workerType)
                                                                 throws APICallFailure
```
    Return a view of the health of a given worker type
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    Look up the resource health for a workerType API Documentation
  - workerTypeErrors
```
public CallSummary<EmptyPayload,Errors> workerTypeErrors(String workerType)
                                                  throws APICallFailure
```
    Return a list of the most recent errors encountered by a worker type
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    Look up the most recent errors of a workerType API Documentation
  - workerTypeState
```
public CallSummary<EmptyPayload,OverviewOfComputationalResources1> workerTypeState(String workerType)
                                                                            throws APICallFailure
```
    Return state information for a given worker type
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    Look up the resource state for a workerType API Documentation
  - ensureKeyPair
```
public CallSummary<SshPublicKey,EmptyPayload> ensureKeyPair(String name,
                                                            SshPublicKey payload)
                                                     throws APICallFailure
```
    Idempotently ensure that a keypair of a given name exists
    Required scopes: ec2-manager:manage-key-pairs:
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    Ensure a KeyPair for a given worker type exists API Documentation
  - removeKeyPair
```
public CallSummary<EmptyPayload,EmptyPayload> removeKeyPair(String name)
                                                     throws APICallFailure
```
    Ensure that a keypair of a given name does not exist.
    Required scopes: ec2-manager:manage-key-pairs:
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    Ensure a KeyPair for a given worker type does not exist API Documentation
  - terminateInstance
```
public CallSummary<EmptyPayload,EmptyPayload> terminateInstance(String region,
                                                                String instanceId)
                                                         throws APICallFailure
```
    Terminate an instance in a specified region
    Required scopes: Any of: - ec2-manager:manage-instances:: - ec2-manager:manage-resources:
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    Terminate an instance API Documentation
  - getPrices
```
public CallSummary<EmptyPayload,Entry1[]> getPrices()
                                             throws APICallFailure
```
    Return a list of possible prices for EC2
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    Request prices for EC2 API Documentation
  - getSpecificPrices
```
public CallSummary<Entry2[],Entry1[]> getSpecificPrices(Entry2[] payload)
                                                 throws APICallFailure
```
    Return a list of possible prices for EC2
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    Request prices for EC2 API Documentation
  - getHealth
```
public CallSummary<EmptyPayload,HealthOfTheEC2Account> getHealth()
                                                          throws APICallFailure
```
    Give some basic stats on the health of our EC2 account
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    Get EC2 account health metrics API Documentation
  - getRecentErrors
```
public CallSummary<EmptyPayload,Errors> getRecentErrors()
                                                 throws APICallFailure
```
    Return a list of recent errors encountered
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    Look up the most recent errors in the provisioner across all worker types API Documentation
  - regions
```
public CallSummary<EmptyPayload,EmptyPayload> regions()
                                               throws APICallFailure
```
    This method is only for debugging the ec2-manager
    Required scopes: ec2-manager:internals
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    See the list of regions managed by this ec2-manager API Documentation
  - amiUsage
```
public CallSummary<EmptyPayload,EmptyPayload> amiUsage()
                                                throws APICallFailure
```
    List AMIs and their usage by returning a list of objects in the form: { region: string volumetype: string lastused: timestamp }
    Required scopes: ec2-manager:internals
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    See the list of AMIs and their usage API Documentation
  - ebsUsage
```
public CallSummary<EmptyPayload,EmptyPayload> ebsUsage()
                                                throws APICallFailure
```
    Lists current EBS volume usage by returning a list of objects that are uniquely defined by {region, volumetype, state} in the form: { region: string, volumetype: string, state: string, totalcount: integer, totalgb: integer, touched: timestamp (last time that information was updated), }
    Required scopes: ec2-manager:internals
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    See the current EBS volume usage list API Documentation
  - dbpoolStats
```
public CallSummary<EmptyPayload,EmptyPayload> dbpoolStats()
                                                   throws APICallFailure
```
    This method is only for debugging the ec2-manager
    Required scopes: ec2-manager:internals
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    Statistics on the Database client pool API Documentation
  - allState
```
public CallSummary<EmptyPayload,EmptyPayload> allState()
                                                throws APICallFailure
```
    This method is only for debugging the ec2-manager
    Required scopes: ec2-manager:internals
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    List out the entire internal state API Documentation
  - sqsStats
```
public CallSummary<EmptyPayload,EmptyPayload> sqsStats()
                                                throws APICallFailure
```
    This method is only for debugging the ec2-manager
    Required scopes: ec2-manager:internals
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    Statistics on the sqs queues API Documentation
  - purgeQueues
```
public CallSummary<EmptyPayload,EmptyPayload> purgeQueues()
                                                   throws APICallFailure
```
    This method is only for debugging the ec2-manager
    Required scopes: ec2-manager:internals
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    Purge the SQS queues API Documentation
  - apiReference
```
public CallSummary<EmptyPayload,EmptyPayload> apiReference()
                                                    throws APICallFailure
```
    Generate an API reference for this service
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    API Reference API Documentation
  - ping
```
public CallSummary<EmptyPayload,EmptyPayload> ping()
                                            throws APICallFailure
```
    Respond without doing anything. This endpoint is used to check that the service is up.
    
    Throws:
    
    APICallFailure
    
    See Also:
    
    Ping Server API Documentation

Class EC2Manager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.mozilla.taskcluster.client.TaskclusterRequestHandler

Methods inherited from class java.lang.Object

Field Detail

defaultBaseURL

Constructor Detail

EC2Manager

EC2Manager

EC2Manager

EC2Manager

EC2Manager

EC2Manager

Method Detail

listWorkerTypes

runInstance

terminateWorkerType

workerTypeStats

workerTypeHealth

workerTypeErrors

workerTypeState

ensureKeyPair

removeKeyPair

terminateInstance

getPrices

getSpecificPrices

getHealth

getRecentErrors

regions

amiUsage

ebsUsage

dbpoolStats

allState

sqsStats

purgeQueues

apiReference

ping