Skip to content

list_related_items async

list_related_items(
    incident_record_arn: Arn,
    *,
    config_overrides: Optional[AsyncSSMIncidentsClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListRelatedItemsOutput

List all related items for an incident record.

Parameters:

  • incident_record_arn (Arn) –

    The Amazon Resource Name (ARN) of the incident record containing the listed related items.

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

    The maximum number of related items per page.

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

    The pagination 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_incidents/_services/async_ssm_incidents.py
async def list_related_items(
    self,
    incident_record_arn: "capo_ssm_incidents.types.arn.Arn",
    *,
    config_overrides: Optional[AsyncSSMIncidentsClientConfig] = None,
    max_results: Optional["capo_ssm_incidents.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_ssm_incidents.types.next_token.NextToken"] = None,
) -> "capo_ssm_incidents.types.list_related_items_output.ListRelatedItemsOutput":
    """<p>List all related items for an incident record.</p>

    Args:
        incident_record_arn: <p>The Amazon Resource Name (ARN) of the incident record containing the listed related items.</p>
        max_results: <p>The maximum number of related items per page.</p>
        next_token: <p>The pagination token for the next set of items to return. (You received this token from a previous call.)</p>

    Raises:
        capo_ssm_incidents.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this operation.</p>
        capo_ssm_incidents.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_ssm_incidents.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_ssm_incidents.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_ssm_incidents.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ssm_incidents.types.list_related_items_input.ListRelatedItemsInput]",
    ) -> AsyncOperationResponse[
        "capo_ssm_incidents.types.list_related_items_output.ListRelatedItemsOutput"
    ]:
        import capo_ssm_incidents._operations.ssm_incidents.list_related_items

        (
            output,
            http_response,
        ) = await capo_ssm_incidents._operations.ssm_incidents.list_related_items.async_list_related_items(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListRelatedItems")
    )
    input_: capo_ssm_incidents.types.list_related_items_input.ListRelatedItemsInput = {
        "incident_record_arn": incident_record_arn
    }
    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