The AWS IoT 1-Click Projects Service API contains several data types that various actions use. This section describes each data type in detail.
Note
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.
The following data types are supported:
• DeviceTemplate (p. 37)
• PlacementDescription (p. 38)
• PlacementSummary (p. 40)
• PlacementTemplate (p. 41)
• ProjectDescription (p. 42)
• ProjectSummary (p. 44)
DeviceTemplate
An object representing a device for a placement template (see PlacementTemplate (p. 41)).
Contents
callbackOverrides
An optional Lambda function to invoke instead of the default Lambda function provided by the placement template.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Maximum length of 200.
Required: No deviceType
The device type, which currently must be "button".
Type: String
Length Constraints: Maximum length of 128.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2018-05-14 37
PlacementDescription
PlacementDescription
An object describing a project's placement.
Contents
attributes
The user-defined attributes associated with the placement.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Maximum length of 800.
Required: Yes createdDate
The date when the placement was initially created, in UNIX epoch time format.
Type: Timestamp Required: Yes placementName
The name of the placement.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^[a-zA-Z0-9_-]+$
Required: Yes projectName
The name of the project containing the placement.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^[0-9A-Za-z_-]+$
Required: Yes 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.
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2018-05-14 39
PlacementSummary
PlacementSummary
An object providing summary information for a particular placement.
Contents
createdDate
The date when the placement was originally created, in UNIX epoch time format.
Type: Timestamp Required: Yes placementName
The name of the placement being summarized.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^[a-zA-Z0-9_-]+$
Required: Yes projectName
The name of the project containing the placement.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^[0-9A-Za-z_-]+$
Required: Yes 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.
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
PlacementTemplate
An object defining the template for a placement.
Contents
defaultAttributes
The default attributes (key/value pairs) to be applied to all placements using this template.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Maximum length of 800.
Required: No deviceTemplates
An object specifying the DeviceTemplate (p. 37) for all placements using this (PlacementTemplate (p. 41)) template.
Type: String to DeviceTemplate (p. 37) object map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: ^[a-zA-Z0-9_-]+$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2018-05-14 41
ProjectDescription
ProjectDescription
An object providing detailed information for a particular project associated with an AWS account and region.
Contents
arn
The ARN of the project.
Type: String
Pattern: ^arn:aws:iot1click:[A-Za-z0-9_/.-]{0,63}:\d+:projects/[0-9A-Za-z_-]
{1,128}$
Required: No createdDate
The date when the project was originally created, in UNIX epoch time format.
Type: Timestamp Required: Yes description
The description of the project.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Required: No placementTemplate
An object describing the project's placement specifications.
Type: PlacementTemplate (p. 41) object Required: No
projectName
The name of the project for which to obtain information from.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^[0-9A-Za-z_-]+$
Required: Yes tags
The tags (metadata key/value pairs) associated with the project.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Maximum length of 256.
Required: No 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.
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2018-05-14 43
ProjectSummary
ProjectSummary
An object providing summary information for a particular project for an associated AWS account and region.
Contents
arn
The ARN of the project.
Type: String
Pattern: ^arn:aws:iot1click:[A-Za-z0-9_/.-]{0,63}:\d+:projects/[0-9A-Za-z_-]
{1,128}$
Required: No createdDate
The date when the project was originally created, in UNIX epoch time format.
Type: Timestamp Required: Yes projectName
The name of the project being summarized.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^[0-9A-Za-z_-]+$
Required: Yes tags
The tags (metadata key/value pairs) associated with the project.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Maximum length of 256.
Required: No 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.
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2018-05-14 45