list_nodes ¶

def list_nodes(
    self,
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    sync_name: Optional[
        "capo_ssm.types.resource_data_sync_name.ResourceDataSyncName"
    ] = None,
    filters: Optional["capo_ssm.types.node_filter_list.NodeFilterList"] = None,
    next_token: Optional["capo_ssm.types.next_token.NextToken"] = None,
    max_results: Optional["capo_ssm.types.max_results.MaxResults"] = None,
) -> "capo_ssm.types.list_nodes_result.ListNodesResult":
    """<p>Takes in filters and returns a list of managed nodes matching the filter criteria.</p>

    Args:
        sync_name: <p>The name of the Amazon Web Services managed resource data sync to retrieve information about.</p> <p>For cross-account/cross-Region configurations, this parameter is required, and the name of the supported resource data sync is <code>AWS-QuickSetup-ManagedNode</code>.</p> <p>For single account/single-Region configurations, the parameter is not required.</p>
        filters: <p>One or more filters. Use a filter to return a more specific list of managed nodes.</p>
        next_token: <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
        max_results: <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>

    Raises:
        capo_ssm.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</p>
        capo_ssm.errors.invalid_filter.InvalidFilter: <p>The filter name isn't valid. Verify that you entered the correct name and try again.</p>
        capo_ssm.errors.invalid_next_token.InvalidNextToken: <p>The specified token isn't valid.</p>
        capo_ssm.errors.resource_data_sync_not_found_exception.ResourceDataSyncNotFoundException: <p>The specified sync name wasn't found.</p>
        capo_ssm.errors.unsupported_operation_exception.UnsupportedOperationException: <p>This operation is not supported for the current account. You must first enable the Systems Manager integrated experience in your account.</p>
        capo_ssm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm.types.list_nodes_request.ListNodesRequest]",
    ) -> OperationResponse["capo_ssm.types.list_nodes_result.ListNodesResult"]:
        import capo_ssm._operations.amazon_ssm.list_nodes

        output, http_response = (
            capo_ssm._operations.amazon_ssm.list_nodes.list_nodes(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_ssm.types.list_nodes_result.ListNodesResult",
    ) -> dict[str, Any]:
        import capo_ssm.types.list_nodes_result

        return capo_ssm.types.list_nodes_result.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListNodes", redact_output=_redact_output),
    )
    input_: capo_ssm.types.list_nodes_request.ListNodesRequest = {}
    if sync_name is not None:
        input_["sync_name"] = sync_name
    if filters is not None:
        input_["filters"] = filters
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output