get_stream_group `async` ¶

get_stream_group(
    identifier: Identifier,
    *,
    config_overrides: Optional[AsyncGameLiftStreamsClientConfig] = None,
) -> GetStreamGroupOutput

Retrieves properties for a Amazon GameLift Streams stream group resource. Specify the ID of the stream group that you want to retrieve. If the operation is successful, it returns properties for the requested stream group.

Parameters:

identifier (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.

Raises:

AccessDeniedException –

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

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

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

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

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

The service returned an error code this client does not model.

Source code in docs_src/capo_gameliftstreams/_services/async_game_lift_streams.py

async def get_stream_group(
    self,
    identifier: "capo_gameliftstreams.types.identifier.Identifier",
    *,
    config_overrides: Optional[AsyncGameLiftStreamsClientConfig] = None,
) -> "capo_gameliftstreams.types.get_stream_group_output.GetStreamGroupOutput":
    """<p>Retrieves properties for a Amazon GameLift Streams stream group resource. Specify the ID of the stream group that you want to retrieve. If the operation is successful, it returns properties for the requested stream group.</p>

    Args:
        identifier: <p>An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</code>. Example ID: <code>sg-1AB2C3De4</code>. </p>

    Raises:
        capo_gameliftstreams.errors.access_denied_exception.AccessDeniedException: <p>You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.</p>
        capo_gameliftstreams.errors.internal_server_exception.InternalServerException: <p>The service encountered an internal error and is unable to complete the request.</p>
        capo_gameliftstreams.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource specified in the request was not found. Correct the request before you try again.</p>
        capo_gameliftstreams.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. Retry the request after the suggested wait time.</p>
        capo_gameliftstreams.errors.validation_exception.ValidationException: <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.</p>
        capo_gameliftstreams.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_gameliftstreams.types.get_stream_group_input.GetStreamGroupInput]",
    ) -> AsyncOperationResponse[
        "capo_gameliftstreams.types.get_stream_group_output.GetStreamGroupOutput"
    ]:
        import capo_gameliftstreams._operations.game_lift_streams.get_stream_group

        (
            output,
            http_response,
        ) = await capo_gameliftstreams._operations.game_lift_streams.get_stream_group.async_get_stream_group(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetStreamGroup")
    )
    input_: capo_gameliftstreams.types.get_stream_group_input.GetStreamGroupInput = {
        "identifier": identifier
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_stream_group async ¶

get_stream_group `async` ¶