Skip to content

list_ops_metadata

list_ops_metadata(
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    filters: Optional[OpsMetadataFilterList] = None,
    max_results: Optional[ListOpsMetadataMaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListOpsMetadataResult

Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.

Parameters:

  • filters (Optional[OpsMetadataFilterList], default: None ) –

    One or more filters to limit the number of OpsMetadata objects returned by the call.

  • max_results (Optional[ListOpsMetadataMaxResults], default: None ) –

    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.

  • next_token (Optional[NextToken], default: None ) –

    A token to start the list. Use this token to get the next set of results.

Raises:

Source code in docs_src/capo_ssm/_services/ssm.py
def list_ops_metadata(
    self,
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    filters: Optional[
        "capo_ssm.types.ops_metadata_filter_list.OpsMetadataFilterList"
    ] = None,
    max_results: Optional[
        "capo_ssm.types.list_ops_metadata_max_results.ListOpsMetadataMaxResults"
    ] = None,
    next_token: Optional["capo_ssm.types.next_token.NextToken"] = None,
) -> "capo_ssm.types.list_ops_metadata_result.ListOpsMetadataResult":
    """<p>Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.</p>

    Args:
        filters: <p>One or more filters to limit the number of OpsMetadata objects returned by the 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>
        next_token: <p>A token to start the list. Use this token 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.ops_metadata_invalid_argument_exception.OpsMetadataInvalidArgumentException: <p>One of the arguments passed is invalid. </p>
        capo_ssm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm.types.list_ops_metadata_request.ListOpsMetadataRequest]",
    ) -> OperationResponse[
        "capo_ssm.types.list_ops_metadata_result.ListOpsMetadataResult"
    ]:
        import capo_ssm._operations.amazon_ssm.list_ops_metadata

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListOpsMetadata")
    )
    input_: capo_ssm.types.list_ops_metadata_request.ListOpsMetadataRequest = {}
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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