"documentation":"<p>Associates a physical device with a placement.</p>"
},
"CreatePlacement":{
"name":"CreatePlacement",
"http":{
"method":"POST",
"requestUri":"/projects/{projectName}/placements"
},
"input":{"shape":"CreatePlacementRequest"},
"output":{"shape":"CreatePlacementResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceConflictException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Creates an empty placement.</p>"
},
"CreateProject":{
"name":"CreateProject",
"http":{
"method":"POST",
"requestUri":"/projects"
},
"input":{"shape":"CreateProjectRequest"},
"output":{"shape":"CreateProjectResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceConflictException"}
],
"documentation":"<p>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.</p>"
"documentation":"<p>Deletes a placement. To delete a placement, it must not have any devices associated with it.</p> <note> <p>When you delete a placement, all associated data becomes irretrievable.</p> </note>"
},
"DeleteProject":{
"name":"DeleteProject",
"http":{
"method":"DELETE",
"requestUri":"/projects/{projectName}"
},
"input":{"shape":"DeleteProjectRequest"},
"output":{"shape":"DeleteProjectResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"<p>Deletes a project. To delete a project, it must not have any placements associated with it.</p> <note> <p>When you delete a project, all associated data becomes irretrievable.</p> </note>"
"documentation":"<p>Lists the tags (metadata key/value pairs) which you have assigned to the resource.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/tags/{resourceArn}"
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>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 <a href=\"https://aws.amazon.com/answers/account-management/aws-tagging-strategies/\">AWS Tagging Strategies</a>.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"DELETE",
"requestUri":"/tags/{resourceArn}"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Removes one or more tags (metadata key/value pairs) from a resource.</p>"
"documentation":"<p>Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., \"\").</p>"
},
"UpdateProject":{
"name":"UpdateProject",
"http":{
"method":"PUT",
"requestUri":"/projects/{projectName}"
},
"input":{"shape":"UpdateProjectRequest"},
"output":{"shape":"UpdateProjectResponse"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"<p>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., <code>\"\"</code>).</p>"
}
},
"shapes":{
"AssociateDeviceWithPlacementRequest":{
"type":"structure",
"required":[
"projectName",
"placementName",
"deviceId",
"deviceTemplateName"
],
"members":{
"projectName":{
"shape":"ProjectName",
"documentation":"<p>The name of the project containing the placement in which to associate the device.</p>",
"location":"uri",
"locationName":"projectName"
},
"placementName":{
"shape":"PlacementName",
"documentation":"<p>The name of the placement in which to associate the device.</p>",
"location":"uri",
"locationName":"placementName"
},
"deviceId":{
"shape":"DeviceId",
"documentation":"<p>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 <code>deviceId</code> values.</p>"
},
"deviceTemplateName":{
"shape":"DeviceTemplateName",
"documentation":"<p>The device template name to associate with the device ID.</p>",
"location":"uri",
"locationName":"deviceTemplateName"
}
}
},
"AssociateDeviceWithPlacementResponse":{
"type":"structure",
"members":{
}
},
"AttributeDefaultValue":{
"type":"string",
"max":800
},
"AttributeName":{
"type":"string",
"max":128,
"min":1
},
"AttributeValue":{
"type":"string",
"max":800
},
"Code":{"type":"string"},
"CreatePlacementRequest":{
"type":"structure",
"required":[
"placementName",
"projectName"
],
"members":{
"placementName":{
"shape":"PlacementName",
"documentation":"<p>The name of the placement to be created.</p>"
},
"projectName":{
"shape":"ProjectName",
"documentation":"<p>The name of the project in which to create the placement.</p>",
"location":"uri",
"locationName":"projectName"
},
"attributes":{
"shape":"PlacementAttributeMap",
"documentation":"<p>Optional user-defined key/value pairs providing contextual data (such as location or function) for the placement.</p>"
}
}
},
"CreatePlacementResponse":{
"type":"structure",
"members":{
}
},
"CreateProjectRequest":{
"type":"structure",
"required":["projectName"],
"members":{
"projectName":{
"shape":"ProjectName",
"documentation":"<p>The name of the project to create.</p>"
},
"description":{
"shape":"Description",
"documentation":"<p>An optional description for the project.</p>"
},
"placementTemplate":{
"shape":"PlacementTemplate",
"documentation":"<p>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 <code>callbackOverrides</code> for the device templates using the <code>UpdateProject</code> API.</p>"
"documentation":"<p>Optional tags (metadata key/value pairs) to be associated with the project. For example, <code>{ {\"key1\": \"value1\", \"key2\": \"value2\"} }</code>. For more information, see <a href=\"https://aws.amazon.com/answers/account-management/aws-tagging-strategies/\">AWS Tagging Strategies</a>.</p>"
"documentation":"<p>The name of the project containing the placement.</p>"
},
"placementName":{
"shape":"PlacementName",
"documentation":"<p>The name of the placement.</p>"
},
"attributes":{
"shape":"PlacementAttributeMap",
"documentation":"<p>The user-defined attributes associated with the placement.</p>"
},
"createdDate":{
"shape":"Time",
"documentation":"<p>The date when the placement was initially created, in UNIX epoch time format.</p>"
},
"updatedDate":{
"shape":"Time",
"documentation":"<p>The date when the placement was last updated, in UNIX epoch time format. If the placement was not updated, then <code>createdDate</code> and <code>updatedDate</code> are the same.</p>"
}
},
"documentation":"<p>An object describing a project's placement.</p>"
},
"PlacementName":{
"type":"string",
"max":128,
"min":1,
"pattern":"^[a-zA-Z0-9_-]+$"
},
"PlacementSummary":{
"type":"structure",
"required":[
"projectName",
"placementName",
"createdDate",
"updatedDate"
],
"members":{
"projectName":{
"shape":"ProjectName",
"documentation":"<p>The name of the project containing the placement.</p>"
},
"placementName":{
"shape":"PlacementName",
"documentation":"<p>The name of the placement being summarized.</p>"
},
"createdDate":{
"shape":"Time",
"documentation":"<p>The date when the placement was originally created, in UNIX epoch time format.</p>"
},
"updatedDate":{
"shape":"Time",
"documentation":"<p>The date when the placement was last updated, in UNIX epoch time format. If the placement was not updated, then <code>createdDate</code> and <code>updatedDate</code> are the same.</p>"
}
},
"documentation":"<p>An object providing summary information for a particular placement.</p>"
},
"PlacementSummaryList":{
"type":"list",
"member":{"shape":"PlacementSummary"}
},
"PlacementTemplate":{
"type":"structure",
"members":{
"defaultAttributes":{
"shape":"DefaultPlacementAttributeMap",
"documentation":"<p>The default attributes (key/value pairs) to be applied to all placements using this template.</p>"
},
"deviceTemplates":{
"shape":"DeviceTemplateMap",
"documentation":"<p>An object specifying the <a>DeviceTemplate</a> for all placements using this (<a>PlacementTemplate</a>) template.</p>"
}
},
"documentation":"<p>An object defining the template for a placement.</p>"
"documentation":"<p>The name of the project for which to obtain information from.</p>"
},
"description":{
"shape":"Description",
"documentation":"<p>The description of the project.</p>"
},
"createdDate":{
"shape":"Time",
"documentation":"<p>The date when the project was originally created, in UNIX epoch time format.</p>"
},
"updatedDate":{
"shape":"Time",
"documentation":"<p>The date when the project was last updated, in UNIX epoch time format. If the project was not updated, then <code>createdDate</code> and <code>updatedDate</code> are the same.</p>"
},
"placementTemplate":{
"shape":"PlacementTemplate",
"documentation":"<p>An object describing the project's placement specifications.</p>"
"documentation":"<p>The name of the project being summarized.</p>"
},
"createdDate":{
"shape":"Time",
"documentation":"<p>The date when the project was originally created, in UNIX epoch time format.</p>"
},
"updatedDate":{
"shape":"Time",
"documentation":"<p>The date when the project was last updated, in UNIX epoch time format. If the project was not updated, then <code>createdDate</code> and <code>updatedDate</code> are the same.</p>"
"documentation":"<p>The ARN of the resouce for which tag(s) should be added or modified.</p>",
"location":"uri",
"locationName":"resourceArn"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>The new or modifying tag(s) for the resource. See <a href=\"https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-appendix.html#1click-limits\">AWS IoT 1-Click Service Limits</a> for the maximum number of tags allowed per resource.</p>"
"documentation":"<p>The name of the placement to update.</p>",
"location":"uri",
"locationName":"placementName"
},
"projectName":{
"shape":"ProjectName",
"documentation":"<p>The name of the project containing the placement to be updated.</p>",
"location":"uri",
"locationName":"projectName"
},
"attributes":{
"shape":"PlacementAttributeMap",
"documentation":"<p>The user-defined object of attributes used to update the placement. The maximum number of key/value pairs is 50.</p>"
}
}
},
"UpdatePlacementResponse":{
"type":"structure",
"members":{
}
},
"UpdateProjectRequest":{
"type":"structure",
"required":["projectName"],
"members":{
"projectName":{
"shape":"ProjectName",
"documentation":"<p>The name of the project to be updated.</p>",
"location":"uri",
"locationName":"projectName"
},
"description":{
"shape":"Description",
"documentation":"<p>An optional user-defined description for the project.</p>"
},
"placementTemplate":{
"shape":"PlacementTemplate",
"documentation":"<p>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 <code>placementTemplate</code>, you can update the associated <code>callbackOverrides</code> for the device definition using this API.</p>"