describe_patch_groups `async` ¶

describe_patch_groups(
    *,
    config_overrides: Optional[AsyncSSMClientConfig] = None,
    max_results: Optional[PatchBaselineMaxResults] = None,
    filters: Optional[PatchOrchestratorFilterList] = None,
    next_token: Optional[NextToken] = None,
) -> DescribePatchGroupsResult

Lists all patch groups that have been registered with patch baselines.

Parameters:

max_results (Optional[PatchBaselineMaxResults], default: None ) –

The maximum number of patch groups to return (per page).
filters (Optional[PatchOrchestratorFilterList], default: None ) –
Each element in the array is a structure containing a key-value pair.

Supported keys for DescribePatchGroups include the following:
- NAME_PREFIX
  
  Sample values: AWS- | My-.
- OPERATING_SYSTEM
  
  Sample values: AMAZON_LINUX | SUSE | WINDOWS
next_token (Optional[NextToken], default: None ) –

The token for the next set of items to return. (You received this token from a previous call.)

Raises:

InternalServerError –

An error occurred on the server side.
UnknownServiceError –

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

Source code in docs_src/capo_ssm/_services/async_ssm.py

async def describe_patch_groups(
    self,
    *,
    config_overrides: Optional[AsyncSSMClientConfig] = None,
    max_results: Optional[
        "capo_ssm.types.patch_baseline_max_results.PatchBaselineMaxResults"
    ] = None,
    filters: Optional[
        "capo_ssm.types.patch_orchestrator_filter_list.PatchOrchestratorFilterList"
    ] = None,
    next_token: Optional["capo_ssm.types.next_token.NextToken"] = None,
) -> "capo_ssm.types.describe_patch_groups_result.DescribePatchGroupsResult":
    """<p>Lists all patch groups that have been registered with patch baselines.</p>

    Args:
        max_results: <p>The maximum number of patch groups to return (per page).</p>
        filters: <p>Each element in the array is a structure containing a key-value pair.</p> <p>Supported keys for <code>DescribePatchGroups</code> include the following:</p> <ul> <li> <p> <b> <code>NAME_PREFIX</code> </b> </p> <p>Sample values: <code>AWS-</code> | <code>My-</code>.</p> </li> <li> <p> <b> <code>OPERATING_SYSTEM</code> </b> </p> <p>Sample values: <code>AMAZON_LINUX</code> | <code>SUSE</code> | <code>WINDOWS</code> </p> </li> </ul>
        next_token: <p>The token for the next set of items to return. (You received this token from a previous call.)</p>

    Raises:
        capo_ssm.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</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_groups_request.DescribePatchGroupsRequest]",
    ) -> AsyncOperationResponse[
        "capo_ssm.types.describe_patch_groups_result.DescribePatchGroupsResult"
    ]:
        import capo_ssm._operations.amazon_ssm.describe_patch_groups

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribePatchGroups")
    )
    input_: capo_ssm.types.describe_patch_groups_request.DescribePatchGroupsRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if filters is not None:
        input_["filters"] = filters
    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

describe_patch_groups async ¶

describe_patch_groups `async` ¶