@rks-bzin/pc_api v3.0.5

PC

ParallelCluster - JavaScript client for parallel_cluster ParallelCluster API This SDK is automatically generated by the OpenAPI Generator project:

• API version: 3.0.0
• Package version: 3.0.1 - using us-east-1 with pc 3.2.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install rksuseast1pc320 --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your parallel_cluster from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var ParallelCluster = require('@rks-bzin/pc_api');

var defaultClient = ParallelCluster.ApiClient.instance;
// Configure API key authorization: aws.auth.sigv4
var aws.auth.sigv4 = defaultClient.authentications['aws.auth.sigv4'];
aws.auth.sigv4.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//aws.auth.sigv4.apiKeyPrefix['Authorization'] = "Token"

var api = new ParallelCluster.ClusterComputeFleetApi()
var clusterName = "clusterName_example"; // {String} Name of the cluster
var opts = {
  'region': "region_example" // {String} AWS Region that the operation corresponds to.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.describeComputeFleet(clusterName, opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Documentation for Models

• ParallelCluster.AmiInfo
• ParallelCluster.BadRequestExceptionResponseContent
• ParallelCluster.BuildImageBadRequestExceptionResponseContent
• ParallelCluster.BuildImageRequestContent
• ParallelCluster.BuildImageResponseContent
• ParallelCluster.Change
• ParallelCluster.CloudFormationResourceStatus
• ParallelCluster.CloudFormationStackStatus
• ParallelCluster.ClusterConfigurationStructure
• ParallelCluster.ClusterInfoSummary
• ParallelCluster.ClusterInstance
• ParallelCluster.ClusterStatus
• ParallelCluster.ClusterStatusFilteringOption
• ParallelCluster.ComputeFleetStatus
• ParallelCluster.ConfigValidationMessage
• ParallelCluster.ConflictExceptionResponseContent
• ParallelCluster.CreateClusterBadRequestExceptionResponseContent
• ParallelCluster.CreateClusterRequestContent
• ParallelCluster.CreateClusterResponseContent
• ParallelCluster.DeleteClusterResponseContent
• ParallelCluster.DeleteImageResponseContent
• ParallelCluster.DescribeClusterInstancesResponseContent
• ParallelCluster.DescribeClusterResponseContent
• ParallelCluster.DescribeComputeFleetResponseContent
• ParallelCluster.DescribeImageResponseContent
• ParallelCluster.DryrunOperationExceptionResponseContent
• ParallelCluster.EC2Instance
• ParallelCluster.Ec2AmiInfo
• ParallelCluster.Ec2AmiInfoSummary
• ParallelCluster.Ec2AmiState
• ParallelCluster.GetClusterLogEventsResponseContent
• ParallelCluster.GetClusterStackEventsResponseContent
• ParallelCluster.GetImageLogEventsResponseContent
• ParallelCluster.GetImageStackEventsResponseContent
• ParallelCluster.ImageBuildStatus
• ParallelCluster.ImageBuilderImageStatus
• ParallelCluster.ImageConfigurationStructure
• ParallelCluster.ImageInfoSummary
• ParallelCluster.ImageStatusFilteringOption
• ParallelCluster.InstanceState
• ParallelCluster.InternalServiceExceptionResponseContent
• ParallelCluster.LimitExceededExceptionResponseContent
• ParallelCluster.ListClusterLogStreamsResponseContent
• ParallelCluster.ListClustersResponseContent
• ParallelCluster.ListImageLogStreamsResponseContent
• ParallelCluster.ListImagesResponseContent
• ParallelCluster.ListOfficialImagesResponseContent
• ParallelCluster.LogEvent
• ParallelCluster.LogStream
• ParallelCluster.Metadata
• ParallelCluster.NodeType
• ParallelCluster.NotFoundExceptionResponseContent
• ParallelCluster.RequestedComputeFleetStatus
• ParallelCluster.Scheduler
• ParallelCluster.StackEvent
• ParallelCluster.Tag
• ParallelCluster.UnauthorizedClientErrorResponseContent
• ParallelCluster.UpdateClusterBadRequestExceptionResponseContent
• ParallelCluster.UpdateClusterRequestContent
• ParallelCluster.UpdateClusterResponseContent
• ParallelCluster.UpdateComputeFleetRequestContent
• ParallelCluster.UpdateComputeFleetResponseContent
• ParallelCluster.UpdateError
• ParallelCluster.ValidationLevel

Documentation for Authorization

aws.auth.sigv4

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header