IoT1ClickProjects class
The AWS IoT 1-Click Projects API Reference
Constructors
- IoT1ClickProjects({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
associateDeviceWithPlacement(
{required String deviceId, required String deviceTemplateName, required String placementName, required String projectName}) → Future< void> - Associates a physical device with a placement.
-
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
createPlacement(
{required String placementName, required String projectName, Map< String, String> ? attributes}) → Future<void> - Creates an empty placement.
-
createProject(
{required String projectName, String? description, PlacementTemplate? placementTemplate, Map< String, String> ? tags}) → Future<void> - Creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project.
-
deletePlacement(
{required String placementName, required String projectName}) → Future< void> - Deletes a placement. To delete a placement, it must not have any devices associated with it.
-
deleteProject(
{required String projectName}) → Future< void> - Deletes a project. To delete a project, it must not have any placements associated with it.
-
describePlacement(
{required String placementName, required String projectName}) → Future< DescribePlacementResponse> - Describes a placement in a project.
-
describeProject(
{required String projectName}) → Future< DescribeProjectResponse> - Returns an object describing a project.
-
disassociateDeviceFromPlacement(
{required String deviceTemplateName, required String placementName, required String projectName}) → Future< void> - Removes a physical device from a placement.
-
getDevicesInPlacement(
{required String placementName, required String projectName}) → Future< GetDevicesInPlacementResponse> - Returns an object enumerating the devices in a placement.
-
listPlacements(
{required String projectName, int? maxResults, String? nextToken}) → Future< ListPlacementsResponse> - Lists the placement(s) of a project.
-
listProjects(
{int? maxResults, String? nextToken}) → Future< ListProjectsResponse> - Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.
-
listTagsForResource(
{required String resourceArn}) → Future< ListTagsForResourceResponse> - Lists the tags (metadata key/value pairs) which you have assigned to the resource.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
tagResource(
{required String resourceArn, required Map< String, String> tags}) → Future<void> - Creates or modifies tags for a resource. Tags are key/value pairs (metadata) that can be used to manage a resource. For more information, see AWS Tagging Strategies.
-
toString(
) → String -
A string representation of this object.
inherited
-
untagResource(
{required String resourceArn, required List< String> tagKeys}) → Future<void> - Removes one or more tags (metadata key/value pairs) from a resource.
-
updatePlacement(
{required String placementName, required String projectName, Map< String, String> ? attributes}) → Future<void> - Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., "").
-
updateProject(
{required String projectName, String? description, PlacementTemplate? placementTemplate}) → Future< void> -
Updates a project associated with your AWS account and region. With the
exception of device template names, you can pass just the values that need
to be updated because the update request will change only the values that
are provided. To clear a value, pass the empty string (i.e.,
"").
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited