AWS API Changes

2026/09/18 - Amazon Interactive Video Service RealTime - 2 updated api methods

Changes GetParticipant, ListParticipantEvents, ListParticipantReplicas, StartParticipantReplication, and StopParticipantReplication now accept participant IDs containing underscores.

CreateIngestConfiguration (updated)

Link ¶
Changes (response)

{'accessControlAllowOrigin': 'string',
 'accessControlExposeHeaders': 'string',
 'cacheControl': 'string',
 'contentSecurityPolicy': 'string',
 'strictTransportSecurity': 'string',
 'xContentTypeOptions': 'string',
 'xFrameOptions': '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'
    }
)

type name:

string

param name:

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

type stageArn:

string

param stageArn:

ARN of the stage with which the IngestConfiguration is associated.

type userId:

string

param 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 attributes:

dict

param 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.

(string) --
- (string) --

type ingestProtocol:

string

param ingestProtocol:

[REQUIRED]

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

type insecureIngest:

boolean

param insecureIngest:

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

type redundantIngest:

boolean

param redundantIngest:

Indicates whether redundant ingest is enabled for the ingest configuration. Default: false.

type tags:

dict

param 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.

(string) --
- (string) --

rtype:

dict

returns:

Response Syntax

{
    'accessControlAllowOrigin': 'string',
    'accessControlExposeHeaders': 'string',
    'cacheControl': 'string',
    'contentSecurityPolicy': 'string',
    'strictTransportSecurity': 'string',
    'xContentTypeOptions': 'string',
    'xFrameOptions': 'string',
    '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) --
- accessControlAllowOrigin (string) --
  
  See Access-Control-Allow-Origin in the MDN Web Docs.
- accessControlExposeHeaders (string) --
  
  See Access-Control-Expose-Headers in the MDN Web Docs.
- cacheControl (string) --
  
  See Cache-Control in the MDN Web Docs.
- contentSecurityPolicy (string) --
  
  See Content-Security-Policy in the MDN Web Docs.
- strictTransportSecurity (string) --
  
  See Strict-Transport-Security in the MDN Web Docs.
- xContentTypeOptions (string) --
  
  See X-Content-Type-Options in the MDN Web Docs.
- xFrameOptions (string) --
  
  See X-Frame-Options in the MDN Web Docs.
- 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) --

UpdateIngestConfiguration (updated)

Link ¶
Changes (response)

{'accessControlAllowOrigin': 'string',
 'accessControlExposeHeaders': 'string',
 'cacheControl': 'string',
 'contentSecurityPolicy': 'string',
 'strictTransportSecurity': 'string',
 'xContentTypeOptions': 'string',
 'xFrameOptions': '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
)

type arn:

string

param arn:

[REQUIRED]

ARN of the IngestConfiguration, for which the related stage ARN needs to be updated.

type stageArn:

string

param stageArn:

Stage ARN that needs to be updated.

type redundantIngest:

boolean

param redundantIngest:

Indicates whether redundant ingest is enabled for the ingest configuration. Default: false.

rtype:

dict

returns:

Response Syntax

{
    'accessControlAllowOrigin': 'string',
    'accessControlExposeHeaders': 'string',
    'cacheControl': 'string',
    'contentSecurityPolicy': 'string',
    'strictTransportSecurity': 'string',
    'xContentTypeOptions': 'string',
    'xFrameOptions': 'string',
    '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) --
- accessControlAllowOrigin (string) --
  
  See Access-Control-Allow-Origin in the MDN Web Docs.
- accessControlExposeHeaders (string) --
  
  See Access-Control-Expose-Headers in the MDN Web Docs.
- cacheControl (string) --
  
  See Cache-Control in the MDN Web Docs.
- contentSecurityPolicy (string) --
  
  See Content-Security-Policy in the MDN Web Docs.
- strictTransportSecurity (string) --
  
  See Strict-Transport-Security in the MDN Web Docs.
- xContentTypeOptions (string) --
  
  See X-Content-Type-Options in the MDN Web Docs.
- xFrameOptions (string) --
  
  See X-Frame-Options in the MDN Web Docs.
- 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) --