Lists the streaming image resources in a studio.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
list-streaming-sessions
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: sessions
list-streaming-sessions
[--created-by <value>]
[--owned-by <value>]
[--session-ids <value>]
--studio-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
--created-by
(string)
The user ID of the user that created the streaming session.
--owned-by
(string)
The user ID of the user that owns the streaming session.
--session-ids
(string)
A collection of session IDs.
--studio-id
(string)
The studio ID.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command’s output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
nextToken -> (string)
The token for the next set of results, or null if there are no more results.
sessions -> (list)
A collection of streaming sessions.
(structure)
arn -> (string)
The ARN of the resource.
createdAt -> (timestamp)
The Unix epoch timestamp in seconds for when the resource was created.
createdBy -> (string)
The user ID of the user that created the streaming session.
ec2InstanceType -> (string)
The EC2 Instance type used for the streaming session.
launchProfileId -> (string)
The ID of the launch profile used to control access from the streaming session.
ownedBy -> (string)
The user ID of the user that owns the streaming session.
sessionId -> (string)
The session ID.
state -> (string)
The current state.
statusCode -> (string)
The status code.
statusMessage -> (string)
The status message for the streaming session.
streamingImageId -> (string)
The ID of the streaming image.
tags -> (map)
A collection of labels, in the form of key:value pairs, that apply to this resource.
key -> (string)
value -> (string)
terminateAt -> (timestamp)
The time the streaming session will automatically terminate if not terminated by the user.
updatedAt -> (timestamp)
The Unix epoch timestamp in seconds for when the resource was updated.
updatedBy -> (string)
The user ID of the user that most recently updated the resource.