NAME

Paws::IoT1ClickProjects - Perl Interface to AWS AWS IoT 1-Click Projects Service

SYNOPSIS

  use Paws;
  my $obj = Paws->service('IoT1ClickProjects');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

The AWS IoT 1-Click Projects API Reference

For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/projects.iot1click-2018-05-14>

METHODS

AssociateDeviceWithPlacement

DeviceId => Str
DeviceTemplateName => Str
PlacementName => Str
ProjectName => Str

Each argument is described in detail in: Paws::IoT1ClickProjects::AssociateDeviceWithPlacement

Returns: a Paws::IoT1ClickProjects::AssociateDeviceWithPlacementResponse instance

Associates a physical device with a placement.

CreatePlacement

PlacementName => Str
ProjectName => Str
[Attributes => Paws::IoT1ClickProjects::PlacementAttributeMap]

Each argument is described in detail in: Paws::IoT1ClickProjects::CreatePlacement

Returns: a Paws::IoT1ClickProjects::CreatePlacementResponse instance

Creates an empty placement.

CreateProject

ProjectName => Str
[Description => Str]
[PlacementTemplate => Paws::IoT1ClickProjects::PlacementTemplate]
[Tags => Paws::IoT1ClickProjects::TagMap]

Each argument is described in detail in: Paws::IoT1ClickProjects::CreateProject

Returns: a Paws::IoT1ClickProjects::CreateProjectResponse instance

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.

Each argument is described in detail in: Paws::IoT1ClickProjects::DeletePlacement

Returns: a Paws::IoT1ClickProjects::DeletePlacementResponse instance

Deletes a placement. To delete a placement, it must not have any devices associated with it.

When you delete a placement, all associated data becomes irretrievable.

DeleteProject

ProjectName => Str

Each argument is described in detail in: Paws::IoT1ClickProjects::DeleteProject

Returns: a Paws::IoT1ClickProjects::DeleteProjectResponse instance

Deletes a project. To delete a project, it must not have any placements associated with it.

When you delete a project, all associated data becomes irretrievable.

DescribePlacement

PlacementName => Str
ProjectName => Str

Each argument is described in detail in: Paws::IoT1ClickProjects::DescribePlacement

Returns: a Paws::IoT1ClickProjects::DescribePlacementResponse instance

Describes a placement in a project.

DescribeProject

ProjectName => Str

Each argument is described in detail in: Paws::IoT1ClickProjects::DescribeProject

Returns: a Paws::IoT1ClickProjects::DescribeProjectResponse instance

Returns an object describing a project.

DisassociateDeviceFromPlacement

DeviceTemplateName => Str
PlacementName => Str
ProjectName => Str

Each argument is described in detail in: Paws::IoT1ClickProjects::DisassociateDeviceFromPlacement

Returns: a Paws::IoT1ClickProjects::DisassociateDeviceFromPlacementResponse instance

Removes a physical device from a placement.

GetDevicesInPlacement

PlacementName => Str
ProjectName => Str

Each argument is described in detail in: Paws::IoT1ClickProjects::GetDevicesInPlacement

Returns: a Paws::IoT1ClickProjects::GetDevicesInPlacementResponse instance

Returns an object enumerating the devices in a placement.

ListPlacements

ProjectName => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::IoT1ClickProjects::ListPlacements

Returns: a Paws::IoT1ClickProjects::ListPlacementsResponse instance

Lists the placement(s) of a project.

ListProjects

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::IoT1ClickProjects::ListProjects

Returns: a Paws::IoT1ClickProjects::ListProjectsResponse instance

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

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::IoT1ClickProjects::ListTagsForResource

Returns: a Paws::IoT1ClickProjects::ListTagsForResourceResponse instance

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

TagResource

ResourceArn => Str
Tags => Paws::IoT1ClickProjects::TagMap

Each argument is described in detail in: Paws::IoT1ClickProjects::TagResource

Returns: a Paws::IoT1ClickProjects::TagResourceResponse instance

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 (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/).

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::IoT1ClickProjects::UntagResource

Returns: a Paws::IoT1ClickProjects::UntagResourceResponse instance

Removes one or more tags (metadata key/value pairs) from a resource.

UpdatePlacement

PlacementName => Str
ProjectName => Str
[Attributes => Paws::IoT1ClickProjects::PlacementAttributeMap]

Each argument is described in detail in: Paws::IoT1ClickProjects::UpdatePlacement

Returns: a Paws::IoT1ClickProjects::UpdatePlacementResponse instance

Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., "").

UpdateProject

ProjectName => Str
[Description => Str]
[PlacementTemplate => Paws::IoT1ClickProjects::PlacementTemplate]

Each argument is described in detail in: Paws::IoT1ClickProjects::UpdateProject

Returns: a Paws::IoT1ClickProjects::UpdateProjectResponse instance

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., "").

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllPlacements(sub { },ProjectName => Str, [MaxResults => Int, NextToken => Str])

ListAllPlacements(ProjectName => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - placements, passing the object as the first parameter, and the string 'placements' as the second parameter

If not, it will return a a Paws::IoT1ClickProjects::ListPlacementsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllProjects(sub { },[MaxResults => Int, NextToken => Str])

ListAllProjects([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - projects, passing the object as the first parameter, and the string 'projects' as the second parameter

If not, it will return a a Paws::IoT1ClickProjects::ListProjectsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>