ListStreamGroups
Retrieves a list of all Amazon GameLift Streams stream groups that are associated with the AWS account in use. This operation returns stream groups in all statuses, in no particular order. You can paginate the results as needed.
Request Syntax
GET /streamgroups?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- MaxResults
-
The number of results to return. Use this parameter with
NextTokento return results in sequential pages. Default value is25.Valid Range: Minimum value of 1. Maximum value of 100.
- NextToken
-
A 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.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Items": [
{
"Arn": "string",
"CreatedAt": number,
"DefaultApplication": {
"Arn": "string",
"Id": "string"
},
"Description": "string",
"Id": "string",
"LastUpdatedAt": number,
"Status": "string",
"StreamClass": "string"
}
],
"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 Amazon GameLift Streams stream groups that are associated with the AWS account in use. Each item includes stream group metadata and status, but doesn't include capacity information.
Type: Array of StreamGroupSummary 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 Errors.
- AccessDeniedException
-
You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.
HTTP Status Code: 403
- InternalServerException
-
The service encountered an internal error and is unable to complete the request.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to request throttling. Retry the request after the suggested wait time.
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.
HTTP Status Code: 400
Examples
CLI Example
The following example shows how to use the AWS CLI to retrieve a complete list of stream groups. Because the request doesn't
include a MaxResults or a NextToken, the request returns the first 25 results in the list.
Sample Request
aws gameliftstreams list-stream-groupsSee Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
