list_scripts `async` ¶

list_scripts(
    *,
    config_overrides: Optional[AsyncGameLiftClientConfig] = None,
    limit: Optional[PositiveInteger] = None,
    next_token: Optional[NonEmptyString] = None,
) -> ListScriptsOutput

This API works with the following fleet types: EC2

Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use.

Learn more

Amazon GameLift Servers Amazon GameLift Servers Realtime

Related actions

All APIs by task

Parameters:

limit (Optional[PositiveInteger], default: None ) –

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
next_token (Optional[NonEmptyString], default: None ) –

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

Raises:

InternalServiceException –

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
InvalidRequestException –

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
UnauthorizedException –

The client failed authentication. Clients should not retry such requests.
UnknownServiceError –

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

Source code in docs_src/capo_gamelift/_services/async_game_lift.py

async def list_scripts(
    self,
    *,
    config_overrides: Optional[AsyncGameLiftClientConfig] = None,
    limit: Optional["capo_gamelift.types.positive_integer.PositiveInteger"] = None,
    next_token: Optional[
        "capo_gamelift.types.non_empty_string.NonEmptyString"
    ] = None,
) -> "capo_gamelift.types.list_scripts_output.ListScriptsOutput":
    """<p> <b>This API works with the following fleet types:</b> EC2</p> <p>Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use. </p> <p> <b>Learn more</b> </p> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Servers Amazon GameLift Servers Realtime</a> </p> <p> <b>Related actions</b> </p> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>

    Args:
        limit: <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
        next_token: <p>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.</p>

    Raises:
        capo_gamelift.errors.internal_service_exception.InternalServiceException: <p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.</p>
        capo_gamelift.errors.invalid_request_exception.InvalidRequestException: <p>One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.</p>
        capo_gamelift.errors.unauthorized_exception.UnauthorizedException: <p>The client failed authentication. Clients should not retry such requests.</p>
        capo_gamelift.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_gamelift.types.list_scripts_input.ListScriptsInput]",
    ) -> AsyncOperationResponse[
        "capo_gamelift.types.list_scripts_output.ListScriptsOutput"
    ]:
        import capo_gamelift._operations.game_lift.list_scripts

        (
            output,
            http_response,
        ) = await capo_gamelift._operations.game_lift.list_scripts.async_list_scripts(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListScripts")
    )
    input_: capo_gamelift.types.list_scripts_input.ListScriptsInput = {}
    if limit is not None:
        input_["limit"] = limit
    if next_token is not None:
        input_["next_token"] = next_token

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

list_scripts async ¶

list_scripts `async` ¶