Create a product credential locker. This operation will trigger the creation of all the manufacturing resources including the Wi-Fi setup key pair and device certificate.
Request Syntax
POST /credential-lockers HTTP/1.1
Content-type: application/json
{
"ClientToken": "string",
"Name": "string",
"Tags": {
"string" : "string"
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- ClientToken
-
An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9=_-]+Required: No
- Name
-
The name of the credential locker.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[A-Za-z0-9-_ ]+Required: No
- Tags
-
A set of key/value pairs that are used to manage the credential locker.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"Arn": "string",
"CreatedAt": number,
"Id": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
- Arn
-
The Amazon Resource Name (ARN) of the credential locker.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 1011.
Pattern:
arn:aws:iotmanagedintegrations:[0-9a-zA-Z-]+:[0-9]+:credential-locker/[0-9a-zA-Z]+ - CreatedAt
-
The timestamp value of when the credential locker request occurred.
Type: Timestamp
- Id
-
The identifier of the credential locker creation request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
User is not authorized.
HTTP Status Code: 403
- ConflictException
-
There is a conflict with the request.
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
-
The service quota has been exceeded for this request.
HTTP Status Code: 402
- ServiceUnavailableException
-
The service is temporarily unavailable.
HTTP Status Code: 503
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 429
- ValidationException
-
A validation error occurred when performing the API request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
