CreatePackage
Creates an AWS IoT software package that can be deployed to your fleet.
Requires permission to access the CreatePackage and GetIndexingConfiguration actions.
Request Syntax
PUT /packages/packageName?clientToken=clientToken HTTP/1.1
Content-type: application/json
{
"description": "string",
"tags": {
"string" : "string"
}
}URI Request Parameters
The request uses the following URI parameters.
- clientToken
-
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Length Constraints: Minimum length of 36. Maximum length of 64.
Pattern:
\S{36,64} - packageName
-
The name of the new software package.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9-_.]+Required: Yes
Request Body
The request accepts the following data in JSON format.
- description
-
A summary of the package being created. This can be used to outline the package's contents or purpose.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[^\p{C}]+Required: No
-
Metadata that can be used to manage the package.
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:
^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"description": "string",
"packageArn": "string",
"packageName": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- description
-
The package description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[^\p{C}]+ - packageArn
-
The Amazon Resource Name (ARN) for the package.
Type: String
- packageName
-
The name of the software package.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9-_.]+
Errors
- ConflictException
-
The request conflicts with the current state of the resource.
HTTP Status Code: 409
- InternalServerException
-
Internal error from the service that indicates an unexpected error or that the service is unavailable.
HTTP Status Code: 500
- ServiceQuotaExceededException
-
Service quota has been exceeded.
HTTP Status Code: 402
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 400
- ValidationException
-
The request is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
