@datafire/amazonaws_iotfleethub v5.0.0

@datafire/amazonaws_iotfleethub

Client library for AWS IoT Fleet Hub

Installation and Usage

npm install --save @datafire/amazonaws_iotfleethub

let amazonaws_iotfleethub = require('@datafire/amazonaws_iotfleethub').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

ListApplications

amazonaws_iotfleethub.ListApplications({}, context)

Input

• input object
  • nextToken string

Output

• output ListApplicationsResponse

CreateApplication

amazonaws_iotfleethub.CreateApplication({
  "applicationName": "",
  "roleArn": ""
}, context)

Input

• input object
  • tags object: A set of key/value pairs that you can use to manage the web application resource.
  • applicationDescription string: An optional description of the web application.
  • applicationName required string: The name of the web application.
  • clientToken string: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
  • roleArn required string: The ARN of the role that the web application assumes when it interacts with AWS IoT Core. The name of the role must be in the form AWSIotFleetHub_random_string .

Output

Output schema unknown

DeleteApplication

amazonaws_iotfleethub.DeleteApplication({
  "applicationId": ""
}, context)

Input

• input object
  • applicationId required string
  • clientToken string

Output

Output schema unknown

DescribeApplication

amazonaws_iotfleethub.DescribeApplication({
  "applicationId": ""
}, context)

Input

• input object
  • applicationId required string

Output

• output DescribeApplicationResponse

UpdateApplication

amazonaws_iotfleethub.UpdateApplication({
  "applicationId": ""
}, context)

Input

• input object
  • applicationId required string
  • applicationDescription string: An optional description of the web application.
  • applicationName string: The name of the web application.
  • clientToken string: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

Output

Output schema unknown

ListTagsForResource

amazonaws_iotfleethub.ListTagsForResource({
  "resourceArn": ""
}, context)

Input

• input object
  • resourceArn required string

Output

• output ListTagsForResourceResponse

TagResource

amazonaws_iotfleethub.TagResource({
  "resourceArn": "",
  "tags": {}
}, context)

Input

• input object
  • resourceArn required string
  • tags required object: The new or modified tags for the resource.

Output

• output TagResourceResponse

UntagResource

amazonaws_iotfleethub.UntagResource({
  "resourceArn": "",
  "tagKeys": []
}, context)

Input

• input object
  • resourceArn required string
  • tagKeys required array

Output

• output UntagResourceResponse

Definitions

ApplicationState

• ApplicationState string (values: CREATING, DELETING, ACTIVE, CREATE_FAILED, DELETE_FAILED)

ApplicationSummaries

• ApplicationSummaries array
  • items ApplicationSummary

ApplicationSummary

• ApplicationSummary object: A summary of information about a AWS IoT Device Management web application. Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.
  • applicationCreationDate
  • applicationDescription
  • applicationId required
  • applicationLastUpdateDate
  • applicationName required
  • applicationState
  • applicationUrl required

Arn

• Arn string

ClientRequestToken

• ClientRequestToken string

ConflictException

CreateApplicationRequest

• CreateApplicationRequest object
  • tags
  • applicationDescription
  • applicationName required
  • clientToken
  • roleArn required

CreateApplicationResponse

• CreateApplicationResponse object
  • applicationArn required
  • applicationId required

DeleteApplicationRequest

• DeleteApplicationRequest object

DeleteApplicationResponse

• DeleteApplicationResponse object

DescribeApplicationRequest

• DescribeApplicationRequest object

DescribeApplicationResponse

• DescribeApplicationResponse object
  • tags
  • applicationArn required
  • applicationCreationDate required
  • applicationDescription
  • applicationId required
  • applicationLastUpdateDate required
  • applicationName required
  • applicationState required
  • applicationUrl required
  • errorMessage
  • roleArn required
  • ssoClientId

Description

• Description string

ErrorMessage

• ErrorMessage string

Id

• Id string

InternalFailureException

InvalidRequestException

LimitExceededException

ListApplicationsRequest

• ListApplicationsRequest object

ListApplicationsResponse

• ListApplicationsResponse object
  • applicationSummaries
    • items ApplicationSummary
  • nextToken

ListTagsForResourceRequest

• ListTagsForResourceRequest object

ListTagsForResourceResponse

• ListTagsForResourceResponse object
  • tags

Name

• Name string

NextToken

• NextToken string

ResourceArn

• ResourceArn string

ResourceNotFoundException

SsoClientId

• SsoClientId string

TagKey

• TagKey string

TagKeyList

• TagKeyList array
  • items TagKey

TagMap

• TagMap object

TagResourceRequest

• TagResourceRequest object
  • tags required

TagResourceResponse

• TagResourceResponse object

TagValue

• TagValue string

ThrottlingException

Timestamp

• Timestamp integer

UntagResourceRequest

• UntagResourceRequest object

UntagResourceResponse

• UntagResourceResponse object

UpdateApplicationRequest

• UpdateApplicationRequest object
  • applicationDescription
  • applicationName
  • clientToken

UpdateApplicationResponse

• UpdateApplicationResponse object

Url

• Url string