Skip to content

IoTFleetHubClient#

Index > IoTFleetHub > IoTFleetHubClient

Auto-generated documentation for IoTFleetHub type annotations stubs module mypy-boto3-iotfleethub.

IoTFleetHubClient#

Type annotations and code completion for boto3.client("iotfleethub"). boto3 documentation

# IoTFleetHubClient usage example

from boto3.session import Session
from mypy_boto3_iotfleethub.client import IoTFleetHubClient

def get_iotfleethub_client() -> IoTFleetHubClient:
    return Session().client("iotfleethub")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("iotfleethub").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("iotfleethub")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalFailureException,
    client.exceptions.InvalidRequestException,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ThrottlingException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_iotfleethub.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("iotfleethub").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("iotfleethub").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_application#

Creates a Fleet Hub for IoT Device Management web application.

Type annotations and code completion for boto3.client("iotfleethub").create_application method. boto3 documentation

# create_application method definition

def create_application(
    self,
    *,
    applicationName: str,
    roleArn: str,
    applicationDescription: str = ...,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateApplicationResponseTypeDef:  # (1)
    ...
  1. See CreateApplicationResponseTypeDef 
# create_application method usage example with argument unpacking

kwargs: CreateApplicationRequestRequestTypeDef = {  # (1)
    "applicationName": ...,
    "roleArn": ...,
}

parent.create_application(**kwargs)
  1. See CreateApplicationRequestRequestTypeDef

delete_application#

Deletes a Fleet Hub for IoT Device Management web application.

Type annotations and code completion for boto3.client("iotfleethub").delete_application method. boto3 documentation

# delete_application method definition

def delete_application(
    self,
    *,
    applicationId: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...
# delete_application method usage example with argument unpacking

kwargs: DeleteApplicationRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.delete_application(**kwargs)
  1. See DeleteApplicationRequestRequestTypeDef

describe_application#

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

Type annotations and code completion for boto3.client("iotfleethub").describe_application method. boto3 documentation

# describe_application method definition

def describe_application(
    self,
    *,
    applicationId: str,
) -> DescribeApplicationResponseTypeDef:  # (1)
    ...
  1. See DescribeApplicationResponseTypeDef 
# describe_application method usage example with argument unpacking

kwargs: DescribeApplicationRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.describe_application(**kwargs)
  1. See DescribeApplicationRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("iotfleethub").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

list_applications#

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

Type annotations and code completion for boto3.client("iotfleethub").list_applications method. boto3 documentation

# list_applications method definition

def list_applications(
    self,
    *,
    nextToken: str = ...,
) -> ListApplicationsResponseTypeDef:  # (1)
    ...
  1. See ListApplicationsResponseTypeDef 
# list_applications method usage example with argument unpacking

kwargs: ListApplicationsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_applications(**kwargs)
  1. See ListApplicationsRequestRequestTypeDef

list_tags_for_resource#

Lists the tags for the specified resource.

Type annotations and code completion for boto3.client("iotfleethub").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

tag_resource#

Adds to or modifies the tags of the specified resource.

Type annotations and code completion for boto3.client("iotfleethub").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Removes the specified tags (metadata) from the resource.

Type annotations and code completion for boto3.client("iotfleethub").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_application#

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

Type annotations and code completion for boto3.client("iotfleethub").update_application method. boto3 documentation

# update_application method definition

def update_application(
    self,
    *,
    applicationId: str,
    applicationName: str = ...,
    applicationDescription: str = ...,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...
# update_application method usage example with argument unpacking

kwargs: UpdateApplicationRequestRequestTypeDef = {  # (1)
    "applicationId": ...,
}

parent.update_application(**kwargs)
  1. See UpdateApplicationRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("iotfleethub").get_paginator method with overloads.