Skip to content

describe_patch_group_state async

describe_patch_group_state(
    patch_group: PatchGroup, *, config_overrides: Optional[AsyncSSMClientConfig] = None
) -> DescribePatchGroupStateResult

Returns high-level aggregated patch compliance state information for a patch group.

Parameters:

  • patch_group (PatchGroup) –

    The name of the patch group whose patch snapshot should be retrieved.

Raises:

Source code in docs_src/capo_ssm/_services/async_ssm.py
async def describe_patch_group_state(
    self,
    patch_group: "capo_ssm.types.patch_group.PatchGroup",
    *,
    config_overrides: Optional[AsyncSSMClientConfig] = None,
) -> (
    "capo_ssm.types.describe_patch_group_state_result.DescribePatchGroupStateResult"
):
    """<p>Returns high-level aggregated patch compliance state information for a patch group.</p>

    Args:
        patch_group: <p>The name of the patch group whose patch snapshot should be retrieved.</p>

    Raises:
        capo_ssm.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</p>
        capo_ssm.errors.invalid_next_token.InvalidNextToken: <p>The specified token isn't valid.</p>
        capo_ssm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ssm.types.describe_patch_group_state_request.DescribePatchGroupStateRequest]",
    ) -> AsyncOperationResponse[
        "capo_ssm.types.describe_patch_group_state_result.DescribePatchGroupStateResult"
    ]:
        import capo_ssm._operations.amazon_ssm.describe_patch_group_state

        (
            output,
            http_response,
        ) = await capo_ssm._operations.amazon_ssm.describe_patch_group_state.async_describe_patch_group_state(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribePatchGroupState")
    )
    input_: capo_ssm.types.describe_patch_group_state_request.DescribePatchGroupStateRequest = {
        "patch_group": patch_group
    }

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