ImportPublicKey
Import a public key to be used for signing stage participant tokens.
Request Syntax
POST /ImportPublicKey HTTP/1.1
Content-type: application/json
{
"name": "string
",
"publicKeyMaterial": "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.
- name
-
Name of the public key to be imported.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern:
[a-zA-Z0-9-_]*
Required: No
- publicKeyMaterial
-
The content of the public key to be imported.
Type: String
Pattern:
.*-----BEGIN PUBLIC KEY-----\r?\n([a-zA-Z0-9+/=\r\n]+)\r?\n-----END PUBLIC KEY-----(\r?\n)?.*
Required: Yes
-
Tags attached to the resource. Array of maps, each of the form
string:string (key:value)
. See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.Type: String to string map
Map Entries: Minimum number of 0 items. 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 200
Content-type: application/json
{
"publicKey": {
"arn": "string",
"fingerprint": "string",
"name": "string",
"publicKeyMaterial": "string",
"tags": {
"string" : "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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
HTTP Status Code: 403
- ConflictException
-
HTTP Status Code: 409
- PendingVerification
-
HTTP Status Code: 403
- ServiceQuotaExceededException
-
HTTP Status Code: 402
- ValidationException
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: