Skip to content

list_signal_maps

list_signal_maps(
    *,
    config_overrides: Optional[MediaLiveClientConfig] = None,
    cloud_watch_alarm_template_group_identifier: Optional[__string] = None,
    event_bridge_rule_template_group_identifier: Optional[__string] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[__string] = None,
) -> ListSignalMapsResponse

Lists signal maps.

Parameters:

  • cloud_watch_alarm_template_group_identifier (Optional[__string], default: None ) –

    A cloudwatch alarm template group's identifier. Can be either be its id or current name.

  • event_bridge_rule_template_group_identifier (Optional[__string], default: None ) –

    An eventbridge rule template group's identifier. Can be either be its id or current name.

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

    A token used to retrieve the next set of results in paginated list responses.

Raises:

Source code in docs_src/capo_medialive/_services/media_live.py
def list_signal_maps(
    self,
    *,
    config_overrides: Optional[MediaLiveClientConfig] = None,
    cloud_watch_alarm_template_group_identifier: Optional[
        "capo_medialive.types.__string.__string"
    ] = None,
    event_bridge_rule_template_group_identifier: Optional[
        "capo_medialive.types.__string.__string"
    ] = None,
    max_results: Optional["capo_medialive.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_medialive.types.__string.__string"] = None,
) -> "capo_medialive.types.list_signal_maps_response.ListSignalMapsResponse":
    """Lists signal maps.

    Args:
        cloud_watch_alarm_template_group_identifier: A cloudwatch alarm template group's identifier. Can be either be its id or current name.
        event_bridge_rule_template_group_identifier: An eventbridge rule template group's identifier. Can be either be its id or current name.
        next_token: A token used to retrieve the next set of results in paginated list responses.

    Raises:
        capo_medialive.errors.bad_request_exception.BadRequestException: Placeholder documentation for BadRequestException
        capo_medialive.errors.forbidden_exception.ForbiddenException: Placeholder documentation for ForbiddenException
        capo_medialive.errors.internal_server_error_exception.InternalServerErrorException: Placeholder documentation for InternalServerErrorException
        capo_medialive.errors.not_found_exception.NotFoundException: Placeholder documentation for NotFoundException
        capo_medialive.errors.too_many_requests_exception.TooManyRequestsException: Placeholder documentation for TooManyRequestsException
        capo_medialive.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_medialive.types.list_signal_maps_request.ListSignalMapsRequest]",
    ) -> OperationResponse[
        "capo_medialive.types.list_signal_maps_response.ListSignalMapsResponse"
    ]:
        import capo_medialive._operations.media_live.list_signal_maps

        output, http_response = (
            capo_medialive._operations.media_live.list_signal_maps.list_signal_maps(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSignalMaps")
    )
    input_: capo_medialive.types.list_signal_maps_request.ListSignalMapsRequest = {}
    if cloud_watch_alarm_template_group_identifier is not None:
        input_["cloud_watch_alarm_template_group_identifier"] = (
            cloud_watch_alarm_template_group_identifier
        )
    if event_bridge_rule_template_group_identifier is not None:
        input_["event_bridge_rule_template_group_identifier"] = (
            event_bridge_rule_template_group_identifier
        )
    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