IoT1ClickProjectsClient Class

Member Function Documentation

IoT1ClickProjectsClient::IoT1ClickProjectsClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a IoT1ClickProjectsClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

IoT1ClickProjectsClient::IoT1ClickProjectsClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads IoT1ClickProjectsClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AssociateDeviceWithPlacementResponse *IoT1ClickProjectsClient::associateDeviceWithPlacement(const AssociateDeviceWithPlacementRequest &request)

Sends request to the IoT1ClickProjectsClient service, and returns a pointer to an AssociateDeviceWithPlacementResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Associates a physical device with a

[slot] CreatePlacementResponse *IoT1ClickProjectsClient::createPlacement(const CreatePlacementRequest &request)

Sends request to the IoT1ClickProjectsClient service, and returns a pointer to an CreatePlacementResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates an empty

[slot] CreateProjectResponse *IoT1ClickProjectsClient::createProject(const CreateProjectRequest &request)

Sends request to the IoT1ClickProjectsClient service, and returns a pointer to an CreateProjectResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the

[slot] DeletePlacementResponse *IoT1ClickProjectsClient::deletePlacement(const DeletePlacementRequest &request)

Sends request to the IoT1ClickProjectsClient service, and returns a pointer to an DeletePlacementResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

it> <note>

When you delete a placement, all associated data becomes

[slot] DeleteProjectResponse *IoT1ClickProjectsClient::deleteProject(const DeleteProjectRequest &request)

Sends request to the IoT1ClickProjectsClient service, and returns a pointer to an DeleteProjectResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

it> <note>

When you delete a project, all associated data becomes

[slot] DescribePlacementResponse *IoT1ClickProjectsClient::describePlacement(const DescribePlacementRequest &request)

Sends request to the IoT1ClickProjectsClient service, and returns a pointer to an DescribePlacementResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes a placement in a

[slot] DescribeProjectResponse *IoT1ClickProjectsClient::describeProject(const DescribeProjectRequest &request)

Sends request to the IoT1ClickProjectsClient service, and returns a pointer to an DescribeProjectResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns an object describing a

[slot] DisassociateDeviceFromPlacementResponse *IoT1ClickProjectsClient::disassociateDeviceFromPlacement(const DisassociateDeviceFromPlacementRequest &request)

Sends request to the IoT1ClickProjectsClient service, and returns a pointer to an DisassociateDeviceFromPlacementResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes a physical device from a

[slot] GetDevicesInPlacementResponse *IoT1ClickProjectsClient::getDevicesInPlacement(const GetDevicesInPlacementRequest &request)

Sends request to the IoT1ClickProjectsClient service, and returns a pointer to an GetDevicesInPlacementResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns an object enumerating the devices in a

[slot] ListPlacementsResponse *IoT1ClickProjectsClient::listPlacements(const ListPlacementsRequest &request)

Sends request to the IoT1ClickProjectsClient service, and returns a pointer to an ListPlacementsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the placement(s) of a

[slot] ListProjectsResponse *IoT1ClickProjectsClient::listProjects(const ListProjectsRequest &request)

Sends request to the IoT1ClickProjectsClient service, and returns a pointer to an ListProjectsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] UpdatePlacementResponse *IoT1ClickProjectsClient::updatePlacement(const UpdatePlacementRequest &request)

Sends request to the IoT1ClickProjectsClient service, and returns a pointer to an UpdatePlacementResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] UpdateProjectResponse *IoT1ClickProjectsClient::updateProject(const UpdateProjectRequest &request)

Sends request to the IoT1ClickProjectsClient service, and returns a pointer to an UpdateProjectResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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