Class: AWS.IVSRealTime

var params = {
  stageArn: 'STRING_VALUE', /* required */
  attributes: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  },
  capabilities: [
    PUBLISH | SUBSCRIBE,
    /* more items */
  ],
  duration: 'NUMBER_VALUE',
  userId: 'STRING_VALUE'
};
ivsrealtime.createParticipantToken(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • stageArn — (String)

    ARN of the stage to which this token is scoped.

  • duration — (Integer)

    Duration (in minutes), after which the token expires. Default: 720 (12 hours).

  • userId — (String)

    Name that can be specified to help identify the token. 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.

  • attributes — (map<String>)

    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.

  • capabilities — (Array<String>)

    Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • participantToken — (map)

      The participant token that was created.

      • participantId — (String)

        Unique identifier for this participant token, assigned by IVS.

      • token — (String)

        The issued client token, encrypted.

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

      • attributes — (map<String>)

        Application-provided attributes to encode into the token and attach to a stage. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

      • duration — (Integer)

        Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).

      • capabilities — (Array<String>)

        Set of capabilities that the user is allowed to perform in the stage.

      • expirationTime — (Date)

        ISO 8601 timestamp (returned as a string) for when this token expires.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  autoParticipantRecordingConfiguration: {
    storageConfigurationArn: 'STRING_VALUE', /* required */
    mediaTypes: [
      AUDIO_VIDEO | AUDIO_ONLY,
      /* more items */
    ]
  },
  name: 'STRING_VALUE',
  participantTokenConfigurations: [
    {
      attributes: {
        '<String>': 'STRING_VALUE',
        /* '<String>': ... */
      },
      capabilities: [
        PUBLISH | SUBSCRIBE,
        /* more items */
      ],
      duration: 'NUMBER_VALUE',
      userId: 'STRING_VALUE'
    },
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
ivsrealtime.createStage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

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

  • participantTokenConfigurations — (Array<map>)

    Array of participant token configuration objects to attach to the new stage.

    • duration — (Integer)

      Duration (in minutes), after which the corresponding participant token expires. Default: 720 (12 hours).

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

    • attributes — (map<String>)

      Application-provided attributes to encode into the corresponding participant 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.

    • capabilities — (Array<String>)

      Set of capabilities that the user is allowed to perform in the stage.

  • tags — (map<String>)

    Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.

  • autoParticipantRecordingConfiguration — (map)

    Configuration object for individual participant recording, to attach to the new stage.

    • storageConfigurationArn — required — (String)

      ARN of the StorageConfiguration resource to use for individual participant recording. Default: "" (empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a Stage is created or updated.

    • mediaTypes — (Array<String>)

      Types of media to be recorded. Default: AUDIO_VIDEO.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • stage — (map)

      The stage that was created.

      • arn — required — (String)

        Stage ARN.

      • name — (String)

        Stage name.

      • activeSessionId — (String)

        ID of the active session within the stage.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.

      • autoParticipantRecordingConfiguration — (map)

        Configuration object for individual participant recording, attached to the stage.

        • storageConfigurationArn — required — (String)

          ARN of the StorageConfiguration resource to use for individual participant recording. Default: "" (empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a Stage is created or updated.

        • mediaTypes — (Array<String>)

          Types of media to be recorded. Default: AUDIO_VIDEO.

      • endpoints — (map)

        Summary information about various endpoints for a stage.

        • events — (String)

          Events endpoint.

        • whip — (String)

          WHIP endpoint.

    • participantTokens — (Array<map>)

      Participant tokens attached to the stage. These correspond to the participants in the request.

      • participantId — (String)

        Unique identifier for this participant token, assigned by IVS.

      • token — (String)

        The issued client token, encrypted.

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

      • attributes — (map<String>)

        Application-provided attributes to encode into the token and attach to a stage. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

      • duration — (Integer)

        Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).

      • capabilities — (Array<String>)

        Set of capabilities that the user is allowed to perform in the stage.

      • expirationTime — (Date)

        ISO 8601 timestamp (returned as a string) for when this token expires.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  s3: { /* required */
    bucketName: 'STRING_VALUE' /* required */
  },
  name: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
ivsrealtime.createStorageConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    Storage configuration name. The value does not need to be unique.

  • s3 — (map)

    A complex type that contains a storage configuration for where recorded video will be stored.

    • bucketName — required — (String)

      Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition.

  • tags — (map<String>)

    Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • storageConfiguration — (map)

      The StorageConfiguration that was created.

      • arn — required — (String)

        ARN of the storage configuration.

      • name — (String)

        Name of the storage configuration.

      • s3 — (map)

        An S3 destination configuration where recorded videos will be stored.

        • bucketName — required — (String)

          Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivsrealtime.deleteEncoderConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • arn — (String)

    ARN of the EncoderConfiguration.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivsrealtime.deletePublicKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • arn — (String)

    ARN of the public key to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivsrealtime.deleteStage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • arn — (String)

    ARN of the stage to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivsrealtime.deleteStorageConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • arn — (String)

    ARN of the storage configuration to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  participantId: 'STRING_VALUE', /* required */
  stageArn: 'STRING_VALUE', /* required */
  reason: 'STRING_VALUE'
};
ivsrealtime.disconnectParticipant(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • stageArn — (String)

    ARN of the stage to which the participant is attached.

  • participantId — (String)

    Identifier of the participant to be disconnected. This is assigned by IVS and returned by CreateParticipantToken.

  • reason — (String)

    Description of why this participant is being disconnected.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivsrealtime.getComposition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • arn — (String)

    ARN of the Composition resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • composition — (map)

      The Composition that was returned.

      • arn — required — (String)

        ARN of the Composition resource.

      • stageArn — required — (String)

        ARN of the stage used as input

      • state — required — (String)

        State of the Composition.

        Possible values include:
        • "STARTING"
        • "ACTIVE"
        • "STOPPING"
        • "FAILED"
        • "STOPPED"
      • layout — required — (map)

        Layout object to configure composition parameters.

        • grid — (map)

          Configuration related to grid layout. Default: Grid layout.

          • featuredParticipantAttribute — (String)

            This attribute name identifies the featured slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot. Default: "" (no featured participant).

          • omitStoppedVideo — (Boolean)

            Determines whether to omit participants with stopped video in the composition. Default: false.

          • videoAspectRatio — (String)

            Sets the non-featured participant display mode, to control the aspect ratio of video tiles. VIDEO is 16:9, SQUARE is 1:1, and PORTRAIT is 3:4. Default: VIDEO.

            Possible values include:
            • "AUTO"
            • "VIDEO"
            • "SQUARE"
            • "PORTRAIT"
          • videoFillMode — (String)

            Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). When not set, videoFillMode defaults to COVER fill mode for participants in the grid and to CONTAIN fill mode for featured participants.

            Possible values include:
            • "FILL"
            • "COVER"
            • "CONTAIN"
          • gridGap — (Integer)

            Specifies the spacing between participant tiles in pixels. Default: 2.

        • pip — (map)

          Configuration related to PiP layout.

          • featuredParticipantAttribute — (String)

            This attribute name identifies the featured slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot. Default: "" (no featured participant).

          • omitStoppedVideo — (Boolean)

            Determines whether to omit participants with stopped video in the composition. Default: false.

          • videoFillMode — (String)

            Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). Default: COVER.

            Possible values include:
            • "FILL"
            • "COVER"
            • "CONTAIN"
          • gridGap — (Integer)

            Specifies the spacing between participant tiles in pixels. Default: 0.

          • pipParticipantAttribute — (String)

            Specifies the participant for the PiP window. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot. Default: "" (no PiP participant).

          • pipBehavior — (String)

            Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition). Default: STATIC.

            Possible values include:
            • "STATIC"
            • "DYNAMIC"
          • pipOffset — (Integer)

            Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition. Default: 0.

          • pipPosition — (String)

            Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.

            Possible values include:
            • "TOP_LEFT"
            • "TOP_RIGHT"
            • "BOTTOM_LEFT"
            • "BOTTOM_RIGHT"
          • pipWidth — (Integer)

            Specifies the width of the PiP window in pixels. When this is not set explicitly, pipWidth’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

          • pipHeight — (Integer)

            Specifies the height of the PiP window in pixels. When this is not set explicitly, pipHeight’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

      • destinations — required — (Array<map>)

        Array of Destination objects. A Composition can contain either one destination (channel or s3) or two (one channel and one s3).

        • id — required — (String)

          Unique identifier for this destination, assigned by IVS.

        • state — required — (String)

          State of the Composition Destination.

          Possible values include:
          • "STARTING"
          • "ACTIVE"
          • "STOPPING"
          • "RECONNECTING"
          • "FAILED"
          • "STOPPED"
        • startTime — (Date)

          UTC time of the destination start. This is an ISO 8601 timestamp; note that this is returned as a string.

        • endTime — (Date)

          UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.

        • configuration — required — (map)

          Configuration used to create this destination.

          • name — (String)

            Name that can be specified to help identify the destination.

          • channel — (map)

            An IVS channel to be used for broadcasting, for server-side composition. Either a channel or an s3 must be specified.

            • channelArn — required — (String)

              ARN of the channel to use for broadcasting. The channel and stage resources must be in the same AWS account and region. The channel must be offline (not broadcasting).

            • encoderConfigurationArn — (String)

              ARN of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.

          • s3 — (map)

            An S3 storage configuration to be used for recording video data. Either a channel or an s3 must be specified.

            • storageConfigurationArn — required — (String)

              ARN of the StorageConfiguration where recorded videos will be stored.

            • encoderConfigurationArns — required — (Array<String>)

              ARNs of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.

            • recordingConfiguration — (map)

              Array of maps, each of the form string:string (key:value). This is an optional customer specification, currently used only to specify the recording format for storing a recording in Amazon S3.

              • format — (String)

                The recording format for storing a recording in Amazon S3.

                Possible values include:
                • "HLS"
        • detail — (map)

          Optional details regarding the status of the destination.

          • s3 — (map)

            An S3 detail object to return information about the S3 destination.

            • recordingPrefix — required — (String)

              The S3 bucket prefix under which the recording is stored.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.

      • startTime — (Date)

        UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.

      • endTime — (Date)

        UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivsrealtime.getEncoderConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • arn — (String)

    ARN of the EncoderConfiguration resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • encoderConfiguration — (map)

      The EncoderConfiguration that was returned.

      • arn — required — (String)

        ARN of the EncoderConfiguration resource.

      • name — (String)

        Optional name to identify the resource.

      • video — (map)

        Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps

        • width — (Integer)

          Video-resolution width. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.

        • height — (Integer)

          Video-resolution height. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.

        • framerate — (Float)

          Video frame rate, in fps. Default: 30.

        • bitrate — (Integer)

          Bitrate for generated output, in bps. Default: 2500000.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  participantId: 'STRING_VALUE', /* required */
  sessionId: 'STRING_VALUE', /* required */
  stageArn: 'STRING_VALUE' /* required */
};
ivsrealtime.getParticipant(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • stageArn — (String)

    Stage ARN.

  • sessionId — (String)

    ID of a session within the stage.

  • participantId — (String)

    Unique identifier for the participant. This is assigned by IVS and returned by CreateParticipantToken.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • participant — (map)

      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.

        Possible values include:
        • "CONNECTED"
        • "DISCONNECTED"
      • firstJoinTime — (Date)

        ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.

      • attributes — (map<String>)

        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.

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

      • recordingState — (String)

        The participant’s recording state.

        Possible values include:
        • "STARTING"
        • "ACTIVE"
        • "STOPPING"
        • "STOPPED"
        • "FAILED"
        • "DISABLED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivsrealtime.getPublicKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • arn — (String)

    ARN of the public key for which the information is to be retrieved.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • publicKey — (map)

      The public key that is returned.

      • arn — (String)

        Public key ARN.

      • name — (String)

        Public key name.

      • publicKeyMaterial — (String)

        Public key material.

      • fingerprint — (String)

        The public key fingerprint, a short string used to identify or verify the full public key.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivsrealtime.getStage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • arn — (String)

    ARN of the stage for which the information is to be retrieved.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • stage — (map)

      The stage that is returned.

      • arn — required — (String)

        Stage ARN.

      • name — (String)

        Stage name.

      • activeSessionId — (String)

        ID of the active session within the stage.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.

      • autoParticipantRecordingConfiguration — (map)

        Configuration object for individual participant recording, attached to the stage.

        • storageConfigurationArn — required — (String)

          ARN of the StorageConfiguration resource to use for individual participant recording. Default: "" (empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a Stage is created or updated.

        • mediaTypes — (Array<String>)

          Types of media to be recorded. Default: AUDIO_VIDEO.

      • endpoints — (map)

        Summary information about various endpoints for a stage.

        • events — (String)

          Events endpoint.

        • whip — (String)

          WHIP endpoint.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  sessionId: 'STRING_VALUE', /* required */
  stageArn: 'STRING_VALUE' /* required */
};
ivsrealtime.getStageSession(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • stageArn — (String)

    ARN of the stage for which the information is to be retrieved.

  • sessionId — (String)

    ID of a session within the stage.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • stageSession — (map)

      The stage session that is returned.

      • sessionId — (String)

        ID of the session within the stage.

      • startTime — (Date)

        ISO 8601 timestamp (returned as a string) when this stage session began.

      • endTime — (Date)

        ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if the stage is active.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivsrealtime.getStorageConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • arn — (String)

    ARN of the storage configuration to be retrieved.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • storageConfiguration — (map)

      The StorageConfiguration that was returned.

      • arn — required — (String)

        ARN of the storage configuration.

      • name — (String)

        Name of the storage configuration.

      • s3 — (map)

        An S3 destination configuration where recorded videos will be stored.

        • bucketName — required — (String)

          Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  publicKeyMaterial: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
ivsrealtime.importPublicKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • publicKeyMaterial — (String)

    The content of the public key to be imported.

  • name — (String)

    Name of the public key to be imported.

  • tags — (map<String>)

    Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • publicKey — (map)

      The public key that was imported.

      • arn — (String)

        Public key ARN.

      • name — (String)

        Public key name.

      • publicKeyMaterial — (String)

        Public key material.

      • fingerprint — (String)

        The public key fingerprint, a short string used to identify or verify the full public key.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  filterByEncoderConfigurationArn: 'STRING_VALUE',
  filterByStageArn: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ivsrealtime.listCompositions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • filterByStageArn — (String)

    Filters the Composition list to match the specified Stage ARN.

  • filterByEncoderConfigurationArn — (String)

    Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.

  • nextToken — (String)

    The first Composition to retrieve. This is used for pagination; see the nextToken response field.

  • maxResults — (Integer)

    Maximum number of results to return. Default: 100.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • compositions — (Array<map>)

      List of the matching Compositions (summary information only).

      • arn — required — (String)

        ARN of the Composition resource.

      • stageArn — required — (String)

        ARN of the attached stage.

      • destinations — required — (Array<map>)

        Array of Destination objects.

        • id — required — (String)

          Unique identifier for this destination, assigned by IVS.

        • state — required — (String)

          State of the Composition Destination.

          Possible values include:
          • "STARTING"
          • "ACTIVE"
          • "STOPPING"
          • "RECONNECTING"
          • "FAILED"
          • "STOPPED"
        • startTime — (Date)

          UTC time of the destination start. This is an ISO 8601 timestamp; note that this is returned as a string.

        • endTime — (Date)

          UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.

      • state — required — (String)

        State of the Composition resource.

        Possible values include:
        • "STARTING"
        • "ACTIVE"
        • "STOPPING"
        • "FAILED"
        • "STOPPED"
      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.

      • startTime — (Date)

        UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.

      • endTime — (Date)

        UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.

    • nextToken — (String)

      If there are more compositions than maxResults, use nextToken in the request to get the next set.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ivsrealtime.listEncoderConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    The first encoder configuration to retrieve. This is used for pagination; see the nextToken response field.

  • maxResults — (Integer)

    Maximum number of results to return. Default: 100.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • encoderConfigurations — (Array<map>)

      List of the matching EncoderConfigurations (summary information only).

      • arn — required — (String)

        ARN of the EncoderConfiguration resource.

      • name — (String)

        Optional name to identify the resource.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.

    • nextToken — (String)

      If there are more encoder configurations than maxResults, use nextToken in the request to get the next set.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  participantId: 'STRING_VALUE', /* required */
  sessionId: 'STRING_VALUE', /* required */
  stageArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ivsrealtime.listParticipantEvents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • stageArn — (String)

    Stage ARN.

  • sessionId — (String)

    ID of a session within the stage.

  • participantId — (String)

    Unique identifier for this participant. This is assigned by IVS and returned by CreateParticipantToken.

  • nextToken — (String)

    The first participant event to retrieve. This is used for pagination; see the nextToken response field.

  • maxResults — (Integer)

    Maximum number of results to return. Default: 50.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • events — (Array<map>)

      List of the matching events.

      • name — (String)

        The name of the event.

        Possible values include:
        • "JOINED"
        • "LEFT"
        • "PUBLISH_STARTED"
        • "PUBLISH_STOPPED"
        • "SUBSCRIBE_STARTED"
        • "SUBSCRIBE_STOPPED"
        • "PUBLISH_ERROR"
        • "SUBSCRIBE_ERROR"
        • "JOIN_ERROR"
      • participantId — (String)

        Unique identifier for the participant who triggered the event. This is assigned by IVS.

      • eventTime — (Date)

        ISO 8601 timestamp (returned as a string) for when the event occurred.

      • remoteParticipantId — (String)

        Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.

      • errorCode — (String)

        If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null. INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the participant’s token is not allowed to do. For more information about participant capabilities, see the capabilities field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the number of participants who want to publish/subscribe to a stage exceeds the quota; for more information, see Service Quotas. PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a publisher that doesn’t exist.

        Possible values include:
        • "INSUFFICIENT_CAPABILITIES"
        • "QUOTA_EXCEEDED"
        • "PUBLISHER_NOT_FOUND"
    • nextToken — (String)

      If there are more events than maxResults, use nextToken in the request to get the next set.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  sessionId: 'STRING_VALUE', /* required */
  stageArn: 'STRING_VALUE', /* required */
  filterByPublished: true || false,
  filterByRecordingState: STARTING | ACTIVE | STOPPING | STOPPED | FAILED,
  filterByState: CONNECTED | DISCONNECTED,
  filterByUserId: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ivsrealtime.listParticipants(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • stageArn — (String)

    Stage ARN.

  • sessionId — (String)

    ID of the session within the stage.

  • filterByUserId — (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.

  • filterByPublished — (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.

  • filterByState — (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.

    Possible values include:
    • "CONNECTED"
    • "DISCONNECTED"
  • nextToken — (String)

    The first participant to retrieve. This is used for pagination; see the nextToken response field.

  • maxResults — (Integer)

    Maximum number of results to return. Default: 50.

  • filterByRecordingState — (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.

    Possible values include:
    • "STARTING"
    • "ACTIVE"
    • "STOPPING"
    • "STOPPED"
    • "FAILED"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • participants — (Array<map>)

      List of the matching participants (summary information only).

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

        Possible values include:
        • "CONNECTED"
        • "DISCONNECTED"
      • firstJoinTime — (Date)

        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.

        Possible values include:
        • "STARTING"
        • "ACTIVE"
        • "STOPPING"
        • "STOPPED"
        • "FAILED"
        • "DISABLED"
    • nextToken — (String)

      If there are more participants than maxResults, use nextToken in the request to get the next set.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ivsrealtime.listPublicKeys(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    The first public key to retrieve. This is used for pagination; see the nextToken response field.

  • maxResults — (Integer)

    Maximum number of results to return. Default: 50.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • publicKeys — (Array<map>)

      List of the matching public keys (summary information only).

      • arn — (String)

        Public key ARN.

      • name — (String)

        Public key name.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.

    • nextToken — (String)

      If there are more public keys than maxResults, use nextToken in the request to get the next set.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ivsrealtime.listStages(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    The first stage to retrieve. This is used for pagination; see the nextToken response field.

  • maxResults — (Integer)

    Maximum number of results to return. Default: 50.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • stages — (Array<map>)

      List of the matching stages (summary information only).

      • arn — required — (String)

        Stage ARN.

      • name — (String)

        Stage name.

      • activeSessionId — (String)

        ID of the active session within the stage.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.

    • nextToken — (String)

      If there are more stages than maxResults, use nextToken in the request to get the next set.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  stageArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ivsrealtime.listStageSessions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • stageArn — (String)

    Stage ARN.

  • nextToken — (String)

    The first stage session to retrieve. This is used for pagination; see the nextToken response field.

  • maxResults — (Integer)

    Maximum number of results to return. Default: 50.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • stageSessions — (Array<map>)

      List of matching stage sessions.

      • sessionId — (String)

        ID of the session within the stage.

      • startTime — (Date)

        ISO 8601 timestamp (returned as a string) when this stage session began.

      • endTime — (Date)

        ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if the stage is active.

    • nextToken — (String)

      If there are more stage sessions than maxResults, use nextToken in the request to get the next set.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ivsrealtime.listStorageConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    The first storage configuration to retrieve. This is used for pagination; see the nextToken response field.

  • maxResults — (Integer)

    Maximum number of storage configurations to return. Default: your service quota or 100, whichever is smaller.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • storageConfigurations — (Array<map>)

      List of the matching storage configurations.

      • arn — required — (String)

        ARN of the storage configuration.

      • name — (String)

        Name of the storage configuration.

      • s3 — (map)

        An S3 destination configuration where recorded videos will be stored.

        • bucketName — required — (String)

          Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.

    • nextToken — (String)

      If there are more storage configurations than maxResults, use nextToken in the request to get the next set.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
ivsrealtime.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The ARN of the resource to be retrieved. The ARN must be URL-encoded.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • tags — (map<String>)

      Tags attached to the resource. Array of maps, each of the form string:string (key:value).

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  destinations: [ /* required */
    {
      channel: {
        channelArn: 'STRING_VALUE', /* required */
        encoderConfigurationArn: 'STRING_VALUE'
      },
      name: 'STRING_VALUE',
      s3: {
        encoderConfigurationArns: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        storageConfigurationArn: 'STRING_VALUE', /* required */
        recordingConfiguration: {
          format: HLS
        }
      }
    },
    /* more items */
  ],
  stageArn: 'STRING_VALUE', /* required */
  idempotencyToken: 'STRING_VALUE',
  layout: {
    grid: {
      featuredParticipantAttribute: 'STRING_VALUE',
      gridGap: 'NUMBER_VALUE',
      omitStoppedVideo: true || false,
      videoAspectRatio: AUTO | VIDEO | SQUARE | PORTRAIT,
      videoFillMode: FILL | COVER | CONTAIN
    },
    pip: {
      featuredParticipantAttribute: 'STRING_VALUE',
      gridGap: 'NUMBER_VALUE',
      omitStoppedVideo: true || false,
      pipBehavior: STATIC | DYNAMIC,
      pipHeight: 'NUMBER_VALUE',
      pipOffset: 'NUMBER_VALUE',
      pipParticipantAttribute: 'STRING_VALUE',
      pipPosition: TOP_LEFT | TOP_RIGHT | BOTTOM_LEFT | BOTTOM_RIGHT,
      pipWidth: 'NUMBER_VALUE',
      videoFillMode: FILL | COVER | CONTAIN
    }
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
ivsrealtime.startComposition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • stageArn — (String)

    ARN of the stage to be used for compositing.

  • idempotencyToken — (String)

    Idempotency token.

    If a token is not provided, the SDK will use a version 4 UUID.
  • layout — (map)

    Layout object to configure composition parameters.

    • grid — (map)

      Configuration related to grid layout. Default: Grid layout.

      • featuredParticipantAttribute — (String)

        This attribute name identifies the featured slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot. Default: "" (no featured participant).

      • omitStoppedVideo — (Boolean)

        Determines whether to omit participants with stopped video in the composition. Default: false.

      • videoAspectRatio — (String)

        Sets the non-featured participant display mode, to control the aspect ratio of video tiles. VIDEO is 16:9, SQUARE is 1:1, and PORTRAIT is 3:4. Default: VIDEO.

        Possible values include:
        • "AUTO"
        • "VIDEO"
        • "SQUARE"
        • "PORTRAIT"
      • videoFillMode — (String)

        Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). When not set, videoFillMode defaults to COVER fill mode for participants in the grid and to CONTAIN fill mode for featured participants.

        Possible values include:
        • "FILL"
        • "COVER"
        • "CONTAIN"
      • gridGap — (Integer)

        Specifies the spacing between participant tiles in pixels. Default: 2.

    • pip — (map)

      Configuration related to PiP layout.

      • featuredParticipantAttribute — (String)

        This attribute name identifies the featured slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot. Default: "" (no featured participant).

      • omitStoppedVideo — (Boolean)

        Determines whether to omit participants with stopped video in the composition. Default: false.

      • videoFillMode — (String)

        Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). Default: COVER.

        Possible values include:
        • "FILL"
        • "COVER"
        • "CONTAIN"
      • gridGap — (Integer)

        Specifies the spacing between participant tiles in pixels. Default: 0.

      • pipParticipantAttribute — (String)

        Specifies the participant for the PiP window. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot. Default: "" (no PiP participant).

      • pipBehavior — (String)

        Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition). Default: STATIC.

        Possible values include:
        • "STATIC"
        • "DYNAMIC"
      • pipOffset — (Integer)

        Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition. Default: 0.

      • pipPosition — (String)

        Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.

        Possible values include:
        • "TOP_LEFT"
        • "TOP_RIGHT"
        • "BOTTOM_LEFT"
        • "BOTTOM_RIGHT"
      • pipWidth — (Integer)

        Specifies the width of the PiP window in pixels. When this is not set explicitly, pipWidth’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

      • pipHeight — (Integer)

        Specifies the height of the PiP window in pixels. When this is not set explicitly, pipHeight’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

  • destinations — (Array<map>)

    Array of destination configuration.

    • name — (String)

      Name that can be specified to help identify the destination.

    • channel — (map)

      An IVS channel to be used for broadcasting, for server-side composition. Either a channel or an s3 must be specified.

      • channelArn — required — (String)

        ARN of the channel to use for broadcasting. The channel and stage resources must be in the same AWS account and region. The channel must be offline (not broadcasting).

      • encoderConfigurationArn — (String)

        ARN of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.

    • s3 — (map)

      An S3 storage configuration to be used for recording video data. Either a channel or an s3 must be specified.

      • storageConfigurationArn — required — (String)

        ARN of the StorageConfiguration where recorded videos will be stored.

      • encoderConfigurationArns — required — (Array<String>)

        ARNs of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.

      • recordingConfiguration — (map)

        Array of maps, each of the form string:string (key:value). This is an optional customer specification, currently used only to specify the recording format for storing a recording in Amazon S3.

        • format — (String)

          The recording format for storing a recording in Amazon S3.

          Possible values include:
          • "HLS"
  • tags — (map<String>)

    Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • composition — (map)

      The Composition that was created.

      • arn — required — (String)

        ARN of the Composition resource.

      • stageArn — required — (String)

        ARN of the stage used as input

      • state — required — (String)

        State of the Composition.

        Possible values include:
        • "STARTING"
        • "ACTIVE"
        • "STOPPING"
        • "FAILED"
        • "STOPPED"
      • layout — required — (map)

        Layout object to configure composition parameters.

        • grid — (map)

          Configuration related to grid layout. Default: Grid layout.

          • featuredParticipantAttribute — (String)

            This attribute name identifies the featured slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot. Default: "" (no featured participant).

          • omitStoppedVideo — (Boolean)

            Determines whether to omit participants with stopped video in the composition. Default: false.

          • videoAspectRatio — (String)

            Sets the non-featured participant display mode, to control the aspect ratio of video tiles. VIDEO is 16:9, SQUARE is 1:1, and PORTRAIT is 3:4. Default: VIDEO.

            Possible values include:
            • "AUTO"
            • "VIDEO"
            • "SQUARE"
            • "PORTRAIT"
          • videoFillMode — (String)

            Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). When not set, videoFillMode defaults to COVER fill mode for participants in the grid and to CONTAIN fill mode for featured participants.

            Possible values include:
            • "FILL"
            • "COVER"
            • "CONTAIN"
          • gridGap — (Integer)

            Specifies the spacing between participant tiles in pixels. Default: 2.

        • pip — (map)

          Configuration related to PiP layout.

          • featuredParticipantAttribute — (String)

            This attribute name identifies the featured slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot. Default: "" (no featured participant).

          • omitStoppedVideo — (Boolean)

            Determines whether to omit participants with stopped video in the composition. Default: false.

          • videoFillMode — (String)

            Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). Default: COVER.

            Possible values include:
            • "FILL"
            • "COVER"
            • "CONTAIN"
          • gridGap — (Integer)

            Specifies the spacing between participant tiles in pixels. Default: 0.

          • pipParticipantAttribute — (String)

            Specifies the participant for the PiP window. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot. Default: "" (no PiP participant).

          • pipBehavior — (String)

            Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition). Default: STATIC.

            Possible values include:
            • "STATIC"
            • "DYNAMIC"
          • pipOffset — (Integer)

            Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition. Default: 0.

          • pipPosition — (String)

            Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.

            Possible values include:
            • "TOP_LEFT"
            • "TOP_RIGHT"
            • "BOTTOM_LEFT"
            • "BOTTOM_RIGHT"
          • pipWidth — (Integer)

            Specifies the width of the PiP window in pixels. When this is not set explicitly, pipWidth’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

          • pipHeight — (Integer)

            Specifies the height of the PiP window in pixels. When this is not set explicitly, pipHeight’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

      • destinations — required — (Array<map>)

        Array of Destination objects. A Composition can contain either one destination (channel or s3) or two (one channel and one s3).

        • id — required — (String)

          Unique identifier for this destination, assigned by IVS.

        • state — required — (String)

          State of the Composition Destination.

          Possible values include:
          • "STARTING"
          • "ACTIVE"
          • "STOPPING"
          • "RECONNECTING"
          • "FAILED"
          • "STOPPED"
        • startTime — (Date)

          UTC time of the destination start. This is an ISO 8601 timestamp; note that this is returned as a string.

        • endTime — (Date)

          UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.

        • configuration — required — (map)

          Configuration used to create this destination.

          • name — (String)

            Name that can be specified to help identify the destination.

          • channel — (map)

            An IVS channel to be used for broadcasting, for server-side composition. Either a channel or an s3 must be specified.

            • channelArn — required — (String)

              ARN of the channel to use for broadcasting. The channel and stage resources must be in the same AWS account and region. The channel must be offline (not broadcasting).

            • encoderConfigurationArn — (String)

              ARN of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.

          • s3 — (map)

            An S3 storage configuration to be used for recording video data. Either a channel or an s3 must be specified.

            • storageConfigurationArn — required — (String)

              ARN of the StorageConfiguration where recorded videos will be stored.

            • encoderConfigurationArns — required — (Array<String>)

              ARNs of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.

            • recordingConfiguration — (map)

              Array of maps, each of the form string:string (key:value). This is an optional customer specification, currently used only to specify the recording format for storing a recording in Amazon S3.

              • format — (String)

                The recording format for storing a recording in Amazon S3.

                Possible values include:
                • "HLS"
        • detail — (map)

          Optional details regarding the status of the destination.

          • s3 — (map)

            An S3 detail object to return information about the S3 destination.

            • recordingPrefix — required — (String)

              The S3 bucket prefix under which the recording is stored.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.

      • startTime — (Date)

        UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.

      • endTime — (Date)

        UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivsrealtime.stopComposition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • arn — (String)

    ARN of the Composition.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
ivsrealtime.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The ARN of the resource to be tagged. The ARN must be URL-encoded.

  • tags — (map<String>)

    Array of tags to be added or updated. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints beyond what is documented there.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
ivsrealtime.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The ARN of the resource to be untagged. The ARN must be URL-encoded.

  • tagKeys — (Array<String>)

    Array of tags to be removed. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints beyond what is documented there.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  arn: 'STRING_VALUE', /* required */
  autoParticipantRecordingConfiguration: {
    storageConfigurationArn: 'STRING_VALUE', /* required */
    mediaTypes: [
      AUDIO_VIDEO | AUDIO_ONLY,
      /* more items */
    ]
  },
  name: 'STRING_VALUE'
};
ivsrealtime.updateStage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • arn — (String)

    ARN of the stage to be updated.

  • name — (String)

    Name of the stage to be updated.

  • autoParticipantRecordingConfiguration — (map)

    Configuration object for individual participant recording, to attach to the stage. Note that this cannot be updated while recording is active.

    • storageConfigurationArn — required — (String)

      ARN of the StorageConfiguration resource to use for individual participant recording. Default: "" (empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a Stage is created or updated.

    • mediaTypes — (Array<String>)

      Types of media to be recorded. Default: AUDIO_VIDEO.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • stage — (map)

      The updated stage.

      • arn — required — (String)

        Stage ARN.

      • name — (String)

        Stage name.

      • activeSessionId — (String)

        ID of the active session within the stage.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.

      • autoParticipantRecordingConfiguration — (map)

        Configuration object for individual participant recording, attached to the stage.

        • storageConfigurationArn — required — (String)

          ARN of the StorageConfiguration resource to use for individual participant recording. Default: "" (empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a Stage is created or updated.

        • mediaTypes — (Array<String>)

          Types of media to be recorded. Default: AUDIO_VIDEO.

      • endpoints — (map)

        Summary information about various endpoints for a stage.

        • events — (String)

          Events endpoint.

        • whip — (String)

          WHIP endpoint.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Parameters:

• state (String) —

  the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

• params (map) (defaults to: {}) —

  a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

• function(err, data) { ... }

  Callback containing error and data information. See the respective resource state for the expected error or data information.

  If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.