An asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from the Edge Agent.
When you invoke this API, the sync status is set to DELETING. A deletion process starts, in which active edge jobs are stopped and all media is deleted from the edge device. The time to delete varies, depending on the total amount of stored media. If the deletion process fails, the sync status changes to DELETE_FAILED. You will need to re-try the deletion.
When the deletion process has completed successfully, the edge configuration is no longer accessible.
Parameters:
-
stream_name
(Optional[StreamName], default:
None
)
–
The name of the stream from which to delete the edge configuration. Specify either the StreamName or the StreamARN.
-
stream_arn
(Optional[ResourceARN], default:
None
)
–
The Amazon Resource Name (ARN) of the stream. Specify either the StreamName or the StreamARN.
Raises:
Source code in docs_src/capo_kinesis_video/_services/async_kinesis_video.py
| async def delete_edge_configuration(
self,
*,
config_overrides: Optional[AsyncKinesisVideoClientConfig] = None,
stream_name: Optional["capo_kinesis_video.types.stream_name.StreamName"] = None,
stream_arn: Optional[
"capo_kinesis_video.types.resource_arn.ResourceARN"
] = None,
) -> "capo_kinesis_video.types.delete_edge_configuration_output.DeleteEdgeConfigurationOutput":
"""<p>An asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from the Edge Agent.</p> <p>When you invoke this API, the sync status is set to <code>DELETING</code>. A deletion process starts, in which active edge jobs are stopped and all media is deleted from the edge device. The time to delete varies, depending on the total amount of stored media. If the deletion process fails, the sync status changes to <code>DELETE_FAILED</code>. You will need to re-try the deletion.</p> <p>When the deletion process has completed successfully, the edge configuration is no longer accessible.</p>
Args:
stream_name: <p>The name of the stream from which to delete the edge configuration. Specify either the <code>StreamName</code> or the <code>StreamARN</code>.</p>
stream_arn: <p>The Amazon Resource Name (ARN) of the stream. Specify either the <code>StreamName</code> or the <code>StreamARN</code>.</p>
Raises:
capo_kinesis_video.errors.access_denied_exception.AccessDeniedException: <p>You do not have required permissions to perform this operation.</p>
capo_kinesis_video.errors.client_limit_exceeded_exception.ClientLimitExceededException: <p>Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.</p>
capo_kinesis_video.errors.invalid_argument_exception.InvalidArgumentException: <p>The value for this input parameter is invalid.</p>
capo_kinesis_video.errors.resource_not_found_exception.ResourceNotFoundException: <p>Amazon Kinesis Video Streams can't find the stream that you specified.</p>
capo_kinesis_video.errors.stream_edge_configuration_not_found_exception.StreamEdgeConfigurationNotFoundException: <p>The Exception rendered when the Amazon Kinesis Video Stream can't find a stream's edge configuration that you specified. </p>
capo_kinesis_video.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_kinesis_video.types.delete_edge_configuration_input.DeleteEdgeConfigurationInput]",
) -> AsyncOperationResponse[
"capo_kinesis_video.types.delete_edge_configuration_output.DeleteEdgeConfigurationOutput"
]:
import capo_kinesis_video._operations.kinesis_video_20170930.delete_edge_configuration
(
output,
http_response,
) = await capo_kinesis_video._operations.kinesis_video_20170930.delete_edge_configuration.async_delete_edge_configuration(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteEdgeConfiguration")
)
input_: capo_kinesis_video.types.delete_edge_configuration_input.DeleteEdgeConfigurationInput = {}
if stream_name is not None:
input_["stream_name"] = stream_name
if stream_arn is not None:
input_["stream_arn"] = stream_arn
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|