Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

ListStreamUrls

Retrieves a list of the stream URLs in the current AWS Region for your AWS account. You can filter the results by status or by stream group. Use the pagination parameters to retrieve results as a set of sequential pages. If you delete the stream group or application that backs a stream URL, this operation updates that stream URL's status to REVOKED.

Request Syntax


GET /streamurls?MaxResults=MaxResults&NextToken=NextToken&Status=Status&StreamGroupIdentifier=StreamGroupIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of results to return per page. Valid values are 1-100. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

The token that marks the start of the next set of results. Use this token when you retrieve results as sequential pages. To get the first page of results, omit a token value. To get the remaining pages, provide the token returned with the previous result set.

Status

Filters the list to stream URLs with the specified status.

ACTIVE: The stream URL is valid and can start stream sessions.
EXPIRED: The stream URL has passed its expiration time and can no longer start stream sessions.
REVOKED: The stream URL was revoked and can no longer start stream sessions.
LIMIT_REACHED: The stream URL has been used the maximum number of times and can no longer start stream sessions.

Valid Values: ACTIVE | EXPIRED | REVOKED | LIMIT_REACHED

StreamGroupIdentifier

Filters the list to stream URLs that belong to the specified stream group.

This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: (^[a-zA-Z0-9-]+$)|(^arn:aws:gameliftstreams:([^: ]*):([0-9]{12}):([^: ]*)$)

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "ApplicationArn": "string",
         "Arn": "string",
         "CreatedAt": number,
         "Description": "string",
         "ExpiresAt": number,
         "RemainingUses": number,
         "SessionLengthSeconds": number,
         "Status": "string",
         "StatusReason": "string",
         "StreamGroupArn": "string",
         "StreamUrl": "string",
         "StreamUrlId": "string",
         "UsageLimit": number
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Items

A collection of stream URL summaries. Each summary includes the identity, status, and usage of the stream URL, but not its full configuration.

Type: Array of StreamUrlSummary objects

NextToken

A token that marks the start of the next sequential page of results. If an operation doesn't return a token, you've reached the end of the list.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.

Message: Description of the error.

HTTP Status Code: 403

InternalServerException

The service encountered an internal error and is unable to complete the request.

Message: Description of the error.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling. Retry the request after the suggested wait time.

Message: Description of the error.

HTTP Status Code: 429

ValidationException

One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.

Message: Description of the error.

HTTP Status Code: 400

Examples

List Stream URLs (AWS CLI)

The following AWS CLI command lists the stream URLs in the current AWS Region.

Sample Request


aws gameliftstreams list-stream-urls