reset_deployments `async` ¶

reset_deployments(
    group_id: __string,
    *,
    config_overrides: Optional[AsyncGreengrassClientConfig] = None,
    amzn_client_token: Optional[__string] = None,
    force: Optional[__boolean] = None,
) -> ResetDeploymentsResponse

Resets a group's deployments.

Parameters:

amzn_client_token (Optional[__string], default: None ) –

A client token used to correlate requests and responses.
force (Optional[__boolean], default: None ) –

If true, performs a best-effort only core reset.
group_id (__string) –

The ID of the Greengrass group.

Raises:

BadRequestException –

General error information.
UnknownServiceError –

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

Source code in docs_src/capo_greengrass/_services/async_greengrass.py

async def reset_deployments(
    self,
    group_id: "capo_greengrass.types.__string.__string",
    *,
    config_overrides: Optional[AsyncGreengrassClientConfig] = None,
    amzn_client_token: Optional["capo_greengrass.types.__string.__string"] = None,
    force: Optional["capo_greengrass.types.__boolean.__boolean"] = None,
) -> "capo_greengrass.types.reset_deployments_response.ResetDeploymentsResponse":
    """Resets a group's deployments.

    Args:
        amzn_client_token: A client token used to correlate requests and responses.
        force: If true, performs a best-effort only core reset.
        group_id: The ID of the Greengrass group.

    Raises:
        capo_greengrass.errors.bad_request_exception.BadRequestException: General error information.
        capo_greengrass.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_greengrass.types.reset_deployments_request.ResetDeploymentsRequest]",
    ) -> AsyncOperationResponse[
        "capo_greengrass.types.reset_deployments_response.ResetDeploymentsResponse"
    ]:
        import capo_greengrass._operations.greengrass.reset_deployments

        (
            output,
            http_response,
        ) = await capo_greengrass._operations.greengrass.reset_deployments.async_reset_deployments(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ResetDeployments")
    )
    input_: capo_greengrass.types.reset_deployments_request.ResetDeploymentsRequest = {
        "group_id": group_id
    }
    if amzn_client_token is not None:
        input_["amzn_client_token"] = amzn_client_token
    if force is not None:
        input_["force"] = force

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

reset_deployments async ¶

reset_deployments `async` ¶