-
Notifications
You must be signed in to change notification settings - Fork 580
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(client-kinesis-video): General Availability (GA) release of Kine…
…sis Video Streams at Edge, enabling customers to provide a configuration for the Kinesis Video Streams EdgeAgent running on an on-premise IoT device. Customers can now locally record from cameras and stream videos to the cloud on a configured schedule.
- Loading branch information
awstools
committed
Jun 27, 2023
1 parent
b11ef46
commit 31ffd5a
Showing
16 changed files
with
1,963 additions
and
1,079 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
160 changes: 160 additions & 0 deletions
160
clients/client-kinesis-video/src/commands/DeleteEdgeConfigurationCommand.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,160 @@ | ||
// smithy-typescript generated code | ||
import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint"; | ||
import { getSerdePlugin } from "@aws-sdk/middleware-serde"; | ||
import { Command as $Command } from "@aws-sdk/smithy-client"; | ||
import { | ||
FinalizeHandlerArguments, | ||
Handler, | ||
HandlerExecutionContext, | ||
HttpHandlerOptions as __HttpHandlerOptions, | ||
MetadataBearer as __MetadataBearer, | ||
MiddlewareStack, | ||
} from "@aws-sdk/types"; | ||
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; | ||
import { SerdeContext as __SerdeContext } from "@smithy/types"; | ||
|
||
import { KinesisVideoClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisVideoClient"; | ||
import { DeleteEdgeConfigurationInput, DeleteEdgeConfigurationOutput } from "../models/models_0"; | ||
import { de_DeleteEdgeConfigurationCommand, se_DeleteEdgeConfigurationCommand } from "../protocols/Aws_restJson1"; | ||
|
||
/** | ||
* @public | ||
*/ | ||
export { __MetadataBearer, $Command }; | ||
/** | ||
* @public | ||
* | ||
* The input for {@link DeleteEdgeConfigurationCommand}. | ||
*/ | ||
export interface DeleteEdgeConfigurationCommandInput extends DeleteEdgeConfigurationInput {} | ||
/** | ||
* @public | ||
* | ||
* The output of {@link DeleteEdgeConfigurationCommand}. | ||
*/ | ||
export interface DeleteEdgeConfigurationCommandOutput extends DeleteEdgeConfigurationOutput, __MetadataBearer {} | ||
|
||
/** | ||
* @public | ||
* <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> | ||
* @example | ||
* Use a bare-bones client and the command you need to make an API call. | ||
* ```javascript | ||
* import { KinesisVideoClient, DeleteEdgeConfigurationCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import | ||
* // const { KinesisVideoClient, DeleteEdgeConfigurationCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import | ||
* const client = new KinesisVideoClient(config); | ||
* const input = { // DeleteEdgeConfigurationInput | ||
* StreamName: "STRING_VALUE", | ||
* StreamARN: "STRING_VALUE", | ||
* }; | ||
* const command = new DeleteEdgeConfigurationCommand(input); | ||
* const response = await client.send(command); | ||
* // {}; | ||
* | ||
* ``` | ||
* | ||
* @param DeleteEdgeConfigurationCommandInput - {@link DeleteEdgeConfigurationCommandInput} | ||
* @returns {@link DeleteEdgeConfigurationCommandOutput} | ||
* @see {@link DeleteEdgeConfigurationCommandInput} for command's `input` shape. | ||
* @see {@link DeleteEdgeConfigurationCommandOutput} for command's `response` shape. | ||
* @see {@link KinesisVideoClientResolvedConfig | config} for KinesisVideoClient's `config` shape. | ||
* | ||
* @throws {@link AccessDeniedException} (client fault) | ||
* <p>You do not have required permissions to perform this operation.</p> | ||
* | ||
* @throws {@link ClientLimitExceededException} (client fault) | ||
* <p>Kinesis Video Streams has throttled the request because you have exceeded the limit of | ||
* allowed client calls. Try making the call later.</p> | ||
* | ||
* @throws {@link InvalidArgumentException} (client fault) | ||
* <p>The value for this input parameter is invalid.</p> | ||
* | ||
* @throws {@link ResourceNotFoundException} (client fault) | ||
* <p>Amazon Kinesis Video Streams can't find the stream that you specified.</p> | ||
* | ||
* @throws {@link StreamEdgeConfigurationNotFoundException} (client fault) | ||
* <p>The Exception rendered when the Amazon Kinesis Video Stream can't find a stream's edge configuration | ||
* that you specified. </p> | ||
* | ||
* @throws {@link KinesisVideoServiceException} | ||
* <p>Base exception class for all service exceptions from KinesisVideo service.</p> | ||
* | ||
*/ | ||
export class DeleteEdgeConfigurationCommand extends $Command< | ||
DeleteEdgeConfigurationCommandInput, | ||
DeleteEdgeConfigurationCommandOutput, | ||
KinesisVideoClientResolvedConfig | ||
> { | ||
// Start section: command_properties | ||
// End section: command_properties | ||
|
||
public static getEndpointParameterInstructions(): EndpointParameterInstructions { | ||
return { | ||
UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, | ||
Endpoint: { type: "builtInParams", name: "endpoint" }, | ||
Region: { type: "builtInParams", name: "region" }, | ||
UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, | ||
}; | ||
} | ||
|
||
/** | ||
* @public | ||
*/ | ||
constructor(readonly input: DeleteEdgeConfigurationCommandInput) { | ||
// Start section: command_constructor | ||
super(); | ||
// End section: command_constructor | ||
} | ||
|
||
/** | ||
* @internal | ||
*/ | ||
resolveMiddleware( | ||
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, | ||
configuration: KinesisVideoClientResolvedConfig, | ||
options?: __HttpHandlerOptions | ||
): Handler<DeleteEdgeConfigurationCommandInput, DeleteEdgeConfigurationCommandOutput> { | ||
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); | ||
this.middlewareStack.use( | ||
getEndpointPlugin(configuration, DeleteEdgeConfigurationCommand.getEndpointParameterInstructions()) | ||
); | ||
|
||
const stack = clientStack.concat(this.middlewareStack); | ||
|
||
const { logger } = configuration; | ||
const clientName = "KinesisVideoClient"; | ||
const commandName = "DeleteEdgeConfigurationCommand"; | ||
const handlerExecutionContext: HandlerExecutionContext = { | ||
logger, | ||
clientName, | ||
commandName, | ||
inputFilterSensitiveLog: (_: any) => _, | ||
outputFilterSensitiveLog: (_: any) => _, | ||
}; | ||
const { requestHandler } = configuration; | ||
return stack.resolve( | ||
(request: FinalizeHandlerArguments<any>) => | ||
requestHandler.handle(request.request as __HttpRequest, options || {}), | ||
handlerExecutionContext | ||
); | ||
} | ||
|
||
/** | ||
* @internal | ||
*/ | ||
private serialize(input: DeleteEdgeConfigurationCommandInput, context: __SerdeContext): Promise<__HttpRequest> { | ||
return se_DeleteEdgeConfigurationCommand(input, context); | ||
} | ||
|
||
/** | ||
* @internal | ||
*/ | ||
private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<DeleteEdgeConfigurationCommandOutput> { | ||
return de_DeleteEdgeConfigurationCommand(output, context); | ||
} | ||
|
||
// Start section: command_body_extra | ||
// End section: command_body_extra | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.