ivs

package module
v0.0.0-...-68f2935 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 24, 2024 License: Apache-2.0 Imports: 39 Imported by: 0

Documentation

Overview

Package ivs provides the API client, operations, and parameter types for Amazon Interactive Video Service. 

Introduction

The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both requests and responses, including errors.

The API is an Amazon Web Services regional service. For a list of supported regions and Amazon IVS HTTPS service endpoints, see the Amazon IVS pagein the Amazon Web Services General Reference.

All API request parameters and URLs are case sensitive.

For a summary of notable documentation changes in each release, see Document History.

Allowed Header Values

  • Accept: application/json

  • Accept-Encoding: gzip, deflate

  • Content-Type: application/json

Key Concepts

  • Channel — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream.

  • Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. Treat the stream key like a secret, since it allows anyone to stream to the channel.

  • Playback key pair — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token.

  • Recording configuration — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration.

  • Playback restriction policy — Restricts playback by countries and/or origin sites.

For more information about your IVS live stream, also see Getting Started with IVS Low-Latency Streaming.

Tagging

A tag is a metadata label that you assign to an Amazon Web Services resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Tags can help you identify and organize your Amazon Web Services resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).

The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording Configurations.

At most 50 tags can be applied to a resource.

Authentication versus Authorization

Note the differences between these concepts:

  • Authentication is about verifying identity. You need to be authenticated to sign Amazon IVS API requests.

  • Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS API requests. In addition, authorization is needed to view Amazon IVS private channels. (Private channels are channels that are enabled for "playback authorization.")

Authentication

All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS API directly, it’s your responsibility to sign the requests.

You generate a signature using valid Amazon Web Services credentials that have permission to perform the requested action. For example, you must sign PutMetadata requests with a signature generated from a user account that has the ivs:PutMetadata permission.

For more information:

Amazon Resource Names (ARNs)

ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all of AWS, such as in IAM policies and API calls. For more information, see Amazon Resource Namesin the AWS General Reference.

Channel Endpoints

CreateChannel

  • — Creates a new channel and an associated stream key to start streaming.

GetChannel

  • — Gets the channel configuration for the specified channel ARN.

BatchGetChannel

  • — Performs GetChannelon multiple ARNs simultaneously.

ListChannels

  • — Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 Conflict Exception).

UpdateChannel

  • — Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.

DeleteChannel

  • — Deletes the specified channel.

Playback Restriction Policy Endpoints

CreatePlaybackRestrictionPolicy

  • — Creates a new playback restriction policy, for constraining playback by countries and/or origins.

DeletePlaybackRestrictionPolicy

  • — Deletes the specified playback restriction policy

GetPlaybackRestrictionPolicy

  • — Gets the specified playback restriction policy.

ListPlaybackRestrictionPolicies

  • — Gets summary information about playback restriction policies.

UpdatePlaybackRestrictionPolicy

  • — Updates a specified playback restriction policy.

Private Channel Endpoints

For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

ImportPlaybackKeyPair

  • — Imports the public portion of a new key pair and returns its arn and fingerprint . The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to private channels (channels enabled for playback authorization).

GetPlaybackKeyPair

  • — Gets a specified playback authorization key pair and returns the arn and fingerprint . The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels.

ListPlaybackKeyPairs

  • — Gets summary information about playback key pairs.

DeletePlaybackKeyPair

  • — Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey .

StartViewerSessionRevocation

  • — Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID. Optionally, you can provide a version to revoke viewer sessions less than and including that version.

BatchStartViewerSessionRevocation

  • — Performs StartViewerSessionRevocationon multiple channel ARN and viewer ID pairs simultaneously.

Recording Configuration Endpoints

CreateRecordingConfiguration

  • — Creates a new recording configuration, used to enable recording to Amazon S3.

GetRecordingConfiguration

  • — Gets the recording-configuration metadata for the specified ARN.

ListRecordingConfigurations

  • — Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.

DeleteRecordingConfiguration

  • — Deletes the recording configuration for the specified ARN.

Stream Endpoints

GetStream

  • — Gets information about the active (live) stream on a specified channel.

GetStreamSession

  • — Gets metadata on a specified stream.

ListStreams

  • — Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.

ListStreamSessions

  • — Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.

StopStream

  • — Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKeyto prevent further streaming to a channel.

PutMetadata

  • — Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed.

Stream Key Endpoints

CreateStreamKey

  • — Creates a stream key, used to initiate a stream, for the specified channel ARN.

GetStreamKey

  • — Gets stream key information for the specified ARN.

BatchGetStreamKey

  • — Performs GetStreamKeyon multiple ARNs simultaneously.

ListStreamKeys

  • — Gets summary information about stream keys for the specified channel.

DeleteStreamKey

  • — Deletes the stream key for the specified ARN, so it can no longer be used to stream.

Amazon Web Services Tags Endpoints

TagResource

  • — Adds or updates tags for the Amazon Web Services resource with the specified ARN.

UntagResource

  • — Removes tags from the resource with the specified ARN.

ListTagsForResource

  • — Gets information about Amazon Web Services tags for the specified ARN.

Index

Constants

View Source 
const ServiceAPIVersion = "2020-07-14"
View Source 
const ServiceID = "ivs"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type BatchGetChannelInput 

type BatchGetChannelInput struct {

	// Array of ARNs, one per channel.
	//
	// This member is required.
	Arns []string
	// contains filtered or unexported fields
}

type BatchGetChannelOutput 

type BatchGetChannelOutput struct {

	//
	Channels []types.Channel

	// Each error object is related to a specific ARN in the request.
	Errors []types.BatchError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchGetStreamKeyInput 

type BatchGetStreamKeyInput struct {

	// Array of ARNs, one per stream key.
	//
	// This member is required.
	Arns []string
	// contains filtered or unexported fields
}

type BatchGetStreamKeyOutput 

type BatchGetStreamKeyOutput struct {

	//
	Errors []types.BatchError

	//
	StreamKeys []types.StreamKey

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchStartViewerSessionRevocationInput 

type BatchStartViewerSessionRevocationInput struct {

	// Array of viewer sessions, one per channel-ARN and viewer-ID pair.
	//
	// This member is required.
	ViewerSessions []types.BatchStartViewerSessionRevocationViewerSession
	// contains filtered or unexported fields
}

type BatchStartViewerSessionRevocationOutput 

type BatchStartViewerSessionRevocationOutput struct {

	// Each error object is related to a specific channelArn and viewerId pair in the
	// request.
	Errors []types.BatchStartViewerSessionRevocationError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon Interactive Video Service.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) BatchGetChannel 

func (c *Client) BatchGetChannel(ctx context.Context, params *BatchGetChannelInput, optFns ...func(*Options)) (*BatchGetChannelOutput, error)

Performs GetChannel on multiple ARNs simultaneously.

func (*Client) BatchGetStreamKey 

func (c *Client) BatchGetStreamKey(ctx context.Context, params *BatchGetStreamKeyInput, optFns ...func(*Options)) (*BatchGetStreamKeyOutput, error)

Performs GetStreamKey on multiple ARNs simultaneously.

func (*Client) BatchStartViewerSessionRevocation 

func (c *Client) BatchStartViewerSessionRevocation(ctx context.Context, params *BatchStartViewerSessionRevocationInput, optFns ...func(*Options)) (*BatchStartViewerSessionRevocationOutput, error)

Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.

func (*Client) CreateChannel 

func (c *Client) CreateChannel(ctx context.Context, params *CreateChannelInput, optFns ...func(*Options)) (*CreateChannelOutput, error)

Creates a new channel and an associated stream key to start streaming.

func (*Client) CreatePlaybackRestrictionPolicy 

func (c *Client) CreatePlaybackRestrictionPolicy(ctx context.Context, params *CreatePlaybackRestrictionPolicyInput, optFns ...func(*Options)) (*CreatePlaybackRestrictionPolicyOutput, error)

Creates a new playback restriction policy, for constraining playback by countries and/or origins.

func (*Client) CreateRecordingConfiguration 

func (c *Client) CreateRecordingConfiguration(ctx context.Context, params *CreateRecordingConfigurationInput, optFns ...func(*Options)) (*CreateRecordingConfigurationOutput, error)

Creates a new recording configuration, used to enable recording to Amazon S3.

Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE ). (In other regions, the CLI correctly returns failure if the bucket is in a different region.)

Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.

func (*Client) CreateStreamKey 

func (c *Client) CreateStreamKey(ctx context.Context, params *CreateStreamKeyInput, optFns ...func(*Options)) (*CreateStreamKeyOutput, error)

Creates a stream key, used to initiate a stream, for the specified channel ARN.

Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.

func (*Client) DeleteChannel 

func (c *Client) DeleteChannel(ctx context.Context, params *DeleteChannelInput, optFns ...func(*Options)) (*DeleteChannelOutput, error)

Deletes the specified channel and its associated stream keys.

If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call StopStream, wait for the Amazon EventBridge "Stream End" event (to verify that the stream's state is no longer Live), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)

func (*Client) DeletePlaybackKeyPair 

func (c *Client) DeletePlaybackKeyPair(ctx context.Context, params *DeletePlaybackKeyPairInput, optFns ...func(*Options)) (*DeletePlaybackKeyPairOutput, error)

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.

func (*Client) DeletePlaybackRestrictionPolicy 

func (c *Client) DeletePlaybackRestrictionPolicy(ctx context.Context, params *DeletePlaybackRestrictionPolicyInput, optFns ...func(*Options)) (*DeletePlaybackRestrictionPolicyOutput, error)

Deletes the specified playback restriction policy.

func (*Client) DeleteRecordingConfiguration 

func (c *Client) DeleteRecordingConfiguration(ctx context.Context, params *DeleteRecordingConfigurationInput, optFns ...func(*Options)) (*DeleteRecordingConfigurationOutput, error)

Deletes the recording configuration for the specified ARN.

If you try to delete a recording configuration that is associated with a channel, you will get an error (409 ConflictException). To avoid this, for all channels that reference the recording configuration, first use UpdateChannelto set the recordingConfigurationArn field to an empty string, then use DeleteRecordingConfiguration.

func (*Client) DeleteStreamKey 

func (c *Client) DeleteStreamKey(ctx context.Context, params *DeleteStreamKeyInput, optFns ...func(*Options)) (*DeleteStreamKeyOutput, error)

Deletes the stream key for the specified ARN, so it can no longer be used to stream.

func (*Client) GetChannel 

func (c *Client) GetChannel(ctx context.Context, params *GetChannelInput, optFns ...func(*Options)) (*GetChannelOutput, error)

Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.

func (*Client) GetPlaybackKeyPair 

func (c *Client) GetPlaybackKeyPair(ctx context.Context, params *GetPlaybackKeyPairInput, optFns ...func(*Options)) (*GetPlaybackKeyPairOutput, error)

Gets a specified playback authorization key pair and returns the arn and fingerprint . The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channelsin the Amazon IVS User Guide.

func (*Client) GetPlaybackRestrictionPolicy 

func (c *Client) GetPlaybackRestrictionPolicy(ctx context.Context, params *GetPlaybackRestrictionPolicyInput, optFns ...func(*Options)) (*GetPlaybackRestrictionPolicyOutput, error)

Gets the specified playback restriction policy.

func (*Client) GetRecordingConfiguration 

func (c *Client) GetRecordingConfiguration(ctx context.Context, params *GetRecordingConfigurationInput, optFns ...func(*Options)) (*GetRecordingConfigurationOutput, error)

Gets the recording configuration for the specified ARN.

func (*Client) GetStream 

func (c *Client) GetStream(ctx context.Context, params *GetStreamInput, optFns ...func(*Options)) (*GetStreamOutput, error)

Gets information about the active (live) stream on a specified channel.

func (*Client) GetStreamKey 

func (c *Client) GetStreamKey(ctx context.Context, params *GetStreamKeyInput, optFns ...func(*Options)) (*GetStreamKeyOutput, error)

Gets stream-key information for a specified ARN.

func (*Client) GetStreamSession 

func (c *Client) GetStreamSession(ctx context.Context, params *GetStreamSessionInput, optFns ...func(*Options)) (*GetStreamSessionOutput, error)

Gets metadata on a specified stream.

func (*Client) ImportPlaybackKeyPair 

func (c *Client) ImportPlaybackKeyPair(ctx context.Context, params *ImportPlaybackKeyPairInput, optFns ...func(*Options)) (*ImportPlaybackKeyPairOutput, error)

Imports the public portion of a new key pair and returns its arn and fingerprint . The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channelsin the Amazon IVS User Guide.

func (*Client) ListChannels 

func (c *Client) ListChannels(ctx context.Context, params *ListChannelsInput, optFns ...func(*Options)) (*ListChannelsOutput, error)

Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).

func (*Client) ListPlaybackKeyPairs 

func (c *Client) ListPlaybackKeyPairs(ctx context.Context, params *ListPlaybackKeyPairsInput, optFns ...func(*Options)) (*ListPlaybackKeyPairsOutput, error)

Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

func (*Client) ListPlaybackRestrictionPolicies 

func (c *Client) ListPlaybackRestrictionPolicies(ctx context.Context, params *ListPlaybackRestrictionPoliciesInput, optFns ...func(*Options)) (*ListPlaybackRestrictionPoliciesOutput, error)

Gets summary information about playback restriction policies.

func (*Client) ListRecordingConfigurations 

func (c *Client) ListRecordingConfigurations(ctx context.Context, params *ListRecordingConfigurationsInput, optFns ...func(*Options)) (*ListRecordingConfigurationsOutput, error)

Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.

func (*Client) ListStreamKeys 

func (c *Client) ListStreamKeys(ctx context.Context, params *ListStreamKeysInput, optFns ...func(*Options)) (*ListStreamKeysOutput, error)

Gets summary information about stream keys for the specified channel.

func (*Client) ListStreamSessions 

func (c *Client) ListStreamSessions(ctx context.Context, params *ListStreamSessionsInput, optFns ...func(*Options)) (*ListStreamSessionsOutput, error)

Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.

func (*Client) ListStreams 

func (c *Client) ListStreams(ctx context.Context, params *ListStreamsInput, optFns ...func(*Options)) (*ListStreamsOutput, error)

Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Gets information about Amazon Web Services tags for the specified ARN.

func (*Client) Options 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutMetadata 

func (c *Client) PutMetadata(ctx context.Context, params *PutMetadataInput, optFns ...func(*Options)) (*PutMetadataOutput, error)

Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see Embedding Metadata within a Video Streamin the Amazon IVS User Guide.

func (*Client) StartViewerSessionRevocation 

func (c *Client) StartViewerSessionRevocation(ctx context.Context, params *StartViewerSessionRevocationInput, optFns ...func(*Options)) (*StartViewerSessionRevocationOutput, error)

Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID. Optionally, you can provide a version to revoke viewer sessions less than and including that version. For instructions on associating a viewer ID with a viewer session, see Setting Up Private Channels.

func (*Client) StopStream 

func (c *Client) StopStream(ctx context.Context, params *StopStreamInput, optFns ...func(*Options)) (*StopStreamOutput, error)

Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKeyto prevent further streaming to a channel.

Many streaming client-software libraries automatically reconnect a dropped RTMPS session, so to stop the stream permanently, you may want to first revoke the streamKey attached to the channel.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds or updates tags for the Amazon Web Services resource with the specified ARN.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes tags from the resource with the specified ARN.

func (*Client) UpdateChannel 

func (c *Client) UpdateChannel(ctx context.Context, params *UpdateChannelInput, optFns ...func(*Options)) (*UpdateChannelOutput, error)

Updates a channel's configuration. Live channels cannot be updated. You must stop the ongoing stream, update the channel, and restart the stream for the changes to take effect.

func (*Client) UpdatePlaybackRestrictionPolicy 

func (c *Client) UpdatePlaybackRestrictionPolicy(ctx context.Context, params *UpdatePlaybackRestrictionPolicyInput, optFns ...func(*Options)) (*UpdatePlaybackRestrictionPolicyOutput, error)

Updates a specified playback restriction policy.

type CreateChannelInput 

type CreateChannelInput struct {

	// Whether the channel is private (enabled for playback authorization). Default:
	// false .
	Authorized bool

	// Whether the channel allows insecure RTMP and SRT ingest. Default: false .
	InsecureIngest bool

	// Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full
	// HD. Use LOW for near-real-time interaction with viewers. Default: LOW .
	LatencyMode types.ChannelLatencyMode

	// Channel name.
	Name *string

	// Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN
	// and enables playback restriction. Default: "" (empty string, no playback
	// restriction policy is applied).
	PlaybackRestrictionPolicyArn *string

	// Optional transcode preset for the channel. This is selectable only for
	// ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default
	// preset is HIGHER_BANDWIDTH_DELIVERY . For other channel types ( BASIC and
	// STANDARD ), preset is the empty string ( "" ).
	Preset types.TranscodePreset

	// Recording-configuration ARN. A valid ARN value here both specifies the ARN and
	// enables recording. Default: "" (empty string, recording is disabled).
	RecordingConfigurationArn *string

	// Array of 1-50 maps, each of the form string:string (key:value) . See [Tagging Amazon Web Services Resources] for more
	// information, including restrictions that apply to tags and "Tag naming limits
	// and requirements"; Amazon IVS has no service-specific constraints beyond what is
	// documented there.
	//
	// [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
	Tags map[string]string

	// Channel type, which determines the allowable resolution and bitrate. If you
	// exceed the allowable input resolution or bitrate, the stream probably will
	// disconnect immediately. Default: STANDARD . For details, see [Channel Types].
	//
	// [Channel Types]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html
	Type types.ChannelType
	// contains filtered or unexported fields
}

type CreateChannelOutput 

type CreateChannelOutput struct {

	//
	Channel *types.Channel

	//
	StreamKey *types.StreamKey

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreatePlaybackRestrictionPolicyInput 

type CreatePlaybackRestrictionPolicyInput struct {

	// A list of country codes that control geoblocking restriction. Allowed values
	// are the officially assigned [ISO 3166-1 alpha-2]codes. Default: All countries (an empty array).
	//
	// [ISO 3166-1 alpha-2]: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
	AllowedCountries []string

	// A list of origin sites that control CORS restriction. Allowed values are the
	// same as valid values of the Origin header defined at [https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin]. Default: All origins (an
	// empty array).
	//
	// [https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
	AllowedOrigins []string

	// Whether channel playback is constrained by origin site. Default: false .
	EnableStrictOriginEnforcement *bool

	// Playback-restriction-policy name. The value does not need to be unique.
	Name *string

	// Array of 1-50 maps, each of the form string:string (key:value) . See [Tagging Amazon Web Services Resources] for more
	// information, including restrictions that apply to tags and "Tag naming limits
	// and requirements"; Amazon IVS has no service-specific constraints beyond what is
	// documented there.
	//
	// [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreatePlaybackRestrictionPolicyOutput 

type CreatePlaybackRestrictionPolicyOutput struct {

	//
	PlaybackRestrictionPolicy *types.PlaybackRestrictionPolicy

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateRecordingConfigurationInput 

type CreateRecordingConfigurationInput struct {

	// A complex type that contains a destination configuration for where recorded
	// video will be stored.
	//
	// This member is required.
	DestinationConfiguration *types.DestinationConfiguration

	// Recording-configuration name. The value does not need to be unique.
	Name *string

	// If a broadcast disconnects and then reconnects within the specified interval,
	// the multiple streams will be considered a single broadcast and merged together.
	// Default: 0.
	RecordingReconnectWindowSeconds int32

	// Object that describes which renditions should be recorded for a stream.
	RenditionConfiguration *types.RenditionConfiguration

	// Array of 1-50 maps, each of the form string:string (key:value) . See [Tagging Amazon Web Services Resources] for more
	// information, including restrictions that apply to tags and "Tag naming limits
	// and requirements"; Amazon IVS has no service-specific constraints beyond what is
	// documented there.
	//
	// [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
	Tags map[string]string

	// A complex type that allows you to enable/disable the recording of thumbnails
	// for a live session and modify the interval at which thumbnails are generated for
	// the live session.
	ThumbnailConfiguration *types.ThumbnailConfiguration
	// contains filtered or unexported fields
}

type CreateRecordingConfigurationOutput 

type CreateRecordingConfigurationOutput struct {

	//
	RecordingConfiguration *types.RecordingConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateStreamKeyInput 

type CreateStreamKeyInput struct {

	// ARN of the channel for which to create the stream key.
	//
	// This member is required.
	ChannelArn *string

	// Array of 1-50 maps, each of the form string:string (key:value) . See [Tagging Amazon Web Services Resources] for more
	// information, including restrictions that apply to tags and "Tag naming limits
	// and requirements"; Amazon IVS has no service-specific constraints beyond what is
	// documented there.
	//
	// [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateStreamKeyOutput 

type CreateStreamKeyOutput struct {

	// Stream key used to authenticate an RTMPS stream for ingestion.
	StreamKey *types.StreamKey

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteChannelInput 

type DeleteChannelInput struct {

	// ARN of the channel to be deleted.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type DeleteChannelOutput 

type DeleteChannelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeletePlaybackKeyPairInput 

type DeletePlaybackKeyPairInput struct {

	// ARN of the key pair to be deleted.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type DeletePlaybackKeyPairOutput 

type DeletePlaybackKeyPairOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeletePlaybackRestrictionPolicyInput 

type DeletePlaybackRestrictionPolicyInput struct {

	// ARN of the playback restriction policy to be deleted.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type DeletePlaybackRestrictionPolicyOutput 

type DeletePlaybackRestrictionPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteRecordingConfigurationInput 

type DeleteRecordingConfigurationInput struct {

	// ARN of the recording configuration to be deleted.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type DeleteRecordingConfigurationOutput 

type DeleteRecordingConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteStreamKeyInput 

type DeleteStreamKeyInput struct {

	// ARN of the stream key to be deleted.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type DeleteStreamKeyOutput 

type DeleteStreamKeyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetChannelInput 

type GetChannelInput struct {

	// ARN of the channel for which the configuration is to be retrieved.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type GetChannelOutput 

type GetChannelOutput struct {

	//
	Channel *types.Channel

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetPlaybackKeyPairInput 

type GetPlaybackKeyPairInput struct {

	// ARN of the key pair to be returned.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type GetPlaybackKeyPairOutput 

type GetPlaybackKeyPairOutput struct {

	//
	KeyPair *types.PlaybackKeyPair

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetPlaybackRestrictionPolicyInput 

type GetPlaybackRestrictionPolicyInput struct {

	// ARN of the playback restriction policy to be returned.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type GetPlaybackRestrictionPolicyOutput 

type GetPlaybackRestrictionPolicyOutput struct {

	//
	PlaybackRestrictionPolicy *types.PlaybackRestrictionPolicy

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetRecordingConfigurationInput 

type GetRecordingConfigurationInput struct {

	// ARN of the recording configuration to be retrieved.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type GetRecordingConfigurationOutput 

type GetRecordingConfigurationOutput struct {

	//
	RecordingConfiguration *types.RecordingConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetStreamInput 

type GetStreamInput struct {

	// Channel ARN for stream to be accessed.
	//
	// This member is required.
	ChannelArn *string
	// contains filtered or unexported fields
}

type GetStreamKeyInput 

type GetStreamKeyInput struct {

	// ARN for the stream key to be retrieved.
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

type GetStreamKeyOutput 

type GetStreamKeyOutput struct {

	//
	StreamKey *types.StreamKey

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetStreamOutput 

type GetStreamOutput struct {

	//
	Stream *types.Stream

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetStreamSessionInput 

type GetStreamSessionInput struct {

	// ARN of the channel resource
	//
	// This member is required.
	ChannelArn *string

	// Unique identifier for a live or previously live stream in the specified
	// channel. If no streamId is provided, this returns the most recent stream
	// session for the channel, if it exists.
	StreamId *string
	// contains filtered or unexported fields
}

type GetStreamSessionOutput 

type GetStreamSessionOutput struct {

	// List of stream details.
	StreamSession *types.StreamSession

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ImportPlaybackKeyPairInput 

type ImportPlaybackKeyPairInput struct {

	// The public portion of a customer-generated key pair.
	//
	// This member is required.
	PublicKeyMaterial *string

	// Playback-key-pair name. The value does not need to be unique.
	Name *string

	// Any tags provided with the request are added to the playback key pair tags. See [Tagging Amazon Web Services Resources]
	// for more information, including restrictions that apply to tags and "Tag naming
	// limits and requirements"; Amazon IVS has no service-specific constraints beyond
	// what is documented there.
	//
	// [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
	Tags map[string]string
	// contains filtered or unexported fields
}

type ImportPlaybackKeyPairOutput 

type ImportPlaybackKeyPairOutput struct {

	//
	KeyPair *types.PlaybackKeyPair

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListChannelsAPIClient 

type ListChannelsAPIClient interface {
	ListChannels(context.Context, *ListChannelsInput, ...func(*Options)) (*ListChannelsOutput, error)
}

ListChannelsAPIClient is a client that implements the ListChannels operation.

type ListChannelsInput 

type ListChannelsInput struct {

	// Filters the channel list to match the specified name.
	FilterByName *string

	// Filters the channel list to match the specified policy.
	FilterByPlaybackRestrictionPolicyArn *string

	// Filters the channel list to match the specified recording-configuration ARN.
	FilterByRecordingConfigurationArn *string

	// Maximum number of channels to return. Default: 100.
	MaxResults *int32

	// The first channel to retrieve. This is used for pagination; see the nextToken
	// response field.
	NextToken *string
	// contains filtered or unexported fields
}

type ListChannelsOutput 

type ListChannelsOutput struct {

	// List of the matching channels.
	//
	// This member is required.
	Channels []types.ChannelSummary

	// If there are more channels than maxResults , use nextToken in the request to
	// get the next set.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListChannelsPaginator 

type ListChannelsPaginator struct {
	// contains filtered or unexported fields
}

ListChannelsPaginator is a paginator for ListChannels

func NewListChannelsPaginator 

func NewListChannelsPaginator(client ListChannelsAPIClient, params *ListChannelsInput, optFns ...func(*ListChannelsPaginatorOptions)) *ListChannelsPaginator

NewListChannelsPaginator returns a new ListChannelsPaginator

func (*ListChannelsPaginator) HasMorePages 

func (p *ListChannelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListChannelsPaginator) NextPage 

func (p *ListChannelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListChannelsOutput, error)

NextPage retrieves the next ListChannels page.

type ListChannelsPaginatorOptions 

type ListChannelsPaginatorOptions struct {
	// Maximum number of channels to return. Default: 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListChannelsPaginatorOptions is the paginator options for ListChannels

type ListPlaybackKeyPairsAPIClient 

type ListPlaybackKeyPairsAPIClient interface {
	ListPlaybackKeyPairs(context.Context, *ListPlaybackKeyPairsInput, ...func(*Options)) (*ListPlaybackKeyPairsOutput, error)
}

ListPlaybackKeyPairsAPIClient is a client that implements the ListPlaybackKeyPairs operation.

type ListPlaybackKeyPairsInput 

type ListPlaybackKeyPairsInput struct {

	// Maximum number of key pairs to return. Default: your service quota or 100,
	// whichever is smaller.
	MaxResults *int32

	// The first key pair to retrieve. This is used for pagination; see the nextToken
	// response field.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPlaybackKeyPairsOutput 

type ListPlaybackKeyPairsOutput struct {

	// List of key pairs.
	//
	// This member is required.
	KeyPairs []types.PlaybackKeyPairSummary

	// If there are more key pairs than maxResults , use nextToken in the request to
	// get the next set.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPlaybackKeyPairsPaginator 

type ListPlaybackKeyPairsPaginator struct {
	// contains filtered or unexported fields
}

ListPlaybackKeyPairsPaginator is a paginator for ListPlaybackKeyPairs

func NewListPlaybackKeyPairsPaginator 

func NewListPlaybackKeyPairsPaginator(client ListPlaybackKeyPairsAPIClient, params *ListPlaybackKeyPairsInput, optFns ...func(*ListPlaybackKeyPairsPaginatorOptions)) *ListPlaybackKeyPairsPaginator

NewListPlaybackKeyPairsPaginator returns a new ListPlaybackKeyPairsPaginator

func (*ListPlaybackKeyPairsPaginator) HasMorePages 

func (p *ListPlaybackKeyPairsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPlaybackKeyPairsPaginator) NextPage 

func (p *ListPlaybackKeyPairsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPlaybackKeyPairsOutput, error)

NextPage retrieves the next ListPlaybackKeyPairs page.

type ListPlaybackKeyPairsPaginatorOptions 

type ListPlaybackKeyPairsPaginatorOptions struct {
	// Maximum number of key pairs to return. Default: your service quota or 100,
	// whichever is smaller.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPlaybackKeyPairsPaginatorOptions is the paginator options for ListPlaybackKeyPairs

type ListPlaybackRestrictionPoliciesAPIClient 

type ListPlaybackRestrictionPoliciesAPIClient interface {
	ListPlaybackRestrictionPolicies(context.Context, *ListPlaybackRestrictionPoliciesInput, ...func(*Options)) (*ListPlaybackRestrictionPoliciesOutput, error)
}

ListPlaybackRestrictionPoliciesAPIClient is a client that implements the ListPlaybackRestrictionPolicies operation.

type ListPlaybackRestrictionPoliciesInput 

type ListPlaybackRestrictionPoliciesInput struct {

	// Maximum number of policies to return. Default: 1.
	MaxResults *int32

	// The first policy to retrieve. This is used for pagination; see the nextToken
	// response field.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPlaybackRestrictionPoliciesOutput 

type ListPlaybackRestrictionPoliciesOutput struct {

	// List of the matching policies.
	//
	// This member is required.
	PlaybackRestrictionPolicies []types.PlaybackRestrictionPolicySummary

	// If there are more channels than maxResults , use nextToken in the request to
	// get the next set.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListPlaybackRestrictionPoliciesPaginator 

type ListPlaybackRestrictionPoliciesPaginator struct {
	// contains filtered or unexported fields
}

ListPlaybackRestrictionPoliciesPaginator is a paginator for ListPlaybackRestrictionPolicies

func NewListPlaybackRestrictionPoliciesPaginator 

func NewListPlaybackRestrictionPoliciesPaginator(client ListPlaybackRestrictionPoliciesAPIClient, params *ListPlaybackRestrictionPoliciesInput, optFns ...func(*ListPlaybackRestrictionPoliciesPaginatorOptions)) *ListPlaybackRestrictionPoliciesPaginator

NewListPlaybackRestrictionPoliciesPaginator returns a new ListPlaybackRestrictionPoliciesPaginator

func (*ListPlaybackRestrictionPoliciesPaginator) HasMorePages 

func (p *ListPlaybackRestrictionPoliciesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPlaybackRestrictionPoliciesPaginator) NextPage 

func (p *ListPlaybackRestrictionPoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPlaybackRestrictionPoliciesOutput, error)

NextPage retrieves the next ListPlaybackRestrictionPolicies page.

type ListPlaybackRestrictionPoliciesPaginatorOptions 

type ListPlaybackRestrictionPoliciesPaginatorOptions struct {
	// Maximum number of policies to return. Default: 1.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPlaybackRestrictionPoliciesPaginatorOptions is the paginator options for ListPlaybackRestrictionPolicies

type ListRecordingConfigurationsAPIClient 

type ListRecordingConfigurationsAPIClient interface {
	ListRecordingConfigurations(context.Context, *ListRecordingConfigurationsInput, ...func(*Options)) (*ListRecordingConfigurationsOutput, error)
}

ListRecordingConfigurationsAPIClient is a client that implements the ListRecordingConfigurations operation.

type ListRecordingConfigurationsInput 

type ListRecordingConfigurationsInput struct {

	// Maximum number of recording configurations to return. Default: your service
	// quota or 100, whichever is smaller.
	MaxResults *int32

	// The first recording configuration to retrieve. This is used for pagination; see
	// the nextToken response field.
	NextToken *string
	// contains filtered or unexported fields
}

type ListRecordingConfigurationsOutput 

type ListRecordingConfigurationsOutput struct {

	// List of the matching recording configurations.
	//
	// This member is required.
	RecordingConfigurations []types.RecordingConfigurationSummary

	// If there are more recording configurations than maxResults , use nextToken in
	// the request to get the next set.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRecordingConfigurationsPaginator 

type ListRecordingConfigurationsPaginator struct {
	// contains filtered or unexported fields
}

ListRecordingConfigurationsPaginator is a paginator for ListRecordingConfigurations

func NewListRecordingConfigurationsPaginator 

func NewListRecordingConfigurationsPaginator(client ListRecordingConfigurationsAPIClient, params *ListRecordingConfigurationsInput, optFns ...func(*ListRecordingConfigurationsPaginatorOptions)) *ListRecordingConfigurationsPaginator

NewListRecordingConfigurationsPaginator returns a new ListRecordingConfigurationsPaginator

func (*ListRecordingConfigurationsPaginator) HasMorePages 

func (p *ListRecordingConfigurationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRecordingConfigurationsPaginator) NextPage 

func (p *ListRecordingConfigurationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRecordingConfigurationsOutput, error)

NextPage retrieves the next ListRecordingConfigurations page.

type ListRecordingConfigurationsPaginatorOptions 

type ListRecordingConfigurationsPaginatorOptions struct {
	// Maximum number of recording configurations to return. Default: your service
	// quota or 100, whichever is smaller.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRecordingConfigurationsPaginatorOptions is the paginator options for ListRecordingConfigurations

type ListStreamKeysAPIClient 

type ListStreamKeysAPIClient interface {
	ListStreamKeys(context.Context, *ListStreamKeysInput, ...func(*Options)) (*ListStreamKeysOutput, error)
}

ListStreamKeysAPIClient is a client that implements the ListStreamKeys operation.

type ListStreamKeysInput 

type ListStreamKeysInput struct {

	// Channel ARN used to filter the list.
	//
	// This member is required.
	ChannelArn *string

	// Maximum number of streamKeys to return. Default: 1.
	MaxResults *int32

	// The first stream key to retrieve. This is used for pagination; see the nextToken
	// response field.
	NextToken *string
	// contains filtered or unexported fields
}

type ListStreamKeysOutput 

type ListStreamKeysOutput struct {

	// List of stream keys.
	//
	// This member is required.
	StreamKeys []types.StreamKeySummary

	// If there are more stream keys than maxResults , use nextToken in the request to
	// get the next set.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListStreamKeysPaginator 

type ListStreamKeysPaginator struct {
	// contains filtered or unexported fields
}

ListStreamKeysPaginator is a paginator for ListStreamKeys

func NewListStreamKeysPaginator 

func NewListStreamKeysPaginator(client ListStreamKeysAPIClient, params *ListStreamKeysInput, optFns ...func(*ListStreamKeysPaginatorOptions)) *ListStreamKeysPaginator

NewListStreamKeysPaginator returns a new ListStreamKeysPaginator

func (*ListStreamKeysPaginator) HasMorePages 

func (p *ListStreamKeysPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStreamKeysPaginator) NextPage 

func (p *ListStreamKeysPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStreamKeysOutput, error)

NextPage retrieves the next ListStreamKeys page.

type ListStreamKeysPaginatorOptions 

type ListStreamKeysPaginatorOptions struct {
	// Maximum number of streamKeys to return. Default: 1.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListStreamKeysPaginatorOptions is the paginator options for ListStreamKeys

type ListStreamSessionsAPIClient 

type ListStreamSessionsAPIClient interface {
	ListStreamSessions(context.Context, *ListStreamSessionsInput, ...func(*Options)) (*ListStreamSessionsOutput, error)
}

ListStreamSessionsAPIClient is a client that implements the ListStreamSessions operation.

type ListStreamSessionsInput 

type ListStreamSessionsInput struct {

	// Channel ARN used to filter the list.
	//
	// This member is required.
	ChannelArn *string

	// Maximum number of streams to return. Default: 100.
	MaxResults *int32

	// The first stream to retrieve. This is used for pagination; see the nextToken
	// response field.
	NextToken *string
	// contains filtered or unexported fields
}

type ListStreamSessionsOutput 

type ListStreamSessionsOutput struct {

	// List of stream sessions.
	//
	// This member is required.
	StreamSessions []types.StreamSessionSummary

	// If there are more streams than maxResults , use nextToken in the request to get
	// the next set.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListStreamSessionsPaginator 

type ListStreamSessionsPaginator struct {
	// contains filtered or unexported fields
}

ListStreamSessionsPaginator is a paginator for ListStreamSessions

func NewListStreamSessionsPaginator 

func NewListStreamSessionsPaginator(client ListStreamSessionsAPIClient, params *ListStreamSessionsInput, optFns ...func(*ListStreamSessionsPaginatorOptions)) *ListStreamSessionsPaginator

NewListStreamSessionsPaginator returns a new ListStreamSessionsPaginator

func (*ListStreamSessionsPaginator) HasMorePages 

func (p *ListStreamSessionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStreamSessionsPaginator) NextPage 

func (p *ListStreamSessionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStreamSessionsOutput, error)

NextPage retrieves the next ListStreamSessions page.

type ListStreamSessionsPaginatorOptions 

type ListStreamSessionsPaginatorOptions struct {
	// Maximum number of streams to return. Default: 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListStreamSessionsPaginatorOptions is the paginator options for ListStreamSessions

type ListStreamsAPIClient 

type ListStreamsAPIClient interface {
	ListStreams(context.Context, *ListStreamsInput, ...func(*Options)) (*ListStreamsOutput, error)
}

ListStreamsAPIClient is a client that implements the ListStreams operation.

type ListStreamsInput 

type ListStreamsInput struct {

	// Filters the stream list to match the specified criterion.
	FilterBy *types.StreamFilters

	// Maximum number of streams to return. Default: 100.
	MaxResults *int32

	// The first stream to retrieve. This is used for pagination; see the nextToken
	// response field.
	NextToken *string
	// contains filtered or unexported fields
}

type ListStreamsOutput 

type ListStreamsOutput struct {

	// List of streams.
	//
	// This member is required.
	Streams []types.StreamSummary

	// If there are more streams than maxResults , use nextToken in the request to get
	// the next set.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListStreamsPaginator 

type ListStreamsPaginator struct {
	// contains filtered or unexported fields
}

ListStreamsPaginator is a paginator for ListStreams

func NewListStreamsPaginator 

func NewListStreamsPaginator(client ListStreamsAPIClient, params *ListStreamsInput, optFns ...func(*ListStreamsPaginatorOptions)) *ListStreamsPaginator

NewListStreamsPaginator returns a new ListStreamsPaginator

func (*ListStreamsPaginator) HasMorePages 

func (p *ListStreamsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStreamsPaginator) NextPage 

func (p *ListStreamsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStreamsOutput, error)

NextPage retrieves the next ListStreams page.

type ListStreamsPaginatorOptions 

type ListStreamsPaginatorOptions struct {
	// Maximum number of streams to return. Default: 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListStreamsPaginatorOptions is the paginator options for ListStreams

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN of the resource to be retrieved. The ARN must be URL-encoded.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// Tags attached to the resource. Array of maps, each of the form string:string
	// (key:value) .
	//
	// This member is required.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutMetadataInput 

type PutMetadataInput struct {

	// ARN of the channel into which metadata is inserted. This channel must have an
	// active stream.
	//
	// This member is required.
	ChannelArn *string

	// Metadata to insert into the stream. Maximum: 1 KB per request.
	//
	// This member is required.
	Metadata *string
	// contains filtered or unexported fields
}

type PutMetadataOutput 

type PutMetadataOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartViewerSessionRevocationInput 

type StartViewerSessionRevocationInput struct {

	// The ARN of the channel associated with the viewer session to revoke.
	//
	// This member is required.
	ChannelArn *string

	// The ID of the viewer associated with the viewer session to revoke. Do not use
	// this field for personally identifying, confidential, or sensitive information.
	//
	// This member is required.
	ViewerId *string

	// An optional filter on which versions of the viewer session to revoke. All
	// versions less than or equal to the specified version will be revoked. Default:
	// 0.
	ViewerSessionVersionsLessThanOrEqualTo int32
	// contains filtered or unexported fields
}

type StartViewerSessionRevocationOutput 

type StartViewerSessionRevocationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopStreamInput 

type StopStreamInput struct {

	// ARN of the channel for which the stream is to be stopped.
	//
	// This member is required.
	ChannelArn *string
	// contains filtered or unexported fields
}

type StopStreamOutput 

type StopStreamOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// ARN of the resource for which tags are to be added or updated. The ARN must be
	// URL-encoded.
	//
	// This member is required.
	ResourceArn *string

	// Array of tags to be added or updated. Array of maps, each of the form
	// string:string (key:value) . See [Tagging Amazon Web Services Resources] for more information, including restrictions
	// that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
	// service-specific constraints beyond what is documented there.
	//
	// [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// ARN of the resource for which tags are to be removed. The ARN must be
	// URL-encoded.
	//
	// This member is required.
	ResourceArn *string

	// Array of tags to be removed. Array of maps, each of the form string:string
	// (key:value) . See [Tagging Amazon Web Services Resources] for more information, including restrictions that apply to
	// tags and "Tag naming limits and requirements"; Amazon IVS has no
	// service-specific constraints beyond what is documented there.
	//
	// [Tagging Amazon Web Services Resources]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateChannelInput 

type UpdateChannelInput struct {

	// ARN of the channel to be updated.
	//
	// This member is required.
	Arn *string

	// Whether the channel is private (enabled for playback authorization).
	Authorized bool

	// Whether the channel allows insecure RTMP and SRT ingest. Default: false .
	InsecureIngest bool

	// Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full
	// HD. Use LOW for near-real-time interaction with viewers.
	LatencyMode types.ChannelLatencyMode

	// Channel name.
	Name *string

	// Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN
	// and enables playback restriction. If this is set to an empty string, playback
	// restriction policy is disabled.
	PlaybackRestrictionPolicyArn *string

	// Optional transcode preset for the channel. This is selectable only for
	// ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default
	// preset is HIGHER_BANDWIDTH_DELIVERY . For other channel types ( BASIC and
	// STANDARD ), preset is the empty string ( "" ).
	Preset types.TranscodePreset

	// Recording-configuration ARN. A valid ARN value here both specifies the ARN and
	// enables recording. If this is set to an empty string, recording is disabled.
	RecordingConfigurationArn *string

	// Channel type, which determines the allowable resolution and bitrate. If you
	// exceed the allowable input resolution or bitrate, the stream probably will
	// disconnect immediately. Default: STANDARD . For details, see [Channel Types].
	//
	// [Channel Types]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html
	Type types.ChannelType
	// contains filtered or unexported fields
}

type UpdateChannelOutput 

type UpdateChannelOutput struct {

	// Object specifying the updated channel.
	Channel *types.Channel

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdatePlaybackRestrictionPolicyInput 

type UpdatePlaybackRestrictionPolicyInput struct {

	// ARN of the playback-restriction-policy to be updated.
	//
	// This member is required.
	Arn *string

	// A list of country codes that control geoblocking restriction. Allowed values
	// are the officially assigned [ISO 3166-1 alpha-2]codes. Default: All countries (an empty array).
	//
	// [ISO 3166-1 alpha-2]: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
	AllowedCountries []string

	// A list of origin sites that control CORS restriction. Allowed values are the
	// same as valid values of the Origin header defined at [https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin]. Default: All origins (an
	// empty array).
	//
	// [https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
	AllowedOrigins []string

	// Whether channel playback is constrained by origin site. Default: false .
	EnableStrictOriginEnforcement *bool

	// Playback-restriction-policy name. The value does not need to be unique.
	Name *string
	// contains filtered or unexported fields
}

type UpdatePlaybackRestrictionPolicyOutput 

type UpdatePlaybackRestrictionPolicyOutput struct {

	// Object specifying the updated policy.
	PlaybackRestrictionPolicy *types.PlaybackRestrictionPolicy

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.