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

CreateIngestConfiguration

Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.

Request Syntax


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

{
   "attributes": { 
      "string" : "string" 
   },
   "ingestProtocol": "string",
   "insecureIngest": boolean,
   "name": "string",
   "stageArn": "string",
   "tags": { 
      "string" : "string" 
   },
   "userId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

attributes

Application-provided attributes to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

Type: String to string map

Required: No

ingestProtocol

Type of ingest protocol that the user employs to broadcast. If this is set to RTMP, insecureIngest must be set to true.

Type: String

Valid Values: RTMP | RTMPS

Required: Yes

insecureIngest

Whether the stage allows insecure RTMP ingest. This must be set to true, if ingestProtocol is set to RTMP. Default: false.

Type: Boolean

Required: No

name

Optional name that can be specified for the IngestConfiguration being created.

Type: String

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

Pattern: [a-zA-Z0-9-_]*

Required: No

stageArn

ARN of the stage with which the IngestConfiguration is associated.

Type: String

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

Pattern: ^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$

Required: No

tags

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

userId

Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

Type: String

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ingestConfiguration": { 
      "arn": "string",
      "attributes": { 
         "string" : "string" 
      },
      "ingestProtocol": "string",
      "name": "string",
      "participantId": "string",
      "stageArn": "string",
      "state": "string",
      "streamKey": "string",
      "tags": { 
         "string" : "string" 
      },
      "userId": "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.

ingestConfiguration

The IngestConfiguration that was created.

Type: IngestConfiguration object

Errors

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

AccessDeniedException

HTTP Status Code: 403

PendingVerification

HTTP Status Code: 403

ServiceQuotaExceededException

HTTP Status Code: 402

ValidationException

HTTP Status Code: 400