Update the specified channel group. You can edit the description on a channel group for easier identification later from the AWS Elemental MediaPackage console. You can't edit the name of the channel group.
Any edits you make that impact the video output may not be reflected for a few minutes.
Parameters:
-
channel_group_name
(ResourceName)
–
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
-
e_tag
(Optional[EntityTag], default:
None
)
–
The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.
-
description
(Optional[ResourceDescription], default:
None
)
–
Any descriptive information that you want to add to the channel group for future identification purposes.
Raises:
-
AccessDeniedException
–
Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
-
ConflictException
–
Updating or deleting this resource can cause an inconsistent state.
-
InternalServerException
–
Indicates that an error from the service occurred while trying to process a request.
-
ResourceNotFoundException
–
The specified resource doesn't exist.
-
ThrottlingException
–
The request throughput limit was exceeded.
-
ValidationException
–
The input failed to meet the constraints specified by the AWS service.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Examples:
Updating a Channel Group
>>> client.update_channel_group(channel_group_name='exampleChannelGroup', description='Updated description for exampleChannelGroup')
Source code in docs_src/capo_mediapackagev2/_services/media_package_v2.py
| def update_channel_group(
self,
channel_group_name: "capo_mediapackagev2.types.resource_name.ResourceName",
*,
config_overrides: Optional[MediaPackageV2ClientConfig] = None,
e_tag: Optional["capo_mediapackagev2.types.entity_tag.EntityTag"] = None,
description: Optional[
"capo_mediapackagev2.types.resource_description.ResourceDescription"
] = None,
) -> "capo_mediapackagev2.types.update_channel_group_response.UpdateChannelGroupResponse":
"""<p>Update the specified channel group. You can edit the description on a channel group for easier identification later from the AWS Elemental MediaPackage console. You can't edit the name of the channel group.</p> <p>Any edits you make that impact the video output may not be reflected for a few minutes.</p>
Args:
channel_group_name: <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
e_tag: <p>The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.</p>
description: <p>Any descriptive information that you want to add to the channel group for future identification purposes.</p>
Raises:
capo_mediapackagev2.errors.access_denied_exception.AccessDeniedException: <p>Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.</p>
capo_mediapackagev2.errors.conflict_exception.ConflictException: <p>Updating or deleting this resource can cause an inconsistent state.</p>
capo_mediapackagev2.errors.internal_server_exception.InternalServerException: <p>Indicates that an error from the service occurred while trying to process a request.</p>
capo_mediapackagev2.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource doesn't exist.</p>
capo_mediapackagev2.errors.throttling_exception.ThrottlingException: <p>The request throughput limit was exceeded.</p>
capo_mediapackagev2.errors.validation_exception.ValidationException: <p>The input failed to meet the constraints specified by the AWS service.</p>
capo_mediapackagev2.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
Updating a Channel Group
>>> client.update_channel_group(channel_group_name='exampleChannelGroup', description='Updated description for exampleChannelGroup')
"""
def _handler(
req: "OperationRequest[capo_mediapackagev2.types.update_channel_group_request.UpdateChannelGroupRequest]",
) -> OperationResponse[
"capo_mediapackagev2.types.update_channel_group_response.UpdateChannelGroupResponse"
]:
import capo_mediapackagev2._operations.mediapackagev2.update_channel_group
output, http_response = (
capo_mediapackagev2._operations.mediapackagev2.update_channel_group.update_channel_group(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("UpdateChannelGroup")
)
input_: capo_mediapackagev2.types.update_channel_group_request.UpdateChannelGroupRequest = {
"channel_group_name": channel_group_name
}
if e_tag is not None:
input_["e_tag"] = e_tag
if description is not None:
input_["description"] = description
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|