get_ops_summary ¶

def get_ops_summary(
    self,
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    sync_name: Optional[
        "capo_ssm.types.resource_data_sync_name.ResourceDataSyncName"
    ] = None,
    filters: Optional["capo_ssm.types.ops_filter_list.OpsFilterList"] = None,
    aggregators: Optional[
        "capo_ssm.types.ops_aggregator_list.OpsAggregatorList"
    ] = None,
    result_attributes: Optional[
        "capo_ssm.types.ops_result_attribute_list.OpsResultAttributeList"
    ] = None,
    next_token: Optional["capo_ssm.types.next_token.NextToken"] = None,
    max_results: Optional["capo_ssm.types.max_results.MaxResults"] = None,
) -> "capo_ssm.types.get_ops_summary_result.GetOpsSummaryResult":
    """<p>View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer. </p>

    Args:
        sync_name: <p>Specify the name of a resource data sync to get.</p>
        filters: <p>Optional filters used to scope down the returned OpsData. </p>
        aggregators: <p>Optional aggregators that return counts of OpsData based on one or more expressions.</p>
        result_attributes: <p>The OpsData data type to return.</p>
        next_token: <p>A token to start the list. Use this token to get the next set of results. </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_aggregator_exception.InvalidAggregatorException: <p>The specified aggregator isn't valid for the group type. Verify that the aggregator you provided is supported.</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.invalid_type_name_exception.InvalidTypeNameException: <p>The parameter type name 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.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm.types.get_ops_summary_request.GetOpsSummaryRequest]",
    ) -> OperationResponse[
        "capo_ssm.types.get_ops_summary_result.GetOpsSummaryResult"
    ]:
        import capo_ssm._operations.amazon_ssm.get_ops_summary

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetOpsSummary")
    )
    input_: capo_ssm.types.get_ops_summary_request.GetOpsSummaryRequest = {}
    if sync_name is not None:
        input_["sync_name"] = sync_name
    if filters is not None:
        input_["filters"] = filters
    if aggregators is not None:
        input_["aggregators"] = aggregators
    if result_attributes is not None:
        input_["result_attributes"] = result_attributes
    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