Skip to content

list_ops_item_related_items async

list_ops_item_related_items(
    *,
    config_overrides: Optional[AsyncSSMClientConfig] = None,
    ops_item_id: Optional[OpsItemId] = None,
    filters: Optional[OpsItemRelatedItemsFilters] = None,
    max_results: Optional[OpsItemRelatedItemsMaxResults] = None,
    next_token: Optional[String] = None,
) -> ListOpsItemRelatedItemsResponse

Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a tool in Amazon Web Services Systems Manager.

Parameters:

  • ops_item_id (Optional[OpsItemId], default: None ) –

    The ID of the OpsItem for which you want to list all related-item resources.

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

    One or more OpsItem filters. Use a filter to return a more specific list of results.

  • max_results (Optional[OpsItemRelatedItemsMaxResults], 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[String], default: None ) –

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

Raises:

Source code in docs_src/capo_ssm/_services/async_ssm.py
async def list_ops_item_related_items(
    self,
    *,
    config_overrides: Optional[AsyncSSMClientConfig] = None,
    ops_item_id: Optional["capo_ssm.types.ops_item_id.OpsItemId"] = None,
    filters: Optional[
        "capo_ssm.types.ops_item_related_items_filters.OpsItemRelatedItemsFilters"
    ] = None,
    max_results: Optional[
        "capo_ssm.types.ops_item_related_items_max_results.OpsItemRelatedItemsMaxResults"
    ] = None,
    next_token: Optional["capo_ssm.types.string.String"] = None,
) -> "capo_ssm.types.list_ops_item_related_items_response.ListOpsItemRelatedItemsResponse":
    """<p>Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a tool in Amazon Web Services Systems Manager.</p>

    Args:
        ops_item_id: <p>The ID of the OpsItem for which you want to list all related-item resources.</p>
        filters: <p>One or more OpsItem filters. Use a filter to return a more specific list 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>
        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.ops_item_invalid_parameter_exception.OpsItemInvalidParameterException: <p>A specified parameter argument isn't valid. Verify the available arguments and try again.</p>
        capo_ssm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ssm.types.list_ops_item_related_items_request.ListOpsItemRelatedItemsRequest]",
    ) -> AsyncOperationResponse[
        "capo_ssm.types.list_ops_item_related_items_response.ListOpsItemRelatedItemsResponse"
    ]:
        import capo_ssm._operations.amazon_ssm.list_ops_item_related_items

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListOpsItemRelatedItems")
    )
    input_: capo_ssm.types.list_ops_item_related_items_request.ListOpsItemRelatedItemsRequest = {}
    if ops_item_id is not None:
        input_["ops_item_id"] = ops_item_id
    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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output