API Guide

Trigger Job

The Trigger Job API is used to pull data from a customer's AWS SSM instance, and process those data through sRTMS.

HTTP POST

URL

https://<hostname>:<port>/job-rest-service/aws-ec2/job

<hostname>: Azure hostname

<port>: Azure port

Header (JSON format)

Content-Type: application/json

Accept: application/json

X-MS-VERSION: v0.1.1

X-AD-Authorization: <azureToken>

Header (XML format)

Content-Type: application/xml

Accept: application/xml

X-MS-VERSION: v0.1.1

X-AD-Authorization: <azureToken>

Body (JSON format)

{

"jobName":"<jobName>",

"userName":"<awsLogin>",

"password":"<awsPwd>"

"athenaUrl":"<awsAthenaUrl>",

"s3StagingDir":"<awsS3StagingDir>",

"deviceSQL":"<awsDeviceSQL>",

"packageSQL":"<awsPackageSQL>"

}


<jobName>: Use an exist Job Name's or create a new one

<awsLogin>: AWS API Access Key

<awsPwd>: AWS API Secret Access Key

<awsAthenaUrl>: AthenaDB URL "jdbc:awsathena://athena.<region>.amazonaws.com:443/"

<awsS3StagingDir>: S3 Staging Directory (e.g.: "s3://s3-ssm-inventory/inv/")

<awsDeviceSQL>: AthenaDB Device Query

<awsPackageSQL>: AthenaDB Package Query

Body (XML format)

<JobArgs>

<jobName>[jobName]</jobName>

<userName>[snowLogin]</userName>

<password>[snowPwd]</password>

<athenaUrl>[awsAthenaUrl]</athenaUrl>

<s3StagingDir>[awsS3StagingDir]</s3StagingDir>

<deviceSQL>[awsDeviceSQL]</deviceSQL>

<packageSQL>[awsPackageSQL]</packageSQL>

</JobArgs>


[jobName]: Use an exist Job Name's or create a new one

[awsLogin]: AWS API Access Key

[awsPwd]: AWS API Secret Access Key

[awsAthenaUrl]: AthenaDB URL "jdbc:awsathena://athena.<region>.amazonaws.com:443/"

[awsS3StagingDir]: S3 Staging Directory (e.g.: "s3://s3-ssm-inventory/inv/")

[awsDeviceSQL]: AthenaDB Device Query

[awsPackageSQL]: AthenaDB Package Query

Response

This request will return the Job ID session key "jobID". Please save this Job ID and use it in the Job Status API call.

Support

if you have questions or issues using the API, please contact us as support@fatstacks.tech