Resetting the origin endpoint can help to resolve unexpected behavior and other content packaging issues. It also helps to preserve special events when you don't want the previous content to be available for viewing. A reset clears out all previous content from the origin endpoint.
MediaPackage might return old content from this endpoint in the first 30 seconds after the endpoint reset. For best results, when possible, wait 30 seconds from endpoint reset to send playback requests to this endpoint.
Parameters:
-
channel_group_name
(ResourceName)
–
The name of the channel group that contains the channel with the origin endpoint that you are resetting.
-
channel_name
(ResourceName)
–
The name of the channel with the origin endpoint that you are resetting.
-
origin_endpoint_name
(ResourceName)
–
The name of the origin endpoint that you are resetting.
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:
Reset an OriginEndpoint
>>> client.reset_origin_endpoint_state(channel_group_name='exampleChannelGroup', channel_name='exampleChannel', origin_endpoint_name='exampleOriginEndpoint')
Source code in docs_src/capo_mediapackagev2/_services/media_package_v2.py
| def reset_origin_endpoint_state(
self,
channel_group_name: "capo_mediapackagev2.types.resource_name.ResourceName",
channel_name: "capo_mediapackagev2.types.resource_name.ResourceName",
origin_endpoint_name: "capo_mediapackagev2.types.resource_name.ResourceName",
*,
config_overrides: Optional[MediaPackageV2ClientConfig] = None,
) -> "capo_mediapackagev2.types.reset_origin_endpoint_state_response.ResetOriginEndpointStateResponse":
"""<p>Resetting the origin endpoint can help to resolve unexpected behavior and other content packaging issues. It also helps to preserve special events when you don't want the previous content to be available for viewing. A reset clears out all previous content from the origin endpoint.</p> <p>MediaPackage might return old content from this endpoint in the first 30 seconds after the endpoint reset. For best results, when possible, wait 30 seconds from endpoint reset to send playback requests to this endpoint. </p>
Args:
channel_group_name: <p>The name of the channel group that contains the channel with the origin endpoint that you are resetting.</p>
channel_name: <p>The name of the channel with the origin endpoint that you are resetting.</p>
origin_endpoint_name: <p>The name of the origin endpoint that you are resetting.</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:
Reset an OriginEndpoint
>>> client.reset_origin_endpoint_state(channel_group_name='exampleChannelGroup', channel_name='exampleChannel', origin_endpoint_name='exampleOriginEndpoint')
"""
def _handler(
req: "OperationRequest[capo_mediapackagev2.types.reset_origin_endpoint_state_request.ResetOriginEndpointStateRequest]",
) -> OperationResponse[
"capo_mediapackagev2.types.reset_origin_endpoint_state_response.ResetOriginEndpointStateResponse"
]:
import capo_mediapackagev2._operations.mediapackagev2.reset_origin_endpoint_state
output, http_response = (
capo_mediapackagev2._operations.mediapackagev2.reset_origin_endpoint_state.reset_origin_endpoint_state(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ResetOriginEndpointState")
)
input_: capo_mediapackagev2.types.reset_origin_endpoint_state_request.ResetOriginEndpointStateRequest = {
"channel_group_name": channel_group_name,
"channel_name": channel_name,
"origin_endpoint_name": origin_endpoint_name,
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|