List Streaming Sessions

nimblestudio_list_streaming_sessions

R Documentation

Lists the streaming sessions in a studio

Description

Lists the streaming sessions in a studio.

Usage

nimblestudio_list_streaming_sessions(createdBy, nextToken, ownedBy,
  sessionIds, studioId)

Arguments

createdBy

Filters the request to streaming sessions created by the given user.

nextToken

The token for the next set of results, or null if there are no more results.

ownedBy

Filters the request to streaming session owned by the given user

sessionIds

Filters the request to only the provided session IDs.

studioId

[required] The studio ID.

Value

A list with the following syntax:

list(
  nextToken = "string",
  sessions = list(
    list(
      arn = "string",
      automaticTerminationMode = "DEACTIVATED"|"ACTIVATED",
      backupMode = "AUTOMATIC"|"DEACTIVATED",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      createdBy = "string",
      ec2InstanceType = "string",
      launchProfileId = "string",
      maxBackupsToRetain = 123,
      ownedBy = "string",
      sessionId = "string",
      sessionPersistenceMode = "DEACTIVATED"|"ACTIVATED",
      startedAt = as.POSIXct(
        "2015-01-01"
      ),
      startedBy = "string",
      startedFromBackupId = "string",
      state = "CREATE_IN_PROGRESS"|"DELETE_IN_PROGRESS"|"READY"|"DELETED"|"CREATE_FAILED"|"DELETE_FAILED"|"STOP_IN_PROGRESS"|"START_IN_PROGRESS"|"STOPPED"|"STOP_FAILED"|"START_FAILED",
      statusCode = "STREAMING_SESSION_READY"|"STREAMING_SESSION_DELETED"|"STREAMING_SESSION_CREATE_IN_PROGRESS"|"STREAMING_SESSION_DELETE_IN_PROGRESS"|"INTERNAL_ERROR"|"INSUFFICIENT_CAPACITY"|"ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR"|"NETWORK_CONNECTION_ERROR"|"INITIALIZATION_SCRIPT_ERROR"|"DECRYPT_STREAMING_IMAGE_ERROR"|"NETWORK_INTERFACE_ERROR"|"STREAMING_SESSION_STOPPED"|"STREAMING_SESSION_STARTED"|"STREAMING_SESSION_STOP_IN_PROGRESS"|"STREAMING_SESSION_START_IN_PROGRESS"|"AMI_VALIDATION_ERROR",
      statusMessage = "string",
      stopAt = as.POSIXct(
        "2015-01-01"
      ),
      stoppedAt = as.POSIXct(
        "2015-01-01"
      ),
      stoppedBy = "string",
      streamingImageId = "string",
      tags = list(
        "string"
      ),
      terminateAt = as.POSIXct(
        "2015-01-01"
      ),
      updatedAt = as.POSIXct(
        "2015-01-01"
      ),
      updatedBy = "string",
      volumeConfiguration = list(
        iops = 123,
        size = 123,
        throughput = 123
      ),
      volumeRetentionMode = "RETAIN"|"DELETE"
    )
  )
)

Request syntax

svc$list_streaming_sessions(
  createdBy = "string",
  nextToken = "string",
  ownedBy = "string",
  sessionIds = "string",
  studioId = "string"
)