2026/04/08 - Amazon Interactive Video Service RealTime - 6 updated api methods
Changes Adds support for Amazon IVS real-time streaming redundant ingest.
{'redundantIngest': 'boolean'}
Response {'ingestConfiguration': {'redundantIngest': 'boolean',
'redundantIngestCredentials': [{'participantId': 'string',
'streamKey': 'string'}]}}
Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.
See also: AWS API Documentation
Request Syntax
client.create_ingest_configuration(
name='string',
stageArn='string',
userId='string',
attributes={
'string': 'string'
},
ingestProtocol='RTMP'|'RTMPS',
insecureIngest=True|False,
redundantIngest=True|False,
tags={
'string': 'string'
}
)
string
Optional name that can be specified for the IngestConfiguration being created.
string
ARN of the stage with which the IngestConfiguration is associated.
string
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.
dict
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.
(string) --
(string) --
string
[REQUIRED]
Type of ingest protocol that the user employs to broadcast. If this is set to RTMP, insecureIngest must be set to true.
boolean
Whether the stage allows insecure RTMP ingest. This must be set to true, if ingestProtocol is set to RTMP. Default: false.
boolean
Indicates whether redundant ingest is enabled for the ingest configuration. Default: false.
dict
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.
(string) --
(string) --
dict
Response Syntax
{
'ingestConfiguration': {
'name': 'string',
'arn': 'string',
'ingestProtocol': 'RTMP'|'RTMPS',
'streamKey': 'string',
'stageArn': 'string',
'participantId': 'string',
'state': 'ACTIVE'|'INACTIVE',
'userId': 'string',
'redundantIngest': True|False,
'redundantIngestCredentials': [
{
'participantId': 'string',
'streamKey': 'string'
},
],
'attributes': {
'string': 'string'
},
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
ingestConfiguration (dict) --
The IngestConfiguration that was created.
name (string) --
Ingest name
arn (string) --
Ingest configuration ARN.
ingestProtocol (string) --
Type of ingest protocol that the user employs for broadcasting.
streamKey (string) --
Ingest-key value for the RTMP(S) protocol.
stageArn (string) --
ARN of the stage with which the IngestConfiguration is associated.
participantId (string) --
ID of the participant within the stage.
state (string) --
State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration.
userId (string) --
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.
redundantIngest (boolean) --
Indicates whether redundant ingest is enabled for the ingest configuration.
redundantIngestCredentials (list) --
A list of redundant ingest credentials, present only when redundantIngest is set to true. See Redundant Ingest in IVS RTMP Publishing for details.
(dict) --
An object representing a redundant ingest credential.
participantId (string) --
ID of the participant within the stage.
streamKey (string) --
Ingest-key value.
attributes (dict) --
Application-provided attributes to 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.
(string) --
(string) --
tags (dict) --
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.
(string) --
(string) --
{'ingestConfiguration': {'redundantIngest': 'boolean',
'redundantIngestCredentials': [{'participantId': 'string',
'streamKey': 'string'}]}}
Gets information about the specified IngestConfiguration.
See also: AWS API Documentation
Request Syntax
client.get_ingest_configuration(
arn='string'
)
string
[REQUIRED]
ARN of the ingest for which the information is to be retrieved.
dict
Response Syntax
{
'ingestConfiguration': {
'name': 'string',
'arn': 'string',
'ingestProtocol': 'RTMP'|'RTMPS',
'streamKey': 'string',
'stageArn': 'string',
'participantId': 'string',
'state': 'ACTIVE'|'INACTIVE',
'userId': 'string',
'redundantIngest': True|False,
'redundantIngestCredentials': [
{
'participantId': 'string',
'streamKey': 'string'
},
],
'attributes': {
'string': 'string'
},
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
ingestConfiguration (dict) --
The IngestConfiguration that was returned.
name (string) --
Ingest name
arn (string) --
Ingest configuration ARN.
ingestProtocol (string) --
Type of ingest protocol that the user employs for broadcasting.
streamKey (string) --
Ingest-key value for the RTMP(S) protocol.
stageArn (string) --
ARN of the stage with which the IngestConfiguration is associated.
participantId (string) --
ID of the participant within the stage.
state (string) --
State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration.
userId (string) --
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.
redundantIngest (boolean) --
Indicates whether redundant ingest is enabled for the ingest configuration.
redundantIngestCredentials (list) --
A list of redundant ingest credentials, present only when redundantIngest is set to true. See Redundant Ingest in IVS RTMP Publishing for details.
(dict) --
An object representing a redundant ingest credential.
participantId (string) --
ID of the participant within the stage.
streamKey (string) --
Ingest-key value.
attributes (dict) --
Application-provided attributes to 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.
(string) --
(string) --
tags (dict) --
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.
(string) --
(string) --
{'participant': {'ingestConfigurationArn': 'string',
'redundantIngest': 'boolean'}}
Gets information about the specified participant token.
See also: AWS API Documentation
Request Syntax
client.get_participant(
stageArn='string',
sessionId='string',
participantId='string'
)
string
[REQUIRED]
Stage ARN.
string
[REQUIRED]
ID of a session within the stage.
string
[REQUIRED]
Unique identifier for the participant. This is assigned by IVS and returned by CreateParticipantToken.
dict
Response Syntax
{
'participant': {
'participantId': 'string',
'userId': 'string',
'state': 'CONNECTED'|'DISCONNECTED',
'firstJoinTime': datetime(2015, 1, 1),
'attributes': {
'string': 'string'
},
'published': True|False,
'ispName': 'string',
'osName': 'string',
'osVersion': 'string',
'browserName': 'string',
'browserVersion': 'string',
'sdkVersion': 'string',
'recordingS3BucketName': 'string',
'recordingS3Prefix': 'string',
'recordingState': 'STARTING'|'ACTIVE'|'STOPPING'|'STOPPED'|'FAILED'|'DISABLED',
'protocol': 'UNKNOWN'|'WHIP'|'RTMP'|'RTMPS',
'replicationType': 'SOURCE'|'REPLICA'|'NONE',
'replicationState': 'ACTIVE'|'STOPPED',
'sourceStageArn': 'string',
'sourceSessionId': 'string',
'redundantIngest': True|False,
'ingestConfigurationArn': 'string'
}
}
Response Structure
(dict) --
participant (dict) --
The participant that is returned.
participantId (string) --
Unique identifier for this participant, assigned by IVS.
userId (string) --
Customer-assigned name to help identify the token; 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.
state (string) --
Whether the participant is connected to or disconnected from the stage.
firstJoinTime (datetime) --
ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
attributes (dict) --
Application-provided attributes to encode into the token 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.
(string) --
(string) --
published (boolean) --
Whether the participant ever published to the stage session.
ispName (string) --
The participant’s Internet Service Provider.
osName (string) --
The participant’s operating system.
osVersion (string) --
The participant’s operating system version.
browserName (string) --
The participant’s browser.
browserVersion (string) --
The participant’s browser version.
sdkVersion (string) --
The participant’s SDK version.
recordingS3BucketName (string) --
Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or "" (empty string), if recording is not enabled.
recordingS3Prefix (string) --
S3 prefix of the S3 bucket where the participant is being recorded, if individual participant recording is enabled, or "" (empty string), if recording is not enabled. If individual participant recording merge is enabled, and if a stage publisher disconnects from a stage and then reconnects, IVS tries to record to the same S3 prefix as the previous session. See Merge Fragmented Individual Participant Recordings.
recordingState (string) --
The participant’s recording state.
protocol (string) --
Type of ingest protocol that the participant employs for broadcasting.
replicationType (string) --
Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.
replicationState (string) --
The participant's replication state.
sourceStageArn (string) --
Source stage ARN from which this participant is replicated, if replicationType is REPLICA.
sourceSessionId (string) --
ID of the session within the source stage, if replicationType is REPLICA.
redundantIngest (boolean) --
Indicates whether redundant ingest is enabled for the participant.
ingestConfigurationArn (string) --
The participant’s ingest configuration.
{'ingestConfigurations': {'redundantIngest': 'boolean'}}
Lists all IngestConfigurations in your account, in the AWS region where the API request is processed.
See also: AWS API Documentation
Request Syntax
client.list_ingest_configurations(
filterByStageArn='string',
filterByState='ACTIVE'|'INACTIVE',
nextToken='string',
maxResults=123
)
string
Filters the response list to match the specified stage ARN. Only one filter (by stage ARN or by state) can be used at a time.
string
Filters the response list to match the specified state. Only one filter (by stage ARN or by state) can be used at a time.
string
The first IngestConfiguration to retrieve. This is used for pagination; see the nextToken response field.
integer
Maximum number of results to return. Default: 50.
dict
Response Syntax
{
'ingestConfigurations': [
{
'name': 'string',
'arn': 'string',
'ingestProtocol': 'RTMP'|'RTMPS',
'stageArn': 'string',
'participantId': 'string',
'state': 'ACTIVE'|'INACTIVE',
'userId': 'string',
'redundantIngest': True|False
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
ingestConfigurations (list) --
List of the matching ingest configurations (summary information only).
(dict) --
Summary information about an IngestConfiguration.
name (string) --
Ingest name.
arn (string) --
Ingest configuration ARN.
ingestProtocol (string) --
Type of ingest protocol that the user employs for broadcasting.
stageArn (string) --
ARN of the stage with which the IngestConfiguration is associated.
participantId (string) --
ID of the participant within the stage.
state (string) --
State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration.
userId (string) --
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.
redundantIngest (boolean) --
Indicates whether redundant ingest is enabled for the ingest configuration.
nextToken (string) --
If there are more IngestConfigurations than maxResults, use nextToken in the request to get the next set.
{'participants': {'ingestConfigurationArn': 'string',
'redundantIngest': 'boolean'}}
Lists all participants in a specified stage session.
See also: AWS API Documentation
Request Syntax
client.list_participants(
stageArn='string',
sessionId='string',
filterByUserId='string',
filterByPublished=True|False,
filterByState='CONNECTED'|'DISCONNECTED',
nextToken='string',
maxResults=123,
filterByRecordingState='STARTING'|'ACTIVE'|'STOPPING'|'STOPPED'|'FAILED'
)
string
[REQUIRED]
Stage ARN.
string
[REQUIRED]
ID of the session within the stage.
string
Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request. A userId is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.
boolean
Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
string
Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
string
The first participant to retrieve. This is used for pagination; see the nextToken response field.
integer
Maximum number of results to return. Default: 50.
string
Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
dict
Response Syntax
{
'participants': [
{
'participantId': 'string',
'userId': 'string',
'state': 'CONNECTED'|'DISCONNECTED',
'firstJoinTime': datetime(2015, 1, 1),
'published': True|False,
'recordingState': 'STARTING'|'ACTIVE'|'STOPPING'|'STOPPED'|'FAILED'|'DISABLED',
'replicationType': 'SOURCE'|'REPLICA'|'NONE',
'replicationState': 'ACTIVE'|'STOPPED',
'sourceStageArn': 'string',
'sourceSessionId': 'string',
'redundantIngest': True|False,
'ingestConfigurationArn': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
participants (list) --
List of the matching participants (summary information only).
(dict) --
Summary object describing a participant that has joined a stage.
participantId (string) --
Unique identifier for this participant, assigned by IVS.
userId (string) --
Customer-assigned name to help identify the token; 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.
state (string) --
Whether the participant is connected to or disconnected from the stage.
firstJoinTime (datetime) --
ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
published (boolean) --
Whether the participant ever published to the stage session.
recordingState (string) --
The participant’s recording state.
replicationType (string) --
Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.
replicationState (string) --
The participant's replication state.
sourceStageArn (string) --
Source stage ARN from which this participant is replicated, if replicationType is REPLICA.
sourceSessionId (string) --
ID of the session within the source stage, if replicationType is REPLICA.
redundantIngest (boolean) --
Indicates whether redundant ingest is enabled for the participant.
ingestConfigurationArn (string) --
The participant’s ingest configuration.
nextToken (string) --
If there are more participants than maxResults, use nextToken in the request to get the next set.
{'redundantIngest': 'boolean'}
Response {'ingestConfiguration': {'redundantIngest': 'boolean',
'redundantIngestCredentials': [{'participantId': 'string',
'streamKey': 'string'}]}}
Updates a specified IngestConfiguration. Only the stage ARN attached to the IngestConfiguration can be updated. An IngestConfiguration that is active cannot be updated.
See also: AWS API Documentation
Request Syntax
client.update_ingest_configuration(
arn='string',
stageArn='string',
redundantIngest=True|False
)
string
[REQUIRED]
ARN of the IngestConfiguration, for which the related stage ARN needs to be updated.
string
Stage ARN that needs to be updated.
boolean
Indicates whether redundant ingest is enabled for the ingest configuration. Default: false.
dict
Response Syntax
{
'ingestConfiguration': {
'name': 'string',
'arn': 'string',
'ingestProtocol': 'RTMP'|'RTMPS',
'streamKey': 'string',
'stageArn': 'string',
'participantId': 'string',
'state': 'ACTIVE'|'INACTIVE',
'userId': 'string',
'redundantIngest': True|False,
'redundantIngestCredentials': [
{
'participantId': 'string',
'streamKey': 'string'
},
],
'attributes': {
'string': 'string'
},
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
ingestConfiguration (dict) --
The updated IngestConfiguration.
name (string) --
Ingest name
arn (string) --
Ingest configuration ARN.
ingestProtocol (string) --
Type of ingest protocol that the user employs for broadcasting.
streamKey (string) --
Ingest-key value for the RTMP(S) protocol.
stageArn (string) --
ARN of the stage with which the IngestConfiguration is associated.
participantId (string) --
ID of the participant within the stage.
state (string) --
State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration.
userId (string) --
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.
redundantIngest (boolean) --
Indicates whether redundant ingest is enabled for the ingest configuration.
redundantIngestCredentials (list) --
A list of redundant ingest credentials, present only when redundantIngest is set to true. See Redundant Ingest in IVS RTMP Publishing for details.
(dict) --
An object representing a redundant ingest credential.
participantId (string) --
ID of the participant within the stage.
streamKey (string) --
Ingest-key value.
attributes (dict) --
Application-provided attributes to 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.
(string) --
(string) --
tags (dict) --
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.
(string) --
(string) --