Skip to content

start_update_signal_map

start_update_signal_map(
    identifier: __string,
    *,
    config_overrides: Optional[MediaLiveClientConfig] = None,
    cloud_watch_alarm_template_group_identifiers: Optional[
        __listOf__stringPatternS
    ] = None,
    description: Optional[__stringMin0Max1024] = None,
    discovery_entry_point_arn: Optional[__stringMin1Max2048] = None,
    event_bridge_rule_template_group_identifiers: Optional[
        __listOf__stringPatternS
    ] = None,
    force_rediscovery: Optional[__boolean] = None,
    name: Optional[__stringMin1Max255PatternS] = None,
) -> StartUpdateSignalMapResponse

Initiates an update for the specified signal map. Will discover a new signal map if a changed discoveryEntryPointArn is provided.

Parameters:

  • description (Optional[__stringMin0Max1024], default: None ) –

    A resource's optional description.

  • discovery_entry_point_arn (Optional[__stringMin1Max2048], default: None ) –

    A top-level supported AWS resource ARN to discovery a signal map from.

  • force_rediscovery (Optional[__boolean], default: None ) –

    If true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn is provided.

  • identifier (__string) –

    A signal map's identifier. Can be either be its id or current name.

  • name (Optional[__stringMin1Max255PatternS], default: None ) –

    A resource's name. Names must be unique within the scope of a resource type in a specific region.

Raises:

Source code in docs_src/capo_medialive/_services/media_live.py
def start_update_signal_map(
    self,
    identifier: "capo_medialive.types.__string.__string",
    *,
    config_overrides: Optional[MediaLiveClientConfig] = None,
    cloud_watch_alarm_template_group_identifiers: Optional[
        "capo_medialive.types.__list_of__string_pattern_s.__listOf__stringPatternS"
    ] = None,
    description: Optional[
        "capo_medialive.types.__string_min0_max1024.__stringMin0Max1024"
    ] = None,
    discovery_entry_point_arn: Optional[
        "capo_medialive.types.__string_min1_max2048.__stringMin1Max2048"
    ] = None,
    event_bridge_rule_template_group_identifiers: Optional[
        "capo_medialive.types.__list_of__string_pattern_s.__listOf__stringPatternS"
    ] = None,
    force_rediscovery: Optional["capo_medialive.types.__boolean.__boolean"] = None,
    name: Optional[
        "capo_medialive.types.__string_min1_max255_pattern_s.__stringMin1Max255PatternS"
    ] = None,
) -> "capo_medialive.types.start_update_signal_map_response.StartUpdateSignalMapResponse":
    """Initiates an update for the specified signal map. Will discover a new signal map if a changed discoveryEntryPointArn is provided.

    Args:
        description: A resource's optional description.
        discovery_entry_point_arn: A top-level supported AWS resource ARN to discovery a signal map from.
        force_rediscovery: If true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn is provided.
        identifier: A signal map's identifier. Can be either be its id or current name.
        name: A resource's name. Names must be unique within the scope of a resource type in a specific region.

    Raises:
        capo_medialive.errors.bad_request_exception.BadRequestException: Placeholder documentation for BadRequestException
        capo_medialive.errors.conflict_exception.ConflictException: Placeholder documentation for ConflictException
        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.start_update_signal_map_request.StartUpdateSignalMapRequest]",
    ) -> OperationResponse[
        "capo_medialive.types.start_update_signal_map_response.StartUpdateSignalMapResponse"
    ]:
        import capo_medialive._operations.media_live.start_update_signal_map

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartUpdateSignalMap")
    )
    input_: capo_medialive.types.start_update_signal_map_request.StartUpdateSignalMapRequest = {
        "identifier": identifier
    }
    if cloud_watch_alarm_template_group_identifiers is not None:
        input_["cloud_watch_alarm_template_group_identifiers"] = (
            cloud_watch_alarm_template_group_identifiers
        )
    if description is not None:
        input_["description"] = description
    if discovery_entry_point_arn is not None:
        input_["discovery_entry_point_arn"] = discovery_entry_point_arn
    if event_bridge_rule_template_group_identifiers is not None:
        input_["event_bridge_rule_template_group_identifiers"] = (
            event_bridge_rule_template_group_identifiers
        )
    if force_rediscovery is not None:
        input_["force_rediscovery"] = force_rediscovery
    if name is not None:
        input_["name"] = name

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