Serialized Form

Package com.amazonaws.services.iot1clickprojects.model

Class com.amazonaws.services.iot1clickprojects.model.AssociateDeviceWithPlacementRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

projectName

String projectName

The name of the project containing the placement in which to associate the device.

placementName

String placementName

The name of the placement in which to associate the device.

deviceId

String deviceId

The ID of the physical device to be associated with the given placement in the project. Note that a mandatory 4 character prefix is required for all deviceId values.

deviceTemplateName

String deviceTemplateName

The device template name to associate with the device ID.

Class com.amazonaws.services.iot1clickprojects.model.AssociateDeviceWithPlacementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.iot1clickprojects.model.AWSIoT1ClickProjectsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot1clickprojects.model.CreatePlacementRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

placementName

String placementName

The name of the placement to be created.

projectName

String projectName

The name of the project in which to create the placement.

attributes

Map<K,V> attributes

Optional user-defined key/value pairs providing contextual data (such as location or function) for the placement.

Class com.amazonaws.services.iot1clickprojects.model.CreatePlacementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.iot1clickprojects.model.CreateProjectRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

projectName

String projectName

The name of the project to create.

description

String description

An optional description for the project.

placementTemplate

PlacementTemplate placementTemplate

The schema defining the placement to be created. A placement template defines placement default attributes and device templates. You cannot add or remove device templates after the project has been created. However, you can update callbackOverrides for the device templates using the UpdateProject API.

Class com.amazonaws.services.iot1clickprojects.model.CreateProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.iot1clickprojects.model.DeletePlacementRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

placementName

String placementName

The name of the empty placement to delete.

projectName

String projectName

The project containing the empty placement to delete.

Class com.amazonaws.services.iot1clickprojects.model.DeletePlacementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.iot1clickprojects.model.DeleteProjectRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

projectName

String projectName

The name of the empty project to delete.

Class com.amazonaws.services.iot1clickprojects.model.DeleteProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.iot1clickprojects.model.DescribePlacementRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

placementName

String placementName

The name of the placement within a project.

projectName

String projectName

The project containing the placement to be described.

Class com.amazonaws.services.iot1clickprojects.model.DescribePlacementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

placement

PlacementDescription placement

An object describing the placement.

Class com.amazonaws.services.iot1clickprojects.model.DescribeProjectRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

projectName

String projectName

The name of the project to be described.

Class com.amazonaws.services.iot1clickprojects.model.DescribeProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

project

ProjectDescription project

An object describing the project.

Class com.amazonaws.services.iot1clickprojects.model.DeviceTemplate extends Object implements Serializable

Serialized Fields

deviceType

String deviceType

The device type, which currently must be "button".

callbackOverrides

Map<K,V> callbackOverrides

An optional Lambda function to invoke instead of the default Lambda function provided by the placement template.

Class com.amazonaws.services.iot1clickprojects.model.DisassociateDeviceFromPlacementRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

projectName

String projectName

The name of the project that contains the placement.

placementName

String placementName

The name of the placement that the device should be removed from.

deviceTemplateName

String deviceTemplateName

The device ID that should be removed from the placement.

Class com.amazonaws.services.iot1clickprojects.model.DisassociateDeviceFromPlacementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.iot1clickprojects.model.GetDevicesInPlacementRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

projectName

String projectName

The name of the project containing the placement.

placementName

String placementName

The name of the placement to get the devices from.

Class com.amazonaws.services.iot1clickprojects.model.GetDevicesInPlacementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

devices

Map<K,V> devices

An object containing the devices (zero or more) within the placement.

Class com.amazonaws.services.iot1clickprojects.model.InternalFailureException extends AWSIoT1ClickProjectsException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

Class com.amazonaws.services.iot1clickprojects.model.InvalidRequestException extends AWSIoT1ClickProjectsException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

Class com.amazonaws.services.iot1clickprojects.model.ListPlacementsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

projectName

String projectName

The project containing the placements to be listed.

nextToken

String nextToken

The token to retrieve the next set of results.

maxResults

Integer maxResults

The maximum number of results to return per request. If not set, a default value of 100 is used.

Class com.amazonaws.services.iot1clickprojects.model.ListPlacementsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

placements

List<E> placements

An object listing the requested placements.

nextToken

String nextToken

The token used to retrieve the next set of results - will be effectively empty if there are no further results.

Class com.amazonaws.services.iot1clickprojects.model.ListProjectsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

String nextToken

The token to retrieve the next set of results.

maxResults

Integer maxResults

The maximum number of results to return per request. If not set, a default value of 100 is used.

Class com.amazonaws.services.iot1clickprojects.model.ListProjectsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

projects

List<E> projects

An object containing the list of projects.

nextToken

String nextToken

The token used to retrieve the next set of results - will be effectively empty if there are no further results.

Class com.amazonaws.services.iot1clickprojects.model.PlacementDescription extends Object implements Serializable

Serialized Fields

projectName

String projectName

The name of the project containing the placement.

placementName

String placementName

The name of the placement.

attributes

Map<K,V> attributes

The user-defined attributes associated with the placement.

createdDate

Date createdDate

The date when the placement was initially created, in UNIX epoch time format.

updatedDate

Date updatedDate

The date when the placement was last updated, in UNIX epoch time format. If the placement was not updated, then createdDate and updatedDate are the same.

Class com.amazonaws.services.iot1clickprojects.model.PlacementSummary extends Object implements Serializable

Serialized Fields

projectName

String projectName

The name of the project containing the placement.

placementName

String placementName

The name of the placement being summarized.

createdDate

Date createdDate

The date when the placement was originally created, in UNIX epoch time format.

updatedDate

Date updatedDate

The date when the placement was last updated, in UNIX epoch time format. If the placement was not updated, then createdDate and updatedDate are the same.

Class com.amazonaws.services.iot1clickprojects.model.PlacementTemplate extends Object implements Serializable

Serialized Fields

defaultAttributes

Map<K,V> defaultAttributes

The default attributes (key/value pairs) to be applied to all placements using this template.

deviceTemplates

Map<K,V> deviceTemplates

An object specifying the DeviceTemplate for all placements using this (PlacementTemplate) template.

Class com.amazonaws.services.iot1clickprojects.model.ProjectDescription extends Object implements Serializable

Serialized Fields

projectName

String projectName

The name of the project for which to obtain information from.

description

String description

The description of the project.

createdDate

Date createdDate

The date when the project was originally created, in UNIX epoch time format.

updatedDate

Date updatedDate

The date when the project was last updated, in UNIX epoch time format. If the project was not updated, then createdDate and updatedDate are the same.

placementTemplate

PlacementTemplate placementTemplate

An object describing the project's placement specifications.

Class com.amazonaws.services.iot1clickprojects.model.ProjectSummary extends Object implements Serializable

Serialized Fields

projectName

String projectName

The name of the project being summarized.

createdDate

Date createdDate

The date when the project was originally created, in UNIX epoch time format.

updatedDate

Date updatedDate

The date when the project was last updated, in UNIX epoch time format. If the project was not updated, then createdDate and updatedDate are the same.

Class com.amazonaws.services.iot1clickprojects.model.ResourceConflictException extends AWSIoT1ClickProjectsException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

Class com.amazonaws.services.iot1clickprojects.model.ResourceNotFoundException extends AWSIoT1ClickProjectsException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

Class com.amazonaws.services.iot1clickprojects.model.TooManyRequestsException extends AWSIoT1ClickProjectsException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

Class com.amazonaws.services.iot1clickprojects.model.UpdatePlacementRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

placementName

String placementName

The name of the placement to update.

projectName

String projectName

The name of the project containing the placement to be updated.

attributes

Map<K,V> attributes

The user-defined object of attributes used to update the placement. The maximum number of key/value pairs is 50.

Class com.amazonaws.services.iot1clickprojects.model.UpdatePlacementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.iot1clickprojects.model.UpdateProjectRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

projectName

String projectName

The name of the project to be updated.

description

String description

An optional user-defined description for the project.

placementTemplate

PlacementTemplate placementTemplate

An object defining the project update. Once a project has been created, you cannot add device template names to the project. However, for a given placementTemplate, you can update the associated callbackOverrides for the device definition using this API.

Class com.amazonaws.services.iot1clickprojects.model.UpdateProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable