Skip to main content Link Search Menu Expand Document (external link)

IvsService overview

Added in v1.0.0


Table of contents


constructors

makeIvsService

Signature

export declare const makeIvsService: Effect.Effect<any, unknown, unknown>

Added in v1.0.0

models

IvsService (class)

Signature

export declare class IvsService

Added in v1.0.0

IvsService$ (interface)

Signature

export interface IvsService$ {
  /**
   * @see {@link BatchGetChannelCommand}
   */
  batchGetChannel(
    args: BatchGetChannelCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    BatchGetChannelCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | ServiceUnavailableError | ValidationError
  >

  /**
   * @see {@link BatchGetStreamKeyCommand}
   */
  batchGetStreamKey(
    args: BatchGetStreamKeyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    BatchGetStreamKeyCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | ServiceUnavailableError | ValidationError
  >

  /**
   * @see {@link BatchStartViewerSessionRevocationCommand}
   */
  batchStartViewerSessionRevocation(
    args: BatchStartViewerSessionRevocationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    BatchStartViewerSessionRevocationCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | PendingVerificationError | ThrottlingError | ValidationError
  >

  /**
   * @see {@link CreateAdConfigurationCommand}
   */
  createAdConfiguration(
    args: CreateAdConfigurationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateAdConfigurationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | InternalServerError
    | PendingVerificationError
    | ResourceNotFoundError
    | ServiceQuotaExceededError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link CreateChannelCommand}
   */
  createChannel(
    args: CreateChannelCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateChannelCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | PendingVerificationError
    | ResourceNotFoundError
    | ServiceQuotaExceededError
    | ValidationError
  >

  /**
   * @see {@link CreatePlaybackRestrictionPolicyCommand}
   */
  createPlaybackRestrictionPolicy(
    args: CreatePlaybackRestrictionPolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreatePlaybackRestrictionPolicyCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | PendingVerificationError
    | ServiceQuotaExceededError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link CreateRecordingConfigurationCommand}
   */
  createRecordingConfiguration(
    args: CreateRecordingConfigurationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateRecordingConfigurationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | InternalServerError
    | PendingVerificationError
    | ServiceQuotaExceededError
    | ValidationError
  >

  /**
   * @see {@link CreateStreamKeyCommand}
   */
  createStreamKey(
    args: CreateStreamKeyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateStreamKeyCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | PendingVerificationError
    | ResourceNotFoundError
    | ServiceQuotaExceededError
    | ValidationError
  >

  /**
   * @see {@link DeleteAdConfigurationCommand}
   */
  deleteAdConfiguration(
    args: DeleteAdConfigurationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteAdConfigurationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | InternalServerError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DeleteChannelCommand}
   */
  deleteChannel(
    args: DeleteChannelCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteChannelCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | PendingVerificationError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DeletePlaybackKeyPairCommand}
   */
  deletePlaybackKeyPair(
    args: DeletePlaybackKeyPairCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeletePlaybackKeyPairCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | PendingVerificationError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DeletePlaybackRestrictionPolicyCommand}
   */
  deletePlaybackRestrictionPolicy(
    args: DeletePlaybackRestrictionPolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeletePlaybackRestrictionPolicyCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | PendingVerificationError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DeleteRecordingConfigurationCommand}
   */
  deleteRecordingConfiguration(
    args: DeleteRecordingConfigurationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteRecordingConfigurationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | InternalServerError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link DeleteStreamKeyCommand}
   */
  deleteStreamKey(
    args: DeleteStreamKeyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteStreamKeyCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | PendingVerificationError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link GetAdConfigurationCommand}
   */
  getAdConfiguration(
    args: GetAdConfigurationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetAdConfigurationCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link GetChannelCommand}
   */
  getChannel(
    args: GetChannelCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetChannelCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link GetPlaybackKeyPairCommand}
   */
  getPlaybackKeyPair(
    args: GetPlaybackKeyPairCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetPlaybackKeyPairCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link GetPlaybackRestrictionPolicyCommand}
   */
  getPlaybackRestrictionPolicy(
    args: GetPlaybackRestrictionPolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetPlaybackRestrictionPolicyCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | PendingVerificationError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link GetRecordingConfigurationCommand}
   */
  getRecordingConfiguration(
    args: GetRecordingConfigurationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetRecordingConfigurationCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link GetStreamCommand}
   */
  getStream(
    args: GetStreamCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetStreamCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ChannelNotBroadcastingError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link GetStreamKeyCommand}
   */
  getStreamKey(
    args: GetStreamKeyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetStreamKeyCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link GetStreamSessionCommand}
   */
  getStreamSession(
    args: GetStreamSessionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetStreamSessionCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link ImportPlaybackKeyPairCommand}
   */
  importPlaybackKeyPair(
    args: ImportPlaybackKeyPairCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ImportPlaybackKeyPairCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | PendingVerificationError
    | ServiceQuotaExceededError
    | ValidationError
  >

  /**
   * @see {@link InsertAdBreakCommand}
   */
  insertAdBreak(
    args: InsertAdBreakCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    InsertAdBreakCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ChannelNotBroadcastingError
    | ConflictError
    | InternalServerError
    | ResourceNotFoundError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link ListAdConfigurationsCommand}
   */
  listAdConfigurations(
    args: ListAdConfigurationsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListAdConfigurationsCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | InternalServerError | ValidationError
  >

  listAdConfigurationsStream(
    args: ListAdConfigurationsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListAdConfigurationsCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | InternalServerError | ValidationError
  >

  /**
   * @see {@link ListChannelsCommand}
   */
  listChannels(
    args: ListChannelsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListChannelsCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | ConflictError | ValidationError
  >

  listChannelsStream(
    args: ListChannelsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListChannelsCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | ConflictError | ValidationError
  >

  /**
   * @see {@link ListPlaybackKeyPairsCommand}
   */
  listPlaybackKeyPairs(
    args: ListPlaybackKeyPairsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListPlaybackKeyPairsCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | ValidationError
  >

  listPlaybackKeyPairsStream(
    args: ListPlaybackKeyPairsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListPlaybackKeyPairsCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | ValidationError
  >

  /**
   * @see {@link ListPlaybackRestrictionPoliciesCommand}
   */
  listPlaybackRestrictionPolicies(
    args: ListPlaybackRestrictionPoliciesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListPlaybackRestrictionPoliciesCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | ConflictError | PendingVerificationError | ValidationError
  >

  listPlaybackRestrictionPoliciesStream(
    args: ListPlaybackRestrictionPoliciesCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListPlaybackRestrictionPoliciesCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | ConflictError | PendingVerificationError | ValidationError
  >

  /**
   * @see {@link ListRecordingConfigurationsCommand}
   */
  listRecordingConfigurations(
    args: ListRecordingConfigurationsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListRecordingConfigurationsCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | InternalServerError | ValidationError
  >

  listRecordingConfigurationsStream(
    args: ListRecordingConfigurationsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListRecordingConfigurationsCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | InternalServerError | ValidationError
  >

  /**
   * @see {@link ListStreamKeysCommand}
   */
  listStreamKeys(
    args: ListStreamKeysCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListStreamKeysCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | ResourceNotFoundError | ValidationError
  >

  listStreamKeysStream(
    args: ListStreamKeysCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListStreamKeysCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link ListStreamSessionsCommand}
   */
  listStreamSessions(
    args: ListStreamSessionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListStreamSessionsCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | ResourceNotFoundError | ValidationError
  >

  listStreamSessionsStream(
    args: ListStreamSessionsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListStreamSessionsCommandOutput,
    Cause.TimeoutError | SdkError | AccessDeniedError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link ListStreamsCommand}
   */
  listStreams(
    args: ListStreamsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<ListStreamsCommandOutput, Cause.TimeoutError | SdkError | AccessDeniedError | ValidationError>

  listStreamsStream(
    args: ListStreamsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<ListStreamsCommandOutput, Cause.TimeoutError | SdkError | AccessDeniedError | ValidationError>

  /**
   * @see {@link ListTagsForResourceCommand}
   */
  listTagsForResource(
    args: ListTagsForResourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListTagsForResourceCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link PutMetadataCommand}
   */
  putMetadata(
    args: PutMetadataCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    PutMetadataCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ChannelNotBroadcastingError
    | ResourceNotFoundError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link StartViewerSessionRevocationCommand}
   */
  startViewerSessionRevocation(
    args: StartViewerSessionRevocationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    StartViewerSessionRevocationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | InternalServerError
    | PendingVerificationError
    | ResourceNotFoundError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link StopStreamCommand}
   */
  stopStream(
    args: StopStreamCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    StopStreamCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ChannelNotBroadcastingError
    | ResourceNotFoundError
    | StreamUnavailableError
    | ValidationError
  >

  /**
   * @see {@link TagResourceCommand}
   */
  tagResource(
    args: TagResourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    TagResourceCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link UntagResourceCommand}
   */
  untagResource(
    args: UntagResourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UntagResourceCommandOutput,
    Cause.TimeoutError | SdkError | InternalServerError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link UpdateAdConfigurationCommand}
   */
  updateAdConfiguration(
    args: UpdateAdConfigurationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateAdConfigurationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | InternalServerError
    | PendingVerificationError
    | ResourceNotFoundError
    | ServiceQuotaExceededError
    | ThrottlingError
    | ValidationError
  >

  /**
   * @see {@link UpdateChannelCommand}
   */
  updateChannel(
    args: UpdateChannelCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateChannelCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | PendingVerificationError
    | ResourceNotFoundError
    | ValidationError
  >

  /**
   * @see {@link UpdatePlaybackRestrictionPolicyCommand}
   */
  updatePlaybackRestrictionPolicy(
    args: UpdatePlaybackRestrictionPolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdatePlaybackRestrictionPolicyCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AccessDeniedError
    | ConflictError
    | PendingVerificationError
    | ResourceNotFoundError
    | ValidationError
  >
}

Added in v1.0.0

utils

IvsService (namespace)

Added in v1.0.0

Config (interface)

Signature

export interface Config extends Omit<IvsClientConfig, "logger"> {
  readonly logger?: ServiceLogger.ServiceLoggerConstructorProps | true
}

Added in v1.0.0

Type (type alias)

Signature

export type Type = IvsService$

Added in v1.0.0