Skip to content

delete_playback_key_pair async

delete_playback_key_pair(
    arn: PlaybackKeyPairArn, *, config_overrides: Optional[AsyncivsClientConfig] = None
) -> DeletePlaybackKeyPairResponse

Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Parameters:

Raises:

Source code in docs_src/capo_ivs/_services/async_ivs.py
async def delete_playback_key_pair(
    self,
    arn: "capo_ivs.types.playback_key_pair_arn.PlaybackKeyPairArn",
    *,
    config_overrides: Optional[AsyncivsClientConfig] = None,
) -> (
    "capo_ivs.types.delete_playback_key_pair_response.DeletePlaybackKeyPairResponse"
):
    """<p>Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s <code>privateKey</code>. For more information, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up Private Channels</a> in the <i>Amazon IVS User Guide</i>.</p>

    Args:
        arn: <p>ARN of the key pair to be deleted.</p>

    Raises:
        capo_ivs.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_ivs.errors.pending_verification.PendingVerification: <p>Your account is pending verification.</p>
        capo_ivs.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
        capo_ivs.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_ivs.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ivs.types.delete_playback_key_pair_request.DeletePlaybackKeyPairRequest]",
    ) -> AsyncOperationResponse[
        "capo_ivs.types.delete_playback_key_pair_response.DeletePlaybackKeyPairResponse"
    ]:
        import capo_ivs._operations.amazon_interactive_video_service.delete_playback_key_pair

        (
            output,
            http_response,
        ) = await capo_ivs._operations.amazon_interactive_video_service.delete_playback_key_pair.async_delete_playback_key_pair(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeletePlaybackKeyPair")
    )
    input_: capo_ivs.types.delete_playback_key_pair_request.DeletePlaybackKeyPairRequest = {
        "arn": arn
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output