Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateStreamKey

Creates a stream key, used to initiate a stream, for the specified channel ARN.

Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.

Request Syntax


POST /CreateStreamKey HTTP/1.1
Content-type: application/json

{
   "channelArn": "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.

channelArn

ARN of the channel for which to create the stream key.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: arn:aws:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+

Required: Yes

tags

Array of 1-50 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 service-specific constraints 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

{
   "streamKey": { 
      "arn": "string",
      "channelArn": "string",
      "tags": { 
         "string" : "string" 
      },
      "value": "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.

streamKey

Stream key used to authenticate an RTMPS stream for ingestion.

Type: StreamKey object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

exceptionMessage: User does not have sufficient access to perform this action.

HTTP Status Code: 403

PendingVerification

exceptionMessage: Your account is pending verification.

HTTP Status Code: 403

ResourceNotFoundException

exceptionMessage: Request references a resource which does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

exceptionMessage: Request would cause a service quota to be exceeded.

HTTP Status Code: 402

ValidationException

exceptionMessage: The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400