AWS IoT Fleet Hub

2020/12/15 - AWS IoT Fleet Hub - 8 new api methods

Changes  Update iotfleethub client to latest version

CreateApplication (new) Link ¶

Creates a Fleet Hub for AWS IoT Device Management web application.

See also: AWS API Documentation

Request Syntax

client.create_application(
    applicationName='string',
    applicationDescription='string',
    clientToken='string',
    roleArn='string',
    tags={
        'string': 'string'
    }
)
type applicationName:

string

param applicationName:

[REQUIRED]

The name of the web application.

type applicationDescription:

string

param applicationDescription:

An optional description of the web application.

type clientToken:

string

param clientToken:

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.

This field is autopopulated if not provided.

type roleArn:

string

param roleArn:

[REQUIRED]

The ARN of the role that the web application assumes when it interacts with AWS IoT Core.

type tags:

dict

param tags:

A set of key/value pairs that you can use to manage the web application resource.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'applicationId': 'string',
    'applicationArn': 'string'
}

Response Structure

  • (dict) --

    • applicationId (string) --

      The unique Id of the web application.

    • applicationArn (string) --

      The ARN of the web application.

UpdateApplication (new) Link ¶

Updates information about a Fleet Hub for a AWS IoT Device Management web application.

See also: AWS API Documentation

Request Syntax

client.update_application(
    applicationId='string',
    applicationName='string',
    applicationDescription='string',
    clientToken='string'
)
type applicationId:

string

param applicationId:

[REQUIRED]

The unique Id of the web application.

type applicationName:

string

param applicationName:

The name of the web application.

type applicationDescription:

string

param applicationDescription:

An optional description of the web application.

type clientToken:

string

param clientToken:

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.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

TagResource (new) Link ¶

Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)
type resourceArn:

string

param resourceArn:

[REQUIRED]

The ARN of the resource.

type tags:

dict

param tags:

[REQUIRED]

The new or modified tags for the resource.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

DeleteApplication (new) Link ¶

Deletes a Fleet Hub for AWS IoT Device Management web application.

See also: AWS API Documentation

Request Syntax

client.delete_application(
    applicationId='string',
    clientToken='string'
)
type applicationId:

string

param applicationId:

[REQUIRED]

The unique Id of the web application.

type clientToken:

string

param clientToken:

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.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

ListApplications (new) Link ¶

Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.

See also: AWS API Documentation

Request Syntax

client.list_applications(
    nextToken='string'
)
type nextToken:

string

param nextToken:

A token used to get the next set of results.

rtype:

dict

returns:

Response Syntax

{
    'applicationSummaries': [
        {
            'applicationId': 'string',
            'applicationName': 'string',
            'applicationDescription': 'string',
            'applicationUrl': 'string',
            'applicationCreationDate': 123,
            'applicationLastUpdateDate': 123,
            'applicationState': 'CREATING'|'DELETING'|'ACTIVE'|'CREATE_FAILED'|'DELETE_FAILED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • applicationSummaries (list) --

      An array of objects that provide summaries of information about the web applications in the list.

      • (dict) --

        A summary of information about a AWS IoT Device Management web application.

        • applicationId (string) --

          The unique Id of the web application.

        • applicationName (string) --

          The name of the web application.

        • applicationDescription (string) --

          An optional description of the web application.

        • applicationUrl (string) --

          The URL of the web application.

        • applicationCreationDate (integer) --

          The date (in Unix epoch time) when the web application was created.

        • applicationLastUpdateDate (integer) --

          The date (in Unix epoch time) when the web application was last updated.

        • applicationState (string) --

          The current state of the web application.

    • nextToken (string) --

      A token used to get the next set of results.

UntagResource (new) Link ¶

Removes the specified tags (metadata) from the resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
type resourceArn:

string

param resourceArn:

[REQUIRED]

The ARN of the resource.

type tagKeys:

list

param tagKeys:

[REQUIRED]

A list of the keys of the tags to be removed from the resource.

  • (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

ListTagsForResource (new) Link ¶

Lists the tags for the specified resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)
type resourceArn:

string

param resourceArn:

[REQUIRED]

The ARN of the resource.

rtype:

dict

returns:

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • tags (dict) --

      The list of tags assigned to the resource.

      • (string) --

        • (string) --

DescribeApplication (new) Link ¶

Gets information about a Fleet Hub for AWS IoT Device Management web application.

See also: AWS API Documentation

Request Syntax

client.describe_application(
    applicationId='string'
)
type applicationId:

string

param applicationId:

[REQUIRED]

The unique Id of the web application.

rtype:

dict

returns:

Response Syntax

{
    'applicationId': 'string',
    'applicationArn': 'string',
    'applicationName': 'string',
    'applicationDescription': 'string',
    'applicationUrl': 'string',
    'applicationState': 'CREATING'|'DELETING'|'ACTIVE'|'CREATE_FAILED'|'DELETE_FAILED',
    'applicationCreationDate': 123,
    'applicationLastUpdateDate': 123,
    'roleArn': 'string',
    'ssoClientId': 'string',
    'errorMessage': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • applicationId (string) --

      The unique Id of the web application.

    • applicationArn (string) --

      The ARN of the web application.

    • applicationName (string) --

      The name of the web application.

    • applicationDescription (string) --

      An optional description of the web application.

    • applicationUrl (string) --

      The URL of the web application.

    • applicationState (string) --

      The current state of the web application.

    • applicationCreationDate (integer) --

      The date (in Unix epoch time) when the application was created.

    • applicationLastUpdateDate (integer) --

      The date (in Unix epoch time) when the application was last updated.

    • roleArn (string) --

      The ARN of the role that the web application assumes when it interacts with AWS IoT Core.

    • ssoClientId (string) --

      The Id of the single sign-on client that you use to authenticate and authorize users on the web application.

    • errorMessage (string) --

      A message indicating why the DescribeApplication API failed.

    • tags (dict) --

      A set of key/value pairs that you can use to manage the web application resource.

      • (string) --

        • (string) --