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

RevokeStreamUrl

Revokes a stream URL so that it can no longer start new stream sessions. By default, stream sessions that are already running continue until they end on their own. To also end running sessions, set RevocationMode to REVOKE_AND_TERMINATE_SESSIONS.

Revoking a stream URL is permanent. The status of the stream URL changes to REVOKED.

Request Syntax


POST /streamgroups/Identifier/streamurls/StreamUrlIdentifier/revoke HTTP/1.1
Content-type: application/json

{
   "RevocationMode": "string"
}

URI Request Parameters

The request uses the following URI parameters.

Identifier

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.

This is the stream group that owns the stream URL.

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

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

Required: Yes

StreamUrlIdentifier

The unique identifier of the stream URL to revoke. Specify a stream URL ID or Amazon Resource Name (ARN). Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamurl/sg-1AB2C3De4/su-1AB2C3De4. Example ID: su-1AB2C3De4.

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

RevocationMode

Controls what happens to running stream sessions when you revoke the stream URL. If you do not specify a value, the default is REVOKE_URL. Possible values include the following:

REVOKE_URL: Stops the stream URL from starting new stream sessions. Running sessions continue until they end.
REVOKE_AND_TERMINATE_SESSIONS: Stops new stream sessions and ends any running stream sessions.

Type: String

Valid Values: REVOKE_URL | REVOKE_AND_TERMINATE_SESSIONS

Required: No

Response Syntax


HTTP/1.1 204

Response Elements

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

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

ResourceNotFoundException

The resource specified in the request was not found. Correct the request before you try again.

Message: Description of the error.

HTTP Status Code: 404

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

Revoke a Stream URL (AWS CLI)

The following AWS CLI command revokes a stream URL.

Sample Request


aws gameliftstreams revoke-stream-url \
  --identifier sg-1AB2C3De4 \
  --stream-url-identifier su-1AB2C3De4