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
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.
client = boto3.client("iot1click-projects")
try:
do_something(client)
except (
client.ClientError,
client.InternalFailureException,
client.InvalidRequestException,
client.ResourceConflictException,
client.ResourceNotFoundException,
client.TooManyRequestsException,
) as e:
print(e)
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
def associate_device_with_placement(
self,
*,
projectName: str,
placementName: str,
deviceId: str,
deviceTemplateName: str,
) -> Dict[str, Any]:
...
kwargs: AssociateDeviceWithPlacementRequestRequestTypeDef = { # (1)
"projectName": ...,
"placementName": ...,
"deviceId": ...,
"deviceTemplateName": ...,
}
parent.associate_device_with_placement(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("iot1click-projects").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("iot1click-projects").close
method.
boto3 documentation
create_placement
Creates an empty placement.
Type annotations and code completion for boto3.client("iot1click-projects").create_placement
method.
boto3 documentation
def create_placement(
self,
*,
placementName: str,
projectName: str,
attributes: Mapping[str, str] = ...,
) -> Dict[str, Any]:
...
kwargs: CreatePlacementRequestRequestTypeDef = { # (1)
"placementName": ...,
"projectName": ...,
}
parent.create_placement(**kwargs)
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
def create_project(
self,
*,
projectName: str,
description: str = ...,
placementTemplate: PlacementTemplateTypeDef = ..., # (1)
tags: Mapping[str, str] = ...,
) -> Dict[str, Any]:
...
kwargs: CreateProjectRequestRequestTypeDef = { # (1)
"projectName": ...,
}
parent.create_project(**kwargs)
delete_placement
Deletes a placement.
Type annotations and code completion for boto3.client("iot1click-projects").delete_placement
method.
boto3 documentation
def delete_placement(
self,
*,
placementName: str,
projectName: str,
) -> Dict[str, Any]:
...
kwargs: DeletePlacementRequestRequestTypeDef = { # (1)
"placementName": ...,
"projectName": ...,
}
parent.delete_placement(**kwargs)
delete_project
Deletes a project.
Type annotations and code completion for boto3.client("iot1click-projects").delete_project
method.
boto3 documentation
kwargs: DeleteProjectRequestRequestTypeDef = { # (1)
"projectName": ...,
}
parent.delete_project(**kwargs)
describe_placement
Describes a placement in a project.
Type annotations and code completion for boto3.client("iot1click-projects").describe_placement
method.
boto3 documentation
def describe_placement(
self,
*,
placementName: str,
projectName: str,
) -> DescribePlacementResponseTypeDef: # (1)
...
kwargs: DescribePlacementRequestRequestTypeDef = { # (1)
"placementName": ...,
"projectName": ...,
}
parent.describe_placement(**kwargs)
describe_project
Returns an object describing a project.
Type annotations and code completion for boto3.client("iot1click-projects").describe_project
method.
boto3 documentation
def describe_project(
self,
*,
projectName: str,
) -> DescribeProjectResponseTypeDef: # (1)
...
kwargs: DescribeProjectRequestRequestTypeDef = { # (1)
"projectName": ...,
}
parent.describe_project(**kwargs)
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
def disassociate_device_from_placement(
self,
*,
projectName: str,
placementName: str,
deviceTemplateName: str,
) -> Dict[str, Any]:
...
kwargs: DisassociateDeviceFromPlacementRequestRequestTypeDef = { # (1)
"projectName": ...,
"placementName": ...,
"deviceTemplateName": ...,
}
parent.disassociate_device_from_placement(**kwargs)
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
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
def get_devices_in_placement(
self,
*,
projectName: str,
placementName: str,
) -> GetDevicesInPlacementResponseTypeDef: # (1)
...
kwargs: GetDevicesInPlacementRequestRequestTypeDef = { # (1)
"projectName": ...,
"placementName": ...,
}
parent.get_devices_in_placement(**kwargs)
list_placements
Lists the placement(s) of a project.
Type annotations and code completion for boto3.client("iot1click-projects").list_placements
method.
boto3 documentation
def list_placements(
self,
*,
projectName: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListPlacementsResponseTypeDef: # (1)
...
kwargs: ListPlacementsRequestRequestTypeDef = { # (1)
"projectName": ...,
}
parent.list_placements(**kwargs)
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
def list_projects(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListProjectsResponseTypeDef: # (1)
...
kwargs: ListProjectsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_projects(**kwargs)
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
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
tag_resource
Creates or modifies tags for a resource.
Type annotations and code completion for boto3.client("iot1click-projects").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes one or more tags (metadata key/value pairs) from a resource.
Type annotations and code completion for boto3.client("iot1click-projects").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_placement
Updates a placement with the given attributes.
Type annotations and code completion for boto3.client("iot1click-projects").update_placement
method.
boto3 documentation
def update_placement(
self,
*,
placementName: str,
projectName: str,
attributes: Mapping[str, str] = ...,
) -> Dict[str, Any]:
...
kwargs: UpdatePlacementRequestRequestTypeDef = { # (1)
"placementName": ...,
"projectName": ...,
}
parent.update_placement(**kwargs)
update_project
Updates a project associated with your AWS account and region.
Type annotations and code completion for boto3.client("iot1click-projects").update_project
method.
boto3 documentation
def update_project(
self,
*,
projectName: str,
description: str = ...,
placementTemplate: PlacementTemplateTypeDef = ..., # (1)
) -> Dict[str, Any]:
...
kwargs: UpdateProjectRequestRequestTypeDef = { # (1)
"projectName": ...,
}
parent.update_project(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("iot1click-projects").get_paginator
method with overloads.
client.get_paginator("list_placements")
-> ListPlacementsPaginatorclient.get_paginator("list_projects")
-> ListProjectsPaginator