Skip to content

IoT1ClickProjectsClient#

Index > IoT1ClickProjects > IoT1ClickProjectsClient

Auto-generated documentation for IoT1ClickProjects type annotations stubs module mypy-boto3-iot1click-projects.

IoT1ClickProjectsClient#

Type annotations and code completion for boto3.client("iot1click-projects"). boto3 documentation

# IoT1ClickProjectsClient usage example

from boto3.session import Session
from mypy_boto3_iot1click_projects.client import IoT1ClickProjectsClient

def get_iot1click-projects_client() -> IoT1ClickProjectsClient:
    return Session().client("iot1click-projects")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("iot1click-projects")

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

from mypy_boto3_iot1click_projects.client import Exceptions

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

Methods#

associate_device_with_placement#

Associates a physical device with a placement.

Type annotations and code completion for boto3.client("iot1click-projects").associate_device_with_placement method. boto3 documentation

# associate_device_with_placement method definition

def associate_device_with_placement(
    self,
    *,
    projectName: str,
    placementName: str,
    deviceId: str,
    deviceTemplateName: str,
) -> Dict[str, Any]:
    ...
# associate_device_with_placement method usage example with argument unpacking

kwargs: AssociateDeviceWithPlacementRequestRequestTypeDef = {  # (1)
    "projectName": ...,
    "placementName": ...,
    "deviceId": ...,
    "deviceTemplateName": ...,
}

parent.associate_device_with_placement(**kwargs)
  1. See AssociateDeviceWithPlacementRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("iot1click-projects").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("iot1click-projects").close method. boto3 documentation

# close method definition

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

create_placement#

Creates an empty placement.

Type annotations and code completion for boto3.client("iot1click-projects").create_placement method. boto3 documentation

# create_placement method definition

def create_placement(
    self,
    *,
    placementName: str,
    projectName: str,
    attributes: Mapping[str, str] = ...,
) -> Dict[str, Any]:
    ...
# create_placement method usage example with argument unpacking

kwargs: CreatePlacementRequestRequestTypeDef = {  # (1)
    "placementName": ...,
    "projectName": ...,
}

parent.create_placement(**kwargs)
  1. See CreatePlacementRequestRequestTypeDef

create_project#

Creates an empty project with a placement template.

Type annotations and code completion for boto3.client("iot1click-projects").create_project method. boto3 documentation

# create_project method definition

def create_project(
    self,
    *,
    projectName: str,
    description: str = ...,
    placementTemplate: PlacementTemplateTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> Dict[str, Any]:
    ...
  1. See PlacementTemplateTypeDef
# create_project method usage example with argument unpacking

kwargs: CreateProjectRequestRequestTypeDef = {  # (1)
    "projectName": ...,
}

parent.create_project(**kwargs)
  1. See CreateProjectRequestRequestTypeDef

delete_placement#

Deletes a placement.

Type annotations and code completion for boto3.client("iot1click-projects").delete_placement method. boto3 documentation

# delete_placement method definition

def delete_placement(
    self,
    *,
    placementName: str,
    projectName: str,
) -> Dict[str, Any]:
    ...
# delete_placement method usage example with argument unpacking

kwargs: DeletePlacementRequestRequestTypeDef = {  # (1)
    "placementName": ...,
    "projectName": ...,
}

parent.delete_placement(**kwargs)
  1. See DeletePlacementRequestRequestTypeDef

delete_project#

Deletes a project.

Type annotations and code completion for boto3.client("iot1click-projects").delete_project method. boto3 documentation

# delete_project method definition

def delete_project(
    self,
    *,
    projectName: str,
) -> Dict[str, Any]:
    ...
# delete_project method usage example with argument unpacking

kwargs: DeleteProjectRequestRequestTypeDef = {  # (1)
    "projectName": ...,
}

parent.delete_project(**kwargs)
  1. See DeleteProjectRequestRequestTypeDef

describe_placement#

Describes a placement in a project.

Type annotations and code completion for boto3.client("iot1click-projects").describe_placement method. boto3 documentation

# describe_placement method definition

def describe_placement(
    self,
    *,
    placementName: str,
    projectName: str,
) -> DescribePlacementResponseTypeDef:  # (1)
    ...
  1. See DescribePlacementResponseTypeDef
# describe_placement method usage example with argument unpacking

kwargs: DescribePlacementRequestRequestTypeDef = {  # (1)
    "placementName": ...,
    "projectName": ...,
}

parent.describe_placement(**kwargs)
  1. See DescribePlacementRequestRequestTypeDef

describe_project#

Returns an object describing a project.

Type annotations and code completion for boto3.client("iot1click-projects").describe_project method. boto3 documentation

# describe_project method definition

def describe_project(
    self,
    *,
    projectName: str,
) -> DescribeProjectResponseTypeDef:  # (1)
    ...
  1. See DescribeProjectResponseTypeDef
# describe_project method usage example with argument unpacking

kwargs: DescribeProjectRequestRequestTypeDef = {  # (1)
    "projectName": ...,
}

parent.describe_project(**kwargs)
  1. See DescribeProjectRequestRequestTypeDef

disassociate_device_from_placement#

Removes a physical device from a placement.

Type annotations and code completion for boto3.client("iot1click-projects").disassociate_device_from_placement method. boto3 documentation

# disassociate_device_from_placement method definition

def disassociate_device_from_placement(
    self,
    *,
    projectName: str,
    placementName: str,
    deviceTemplateName: str,
) -> Dict[str, Any]:
    ...
# disassociate_device_from_placement method usage example with argument unpacking

kwargs: DisassociateDeviceFromPlacementRequestRequestTypeDef = {  # (1)
    "projectName": ...,
    "placementName": ...,
    "deviceTemplateName": ...,
}

parent.disassociate_device_from_placement(**kwargs)
  1. See DisassociateDeviceFromPlacementRequestRequestTypeDef

generate_presigned_url#

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

Type annotations and code completion for boto3.client("iot1click-projects").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:
    ...

get_devices_in_placement#

Returns an object enumerating the devices in a placement.

Type annotations and code completion for boto3.client("iot1click-projects").get_devices_in_placement method. boto3 documentation

# get_devices_in_placement method definition

def get_devices_in_placement(
    self,
    *,
    projectName: str,
    placementName: str,
) -> GetDevicesInPlacementResponseTypeDef:  # (1)
    ...
  1. See GetDevicesInPlacementResponseTypeDef
# get_devices_in_placement method usage example with argument unpacking

kwargs: GetDevicesInPlacementRequestRequestTypeDef = {  # (1)
    "projectName": ...,
    "placementName": ...,
}

parent.get_devices_in_placement(**kwargs)
  1. See GetDevicesInPlacementRequestRequestTypeDef

list_placements#

Lists the placement(s) of a project.

Type annotations and code completion for boto3.client("iot1click-projects").list_placements method. boto3 documentation

# list_placements method definition

def list_placements(
    self,
    *,
    projectName: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListPlacementsResponseTypeDef:  # (1)
    ...
  1. See ListPlacementsResponseTypeDef
# list_placements method usage example with argument unpacking

kwargs: ListPlacementsRequestRequestTypeDef = {  # (1)
    "projectName": ...,
}

parent.list_placements(**kwargs)
  1. See ListPlacementsRequestRequestTypeDef

list_projects#

Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.

Type annotations and code completion for boto3.client("iot1click-projects").list_projects method. boto3 documentation

# list_projects method definition

def list_projects(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListProjectsResponseTypeDef:  # (1)
    ...
  1. See ListProjectsResponseTypeDef
# list_projects method usage example with argument unpacking

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

parent.list_projects(**kwargs)
  1. See ListProjectsRequestRequestTypeDef

list_tags_for_resource#

Lists the tags (metadata key/value pairs) which you have assigned to the resource.

Type annotations and code completion for boto3.client("iot1click-projects").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#

Creates or modifies tags for a resource.

Type annotations and code completion for boto3.client("iot1click-projects").tag_resource method.