/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.kinesisvideo.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *
* 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. *
*/ public class DeleteEdgeConfigurationRequest extends AmazonWebServiceRequest implements Serializable { /** *
* The name of the stream from which to delete the edge configuration.
* Specify either the StreamName
or the StreamARN
.
*
* Constraints:
* Length: 1 - 256
* Pattern: [a-zA-Z0-9_.-]+
*/
private String streamName;
/**
*
* The Amazon Resource Name (ARN) of the stream. Specify either the
* StreamName
or the StreamARN
.
*
* Constraints:
* Length: 1 - 1024
* Pattern:
* arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-
* Z0-9_.-]+/[0-9]+
*/
private String streamARN;
/**
*
* The name of the stream from which to delete the edge configuration.
* Specify either the StreamName
or the StreamARN
.
*
* Constraints:
* Length: 1 - 256
* Pattern: [a-zA-Z0-9_.-]+
*
* @return
* The name of the stream from which to delete the edge
* configuration. Specify either the StreamName
or the
* StreamARN
.
*
* The name of the stream from which to delete the edge configuration.
* Specify either the StreamName
or the StreamARN
.
*
* Constraints:
* Length: 1 - 256
* Pattern: [a-zA-Z0-9_.-]+
*
* @param streamName
* The name of the stream from which to delete the edge
* configuration. Specify either the StreamName
or
* the StreamARN
.
*
* The name of the stream from which to delete the edge configuration.
* Specify either the StreamName
or the StreamARN
.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 256
* Pattern: [a-zA-Z0-9_.-]+
*
* @param streamName
* The name of the stream from which to delete the edge
* configuration. Specify either the StreamName
or
* the StreamARN
.
*
* The Amazon Resource Name (ARN) of the stream. Specify either the
* StreamName
or the StreamARN
.
*
* Constraints:
* Length: 1 - 1024
* Pattern:
* arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-
* Z0-9_.-]+/[0-9]+
*
* @return
* The Amazon Resource Name (ARN) of the stream. Specify either the
* StreamName
or the StreamARN
.
*
* The Amazon Resource Name (ARN) of the stream. Specify either the
* StreamName
or the StreamARN
.
*
* Constraints:
* Length: 1 - 1024
* Pattern:
* arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-
* Z0-9_.-]+/[0-9]+
*
* @param streamARN
* The Amazon Resource Name (ARN) of the stream. Specify either
* the StreamName
or the StreamARN
.
*
* The Amazon Resource Name (ARN) of the stream. Specify either the
* StreamName
or the StreamARN
.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 1024
* Pattern:
* arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-
* Z0-9_.-]+/[0-9]+
*
* @param streamARN
* The Amazon Resource Name (ARN) of the stream. Specify either
* the StreamName
or the StreamARN
.
*