Skip to content

update_channel_placement_group

update_channel_placement_group(
    channel_placement_group_id: __string,
    cluster_id: __string,
    *,
    config_overrides: Optional[MediaLiveClientConfig] = None,
    name: Optional[__string] = None,
    nodes: Optional[__listOf__string] = None,
) -> UpdateChannelPlacementGroupResponse

Change the settings for a ChannelPlacementGroup.

Parameters:

  • channel_placement_group_id (__string) –

    The ID of the channel placement group.

  • cluster_id (__string) –

    The ID of the cluster.

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

    Include this parameter only if you want to change the current name of the ChannelPlacementGroup. Specify a name that is unique in the Cluster. You can't change the name. Names are case-sensitive.

  • nodes (Optional[__listOf__string], default: None ) –

    Include this parameter only if you want to change the list of Nodes that are associated with the ChannelPlacementGroup.

Raises:

Source code in docs_src/capo_medialive/_services/media_live.py
def update_channel_placement_group(
    self,
    channel_placement_group_id: "capo_medialive.types.__string.__string",
    cluster_id: "capo_medialive.types.__string.__string",
    *,
    config_overrides: Optional[MediaLiveClientConfig] = None,
    name: Optional["capo_medialive.types.__string.__string"] = None,
    nodes: Optional[
        "capo_medialive.types.__list_of__string.__listOf__string"
    ] = None,
) -> "capo_medialive.types.update_channel_placement_group_response.UpdateChannelPlacementGroupResponse":
    """Change the settings for a ChannelPlacementGroup.

    Args:
        channel_placement_group_id: The ID of the channel placement group.
        cluster_id: The ID of the cluster.
        name: Include this parameter only if you want to change the current name of the ChannelPlacementGroup. Specify a name that is unique in the Cluster. You can't change the name. Names are case-sensitive.
        nodes: Include this parameter only if you want to change the list of Nodes that are associated with the ChannelPlacementGroup.

    Raises:
        capo_medialive.errors.bad_gateway_exception.BadGatewayException: Placeholder documentation for BadGatewayException
        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.gateway_timeout_exception.GatewayTimeoutException: Placeholder documentation for GatewayTimeoutException
        capo_medialive.errors.internal_server_error_exception.InternalServerErrorException: Placeholder documentation for InternalServerErrorException
        capo_medialive.errors.too_many_requests_exception.TooManyRequestsException: Placeholder documentation for TooManyRequestsException
        capo_medialive.errors.unprocessable_entity_exception.UnprocessableEntityException: Placeholder documentation for UnprocessableEntityException
        capo_medialive.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_medialive.types.update_channel_placement_group_request.UpdateChannelPlacementGroupRequest]",
    ) -> OperationResponse[
        "capo_medialive.types.update_channel_placement_group_response.UpdateChannelPlacementGroupResponse"
    ]:
        import capo_medialive._operations.media_live.update_channel_placement_group

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateChannelPlacementGroup")
    )
    input_: capo_medialive.types.update_channel_placement_group_request.UpdateChannelPlacementGroupRequest = {
        "channel_placement_group_id": channel_placement_group_id,
        "cluster_id": cluster_id,
    }
    if name is not None:
        input_["name"] = name
    if nodes is not None:
        input_["nodes"] = nodes

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