Documentation ¶
Overview ¶
Package mediapackagev2 provides the API client, operations, and parameter types for AWS Elemental MediaPackage v2.
This guide is intended for creating AWS Elemental MediaPackage resources in MediaPackage Version 2 (v2) starting from May 2023. To get started with MediaPackage v2, create your MediaPackage resources. There isn't an automated process to migrate your resources from MediaPackage v1 to MediaPackage v2.
The names of the entities that you use to access this API, like URLs and ARNs, all have the versioning information added, like "v2", to distinguish from the prior version. If you used MediaPackage prior to this release, you can't use the MediaPackage v2 CLI or the MediaPackage v2 API to access any MediaPackage v1 resources.
If you created resources in MediaPackage v1, use video on demand (VOD) workflows, and aren't looking to migrate to MediaPackage v2 yet, see the MediaPackage v1 Live API Reference.
This is the AWS Elemental MediaPackage v2 Live REST API Reference. It describes all the MediaPackage API operations for live content in detail, and provides sample requests, responses, and errors for the supported web services protocols.
We assume that you have the IAM permissions that you need to use MediaPackage via the REST API. We also assume that you are familiar with the features and operations of MediaPackage, as described in the AWS Elemental MediaPackage User Guide.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AuthResolverParameters
- type AuthSchemeResolver
- type CancelHarvestJobInput
- type CancelHarvestJobOutput
- type Client
- func (c *Client) CancelHarvestJob(ctx context.Context, params *CancelHarvestJobInput, optFns ...func(*Options)) (*CancelHarvestJobOutput, error)
- func (c *Client) CreateChannel(ctx context.Context, params *CreateChannelInput, optFns ...func(*Options)) (*CreateChannelOutput, error)
- func (c *Client) CreateChannelGroup(ctx context.Context, params *CreateChannelGroupInput, optFns ...func(*Options)) (*CreateChannelGroupOutput, error)
- func (c *Client) CreateHarvestJob(ctx context.Context, params *CreateHarvestJobInput, optFns ...func(*Options)) (*CreateHarvestJobOutput, error)
- func (c *Client) CreateOriginEndpoint(ctx context.Context, params *CreateOriginEndpointInput, ...) (*CreateOriginEndpointOutput, error)
- func (c *Client) DeleteChannel(ctx context.Context, params *DeleteChannelInput, optFns ...func(*Options)) (*DeleteChannelOutput, error)
- func (c *Client) DeleteChannelGroup(ctx context.Context, params *DeleteChannelGroupInput, optFns ...func(*Options)) (*DeleteChannelGroupOutput, error)
- func (c *Client) DeleteChannelPolicy(ctx context.Context, params *DeleteChannelPolicyInput, ...) (*DeleteChannelPolicyOutput, error)
- func (c *Client) DeleteOriginEndpoint(ctx context.Context, params *DeleteOriginEndpointInput, ...) (*DeleteOriginEndpointOutput, error)
- func (c *Client) DeleteOriginEndpointPolicy(ctx context.Context, params *DeleteOriginEndpointPolicyInput, ...) (*DeleteOriginEndpointPolicyOutput, error)
- func (c *Client) GetChannel(ctx context.Context, params *GetChannelInput, optFns ...func(*Options)) (*GetChannelOutput, error)
- func (c *Client) GetChannelGroup(ctx context.Context, params *GetChannelGroupInput, optFns ...func(*Options)) (*GetChannelGroupOutput, error)
- func (c *Client) GetChannelPolicy(ctx context.Context, params *GetChannelPolicyInput, optFns ...func(*Options)) (*GetChannelPolicyOutput, error)
- func (c *Client) GetHarvestJob(ctx context.Context, params *GetHarvestJobInput, optFns ...func(*Options)) (*GetHarvestJobOutput, error)
- func (c *Client) GetOriginEndpoint(ctx context.Context, params *GetOriginEndpointInput, optFns ...func(*Options)) (*GetOriginEndpointOutput, error)
- func (c *Client) GetOriginEndpointPolicy(ctx context.Context, params *GetOriginEndpointPolicyInput, ...) (*GetOriginEndpointPolicyOutput, error)
- func (c *Client) ListChannelGroups(ctx context.Context, params *ListChannelGroupsInput, optFns ...func(*Options)) (*ListChannelGroupsOutput, error)
- func (c *Client) ListChannels(ctx context.Context, params *ListChannelsInput, optFns ...func(*Options)) (*ListChannelsOutput, error)
- func (c *Client) ListHarvestJobs(ctx context.Context, params *ListHarvestJobsInput, optFns ...func(*Options)) (*ListHarvestJobsOutput, error)
- func (c *Client) ListOriginEndpoints(ctx context.Context, params *ListOriginEndpointsInput, ...) (*ListOriginEndpointsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) Options() Options
- func (c *Client) PutChannelPolicy(ctx context.Context, params *PutChannelPolicyInput, optFns ...func(*Options)) (*PutChannelPolicyOutput, error)
- func (c *Client) PutOriginEndpointPolicy(ctx context.Context, params *PutOriginEndpointPolicyInput, ...) (*PutOriginEndpointPolicyOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateChannel(ctx context.Context, params *UpdateChannelInput, optFns ...func(*Options)) (*UpdateChannelOutput, error)
- func (c *Client) UpdateChannelGroup(ctx context.Context, params *UpdateChannelGroupInput, optFns ...func(*Options)) (*UpdateChannelGroupOutput, error)
- func (c *Client) UpdateOriginEndpoint(ctx context.Context, params *UpdateOriginEndpointInput, ...) (*UpdateOriginEndpointOutput, error)
- type CreateChannelGroupInput
- type CreateChannelGroupOutput
- type CreateChannelInput
- type CreateChannelOutput
- type CreateHarvestJobInput
- type CreateHarvestJobOutput
- type CreateOriginEndpointInput
- type CreateOriginEndpointOutput
- type DeleteChannelGroupInput
- type DeleteChannelGroupOutput
- type DeleteChannelInput
- type DeleteChannelOutput
- type DeleteChannelPolicyInput
- type DeleteChannelPolicyOutput
- type DeleteOriginEndpointInput
- type DeleteOriginEndpointOutput
- type DeleteOriginEndpointPolicyInput
- type DeleteOriginEndpointPolicyOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type GetChannelGroupInput
- type GetChannelGroupOutput
- type GetChannelInput
- type GetChannelOutput
- type GetChannelPolicyInput
- type GetChannelPolicyOutput
- type GetHarvestJobAPIClient
- type GetHarvestJobInput
- type GetHarvestJobOutput
- type GetOriginEndpointInput
- type GetOriginEndpointOutput
- type GetOriginEndpointPolicyInput
- type GetOriginEndpointPolicyOutput
- type HTTPClient
- type HTTPSignerV4
- type HarvestJobFinishedWaiter
- type HarvestJobFinishedWaiterOptions
- type IdempotencyTokenProvider
- type ListChannelGroupsAPIClient
- type ListChannelGroupsInput
- type ListChannelGroupsOutput
- type ListChannelGroupsPaginator
- type ListChannelGroupsPaginatorOptions
- type ListChannelsAPIClient
- type ListChannelsInput
- type ListChannelsOutput
- type ListChannelsPaginator
- type ListChannelsPaginatorOptions
- type ListHarvestJobsAPIClient
- type ListHarvestJobsInput
- type ListHarvestJobsOutput
- type ListHarvestJobsPaginator
- type ListHarvestJobsPaginatorOptions
- type ListOriginEndpointsAPIClient
- type ListOriginEndpointsInput
- type ListOriginEndpointsOutput
- type ListOriginEndpointsPaginator
- type ListOriginEndpointsPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type PutChannelPolicyInput
- type PutChannelPolicyOutput
- type PutOriginEndpointPolicyInput
- type PutOriginEndpointPolicyOutput
- type ResolveEndpoint
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateChannelGroupInput
- type UpdateChannelGroupOutput
- type UpdateChannelInput
- type UpdateChannelOutput
- type UpdateOriginEndpointInput
- type UpdateOriginEndpointOutput
Constants ¶
const ServiceAPIVersion = "2022-12-25"
const ServiceID = "MediaPackageV2"
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 ¶ added in v1.1.0
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithSigV4SigningName ¶ added in v1.6.2
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 ¶ added in v1.6.2
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 ¶ added in v1.6.2
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 ¶ added in v1.6.2
type AuthSchemeResolver interface {
ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}
AuthSchemeResolver returns a set of possible authentication options for an operation.
type CancelHarvestJobInput ¶ added in v1.19.0
type CancelHarvestJobInput struct { // The name of the channel group containing the channel from which the harvest job // is running. // // This member is required. ChannelGroupName *string // The name of the channel from which the harvest job is running. // // This member is required. ChannelName *string // The name of the harvest job to cancel. This name must be unique within the // channel and cannot be changed after the harvest job is submitted. // // This member is required. HarvestJobName *string // The name of the origin endpoint that the harvest job is harvesting from. This // cannot be changed after the harvest job is submitted. // // This member is required. OriginEndpointName *string // The current Entity Tag (ETag) associated with the harvest job. Used for // concurrency control. ETag *string // contains filtered or unexported fields }
type CancelHarvestJobOutput ¶ added in v1.19.0
type CancelHarvestJobOutput struct { // 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 AWS Elemental MediaPackage v2.
func New ¶
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 ¶
NewFromConfig returns a new client from the provided config.
func (*Client) CancelHarvestJob ¶ added in v1.19.0
func (c *Client) CancelHarvestJob(ctx context.Context, params *CancelHarvestJobInput, optFns ...func(*Options)) (*CancelHarvestJobOutput, error)
Cancels an in-progress harvest job.
func (*Client) CreateChannel ¶
func (c *Client) CreateChannel(ctx context.Context, params *CreateChannelInput, optFns ...func(*Options)) (*CreateChannelOutput, error)
Create a channel to start receiving content streams. The channel represents the input to MediaPackage for incoming live content from an encoder such as AWS Elemental MediaLive. The channel receives content, and after packaging it, outputs it through an origin endpoint to downstream devices (such as video players or CDNs) that request the content. You can create only one channel with each request. We recommend that you spread out channels between channel groups, such as putting redundant channels in the same AWS Region in different channel groups.
func (*Client) CreateChannelGroup ¶
func (c *Client) CreateChannelGroup(ctx context.Context, params *CreateChannelGroupInput, optFns ...func(*Options)) (*CreateChannelGroupOutput, error)
Create a channel group to group your channels and origin endpoints. A channel group is the top-level resource that consists of channels and origin endpoints that are associated with it and that provides predictable URLs for stream delivery. All channels and origin endpoints within the channel group are guaranteed to share the DNS. You can create only one channel group with each request.
func (*Client) CreateHarvestJob ¶ added in v1.19.0
func (c *Client) CreateHarvestJob(ctx context.Context, params *CreateHarvestJobInput, optFns ...func(*Options)) (*CreateHarvestJobOutput, error)
Creates a new harvest job to export content from a MediaPackage v2 channel to an S3 bucket.
func (*Client) CreateOriginEndpoint ¶
func (c *Client) CreateOriginEndpoint(ctx context.Context, params *CreateOriginEndpointInput, optFns ...func(*Options)) (*CreateOriginEndpointOutput, error)
The endpoint is attached to a channel, and represents the output of the live content. You can associate multiple endpoints to a single channel. Each endpoint gives players and downstream CDNs (such as Amazon CloudFront) access to the content for playback. Content can't be served from a channel until it has an endpoint. You can create only one endpoint with each request.
func (*Client) DeleteChannel ¶
func (c *Client) DeleteChannel(ctx context.Context, params *DeleteChannelInput, optFns ...func(*Options)) (*DeleteChannelOutput, error)
Delete a channel to stop AWS Elemental MediaPackage from receiving further content. You must delete the channel's origin endpoints before you can delete the channel.
func (*Client) DeleteChannelGroup ¶
func (c *Client) DeleteChannelGroup(ctx context.Context, params *DeleteChannelGroupInput, optFns ...func(*Options)) (*DeleteChannelGroupOutput, error)
Delete a channel group. You must delete the channel group's channels and origin endpoints before you can delete the channel group. If you delete a channel group, you'll lose access to the egress domain and will have to create a new channel group to replace it.
func (*Client) DeleteChannelPolicy ¶
func (c *Client) DeleteChannelPolicy(ctx context.Context, params *DeleteChannelPolicyInput, optFns ...func(*Options)) (*DeleteChannelPolicyOutput, error)
Delete a channel policy.
func (*Client) DeleteOriginEndpoint ¶
func (c *Client) DeleteOriginEndpoint(ctx context.Context, params *DeleteOriginEndpointInput, optFns ...func(*Options)) (*DeleteOriginEndpointOutput, error)
Origin endpoints can serve content until they're deleted. Delete the endpoint if it should no longer respond to playback requests. You must delete all endpoints from a channel before you can delete the channel.
func (*Client) DeleteOriginEndpointPolicy ¶
func (c *Client) DeleteOriginEndpointPolicy(ctx context.Context, params *DeleteOriginEndpointPolicyInput, optFns ...func(*Options)) (*DeleteOriginEndpointPolicyOutput, error)
Delete an origin endpoint policy.
func (*Client) GetChannel ¶
func (c *Client) GetChannel(ctx context.Context, params *GetChannelInput, optFns ...func(*Options)) (*GetChannelOutput, error)
Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.
func (*Client) GetChannelGroup ¶
func (c *Client) GetChannelGroup(ctx context.Context, params *GetChannelGroupInput, optFns ...func(*Options)) (*GetChannelGroupOutput, error)
Retrieves the specified channel group that's configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
func (*Client) GetChannelPolicy ¶
func (c *Client) GetChannelPolicy(ctx context.Context, params *GetChannelPolicyInput, optFns ...func(*Options)) (*GetChannelPolicyOutput, error)
Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources.
func (*Client) GetHarvestJob ¶ added in v1.19.0
func (c *Client) GetHarvestJob(ctx context.Context, params *GetHarvestJobInput, optFns ...func(*Options)) (*GetHarvestJobOutput, error)
Retrieves the details of a specific harvest job.
func (*Client) GetOriginEndpoint ¶
func (c *Client) GetOriginEndpoint(ctx context.Context, params *GetOriginEndpointInput, optFns ...func(*Options)) (*GetOriginEndpointOutput, error)
Retrieves the specified origin endpoint that's configured in AWS Elemental MediaPackage to obtain its playback URL and to view the packaging settings that it's currently using.
func (*Client) GetOriginEndpointPolicy ¶
func (c *Client) GetOriginEndpointPolicy(ctx context.Context, params *GetOriginEndpointPolicyInput, optFns ...func(*Options)) (*GetOriginEndpointPolicyOutput, error)
Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.
func (*Client) ListChannelGroups ¶
func (c *Client) ListChannelGroups(ctx context.Context, params *ListChannelGroupsInput, optFns ...func(*Options)) (*ListChannelGroupsOutput, error)
Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
func (*Client) ListChannels ¶
func (c *Client) ListChannels(ctx context.Context, params *ListChannelsInput, optFns ...func(*Options)) (*ListChannelsOutput, error)
Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.
func (*Client) ListHarvestJobs ¶ added in v1.19.0
func (c *Client) ListHarvestJobs(ctx context.Context, params *ListHarvestJobsInput, optFns ...func(*Options)) (*ListHarvestJobsOutput, error)
Retrieves a list of harvest jobs that match the specified criteria.
func (*Client) ListOriginEndpoints ¶
func (c *Client) ListOriginEndpoints(ctx context.Context, params *ListOriginEndpointsInput, optFns ...func(*Options)) (*ListOriginEndpointsOutput, error)
Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Lists the tags assigned to a resource.
func (*Client) Options ¶ added in v1.7.0
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) PutChannelPolicy ¶
func (c *Client) PutChannelPolicy(ctx context.Context, params *PutChannelPolicyInput, optFns ...func(*Options)) (*PutChannelPolicyOutput, error)
Attaches an IAM policy to the specified channel. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources. You can attach only one policy with each request.
func (*Client) PutOriginEndpointPolicy ¶
func (c *Client) PutOriginEndpointPolicy(ctx context.Context, params *PutOriginEndpointPolicyInput, optFns ...func(*Options)) (*PutOriginEndpointPolicyOutput, error)
Attaches an IAM policy to the specified origin endpoint. You can attach only one policy with each request.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Assigns one of more tags (key-value pairs) to the specified MediaPackage resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes one or more tags from the specified resource.
func (*Client) UpdateChannel ¶
func (c *Client) UpdateChannel(ctx context.Context, params *UpdateChannelInput, optFns ...func(*Options)) (*UpdateChannelOutput, error)
Update the specified channel. You can edit if MediaPackage sends ingest or egress access logs to the CloudWatch log group, if content will be encrypted, the description on a channel, and your channel's policy settings. You can't edit the name of the channel or CloudFront distribution details.
Any edits you make that impact the video output may not be reflected for a few minutes.
func (*Client) UpdateChannelGroup ¶
func (c *Client) UpdateChannelGroup(ctx context.Context, params *UpdateChannelGroupInput, optFns ...func(*Options)) (*UpdateChannelGroupOutput, error)
Update the specified channel group. You can edit the description on a channel group for easier identification later from the AWS Elemental MediaPackage console. You can't edit the name of the channel group.
Any edits you make that impact the video output may not be reflected for a few minutes.
func (*Client) UpdateOriginEndpoint ¶
func (c *Client) UpdateOriginEndpoint(ctx context.Context, params *UpdateOriginEndpointInput, optFns ...func(*Options)) (*UpdateOriginEndpointOutput, error)
Update the specified origin endpoint. Edit the packaging preferences on an endpoint to optimize the viewing experience. You can't edit the name of the endpoint.
Any edits you make that impact the video output may not be reflected for a few minutes.
type CreateChannelGroupInput ¶
type CreateChannelGroupInput struct { // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // You can't use spaces in the name. You can't change the name after you create the // channel group. // // This member is required. ChannelGroupName *string // A unique, case-sensitive token that you provide to ensure the idempotency of // the request. ClientToken *string // Enter any descriptive text that helps you to identify the channel group. Description *string // A comma-separated list of tag key:value pairs that you define. For example: // // "Key1": "Value1", // // "Key2": "Value2" Tags map[string]string // contains filtered or unexported fields }
type CreateChannelGroupOutput ¶
type CreateChannelGroupOutput struct { // The Amazon Resource Name (ARN) associated with the resource. // // This member is required. Arn *string // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The date and time the channel group was created. // // This member is required. CreatedAt *time.Time // The output domain where the source stream should be sent. Integrate the egress // domain with a downstream CDN (such as Amazon CloudFront) or playback device. // // This member is required. EgressDomain *string // The date and time the channel group was modified. // // This member is required. ModifiedAt *time.Time // The description for your channel group. Description *string // The current Entity Tag (ETag) associated with this resource. The entity tag can // be used to safely make concurrent updates to the resource. ETag *string // The comma-separated list of tag key:value pairs assigned to the channel group. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateChannelInput ¶
type CreateChannelInput struct { // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. You can't change the name after you create the channel. // // This member is required. ChannelName *string // A unique, case-sensitive token that you provide to ensure the idempotency of // the request. ClientToken *string // Enter any descriptive text that helps you to identify the channel. Description *string // The configuration for input switching based on the media quality confidence // score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid // only when InputType is CMAF . InputSwitchConfiguration *types.InputSwitchConfiguration // The input type will be an immutable field which will be used to define whether // the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default // to HLS to preserve current behavior. // // The allowed values are: // // - HLS - The HLS streaming specification (which defines M3U8 manifests and TS // segments). // // - CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments // with optional DASH manifests). InputType types.InputType // The settings for what common media server data (CMSD) headers AWS Elemental // MediaPackage includes in responses to the CDN. This setting is valid only when // InputType is CMAF . OutputHeaderConfiguration *types.OutputHeaderConfiguration // A comma-separated list of tag key:value pairs that you define. For example: // // "Key1": "Value1", // // "Key2": "Value2" Tags map[string]string // contains filtered or unexported fields }
type CreateChannelOutput ¶
type CreateChannelOutput struct { // The Amazon Resource Name (ARN) associated with the resource. // // This member is required. Arn *string // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. // // This member is required. ChannelName *string // The date and time the channel was created. // // This member is required. CreatedAt *time.Time // The date and time the channel was modified. // // This member is required. ModifiedAt *time.Time // The description for your channel. Description *string // The current Entity Tag (ETag) associated with this resource. The entity tag can // be used to safely make concurrent updates to the resource. ETag *string // The list of ingest endpoints. IngestEndpoints []types.IngestEndpoint // The configuration for input switching based on the media quality confidence // score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid // only when InputType is CMAF . InputSwitchConfiguration *types.InputSwitchConfiguration // The input type will be an immutable field which will be used to define whether // the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default // to HLS to preserve current behavior. // // The allowed values are: // // - HLS - The HLS streaming specification (which defines M3U8 manifests and TS // segments). // // - CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments // with optional DASH manifests). InputType types.InputType // The settings for what common media server data (CMSD) headers AWS Elemental // MediaPackage includes in responses to the CDN. This setting is valid only when // InputType is CMAF . OutputHeaderConfiguration *types.OutputHeaderConfiguration // The comma-separated list of tag key:value pairs assigned to the channel. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateHarvestJobInput ¶ added in v1.19.0
type CreateHarvestJobInput struct { // The name of the channel group containing the channel from which to harvest // content. // // This member is required. ChannelGroupName *string // The name of the channel from which to harvest content. // // This member is required. ChannelName *string // The S3 destination where the harvested content will be placed. // // This member is required. Destination *types.Destination // A list of manifests to be harvested. // // This member is required. HarvestedManifests *types.HarvestedManifests // The name of the origin endpoint from which to harvest content. // // This member is required. OriginEndpointName *string // The configuration for when the harvest job should run, including start and end // times. // // This member is required. ScheduleConfiguration *types.HarvesterScheduleConfiguration // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientToken *string // An optional description for the harvest job. Description *string // A name for the harvest job. This name must be unique within the channel. HarvestJobName *string // A collection of tags associated with the harvest job. Tags map[string]string // contains filtered or unexported fields }
The request object for creating a new harvest job.
type CreateHarvestJobOutput ¶ added in v1.19.0
type CreateHarvestJobOutput struct { // The Amazon Resource Name (ARN) of the created harvest job. // // This member is required. Arn *string // The name of the channel group containing the channel from which content is // being harvested. // // This member is required. ChannelGroupName *string // The name of the channel from which content is being harvested. // // This member is required. ChannelName *string // The date and time the harvest job was created. // // This member is required. CreatedAt *time.Time // The S3 destination where the harvested content will be placed. // // This member is required. Destination *types.Destination // The name of the created harvest job. // // This member is required. HarvestJobName *string // A list of manifests that will be harvested. // // This member is required. HarvestedManifests *types.HarvestedManifests // The date and time the harvest job was last modified. // // This member is required. ModifiedAt *time.Time // The name of the origin endpoint from which content is being harvested. // // This member is required. OriginEndpointName *string // The configuration for when the harvest job will run, including start and end // times. // // This member is required. ScheduleConfiguration *types.HarvesterScheduleConfiguration // The current status of the harvest job (e.g., CREATED, IN_PROGRESS, ABORTED, // COMPLETED, FAILED). // // This member is required. Status types.HarvestJobStatus // The description of the harvest job, if provided. Description *string // The current version of the harvest job. Used for concurrency control. ETag *string // An error message if the harvest job creation failed. ErrorMessage *string // A collection of tags associated with the harvest job. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
The response object returned after creating a harvest job.
type CreateOriginEndpointInput ¶
type CreateOriginEndpointInput struct { // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. // // This member is required. ChannelName *string // The type of container to attach to this origin endpoint. A container type is a // file format that encapsulates one or more media streams, such as audio and // video, into a single file. You can't change the container type after you create // the endpoint. // // This member is required. ContainerType types.ContainerType // The name that describes the origin endpoint. The name is the primary identifier // for the origin endpoint, and must be unique for your account in the AWS Region // and channel. You can't use spaces in the name. You can't change the name after // you create the endpoint. // // This member is required. OriginEndpointName *string // A unique, case-sensitive token that you provide to ensure the idempotency of // the request. ClientToken *string // A DASH manifest configuration. DashManifests []types.CreateDashManifestConfiguration // Enter any descriptive text that helps you to identify the origin endpoint. Description *string // The failover settings for the endpoint. ForceEndpointErrorConfiguration *types.ForceEndpointErrorConfiguration // An HTTP live streaming (HLS) manifest configuration. HlsManifests []types.CreateHlsManifestConfiguration // A low-latency HLS manifest configuration. LowLatencyHlsManifests []types.CreateLowLatencyHlsManifestConfiguration // The segment configuration, including the segment name, duration, and other // configuration values. Segment *types.Segment // The size of the window (in seconds) to create a window of the live stream // that's available for on-demand viewing. Viewers can start-over or catch-up on // content that falls within the window. The maximum startover window is 1,209,600 // seconds (14 days). StartoverWindowSeconds *int32 // A comma-separated list of tag key:value pairs that you define. For example: // // "Key1": "Value1", // // "Key2": "Value2" Tags map[string]string // contains filtered or unexported fields }
type CreateOriginEndpointOutput ¶
type CreateOriginEndpointOutput struct { // The Amazon Resource Name (ARN) associated with the resource. // // This member is required. Arn *string // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. // // This member is required. ChannelName *string // The type of container attached to this origin endpoint. // // This member is required. ContainerType types.ContainerType // The date and time the origin endpoint was created. // // This member is required. CreatedAt *time.Time // The date and time the origin endpoint was modified. // // This member is required. ModifiedAt *time.Time // The name that describes the origin endpoint. The name is the primary identifier // for the origin endpoint, and and must be unique for your account in the AWS // Region and channel. // // This member is required. OriginEndpointName *string // The segment configuration, including the segment name, duration, and other // configuration values. // // This member is required. Segment *types.Segment // A DASH manifest configuration. DashManifests []types.GetDashManifestConfiguration // The description for your origin endpoint. Description *string // The current Entity Tag (ETag) associated with this resource. The entity tag can // be used to safely make concurrent updates to the resource. ETag *string // The failover settings for the endpoint. ForceEndpointErrorConfiguration *types.ForceEndpointErrorConfiguration // An HTTP live streaming (HLS) manifest configuration. HlsManifests []types.GetHlsManifestConfiguration // A low-latency HLS manifest configuration. LowLatencyHlsManifests []types.GetLowLatencyHlsManifestConfiguration // The size of the window (in seconds) to create a window of the live stream // that's available for on-demand viewing. Viewers can start-over or catch-up on // content that falls within the window. StartoverWindowSeconds *int32 // The comma-separated list of tag key:value pairs assigned to the origin endpoint. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteChannelGroupInput ¶
type DeleteChannelGroupInput struct { // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // contains filtered or unexported fields }
type DeleteChannelGroupOutput ¶
type DeleteChannelGroupOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteChannelInput ¶
type DeleteChannelInput struct { // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. // // This member is required. ChannelName *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 DeleteChannelPolicyInput ¶
type DeleteChannelPolicyInput struct { // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. // // This member is required. ChannelName *string // contains filtered or unexported fields }
type DeleteChannelPolicyOutput ¶
type DeleteChannelPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteOriginEndpointInput ¶
type DeleteOriginEndpointInput struct { // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. // // This member is required. ChannelName *string // The name that describes the origin endpoint. The name is the primary identifier // for the origin endpoint, and and must be unique for your account in the AWS // Region and channel. // // This member is required. OriginEndpointName *string // contains filtered or unexported fields }
type DeleteOriginEndpointOutput ¶
type DeleteOriginEndpointOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteOriginEndpointPolicyInput ¶
type DeleteOriginEndpointPolicyInput struct { // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. // // This member is required. ChannelName *string // The name that describes the origin endpoint. The name is the primary identifier // for the origin endpoint, and and must be unique for your account in the AWS // Region and channel. // // This member is required. OriginEndpointName *string // contains filtered or unexported fields }
type DeleteOriginEndpointPolicyOutput ¶
type DeleteOriginEndpointPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointParameters ¶ added in v1.1.0
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 ¶ added in v1.1.0
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶ added in v1.1.0
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 ¶ added in v1.1.0
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 ¶ added in v1.1.0
func NewDefaultEndpointResolverV2() EndpointResolverV2
type GetChannelGroupInput ¶
type GetChannelGroupInput struct { // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // contains filtered or unexported fields }
type GetChannelGroupOutput ¶
type GetChannelGroupOutput struct { // The Amazon Resource Name (ARN) associated with the resource. // // This member is required. Arn *string // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The date and time the channel group was created. // // This member is required. CreatedAt *time.Time // The output domain where the source stream should be sent. Integrate the domain // with a downstream CDN (such as Amazon CloudFront) or playback device. // // This member is required. EgressDomain *string // The date and time the channel group was modified. // // This member is required. ModifiedAt *time.Time // The description for your channel group. Description *string // The current Entity Tag (ETag) associated with this resource. The entity tag can // be used to safely make concurrent updates to the resource. ETag *string // The comma-separated list of tag key:value pairs assigned to the channel group. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetChannelInput ¶
type GetChannelInput struct { // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. // // This member is required. ChannelName *string // contains filtered or unexported fields }
type GetChannelOutput ¶
type GetChannelOutput struct { // The Amazon Resource Name (ARN) associated with the resource. // // This member is required. Arn *string // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. // // This member is required. ChannelName *string // The date and time the channel was created. // // This member is required. CreatedAt *time.Time // The date and time the channel was modified. // // This member is required. ModifiedAt *time.Time // The description for your channel. Description *string // The current Entity Tag (ETag) associated with this resource. The entity tag can // be used to safely make concurrent updates to the resource. ETag *string // The list of ingest endpoints. IngestEndpoints []types.IngestEndpoint // The configuration for input switching based on the media quality confidence // score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid // only when InputType is CMAF . InputSwitchConfiguration *types.InputSwitchConfiguration // The input type will be an immutable field which will be used to define whether // the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default // to HLS to preserve current behavior. // // The allowed values are: // // - HLS - The HLS streaming specification (which defines M3U8 manifests and TS // segments). // // - CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments // with optional DASH manifests). InputType types.InputType // The settings for what common media server data (CMSD) headers AWS Elemental // MediaPackage includes in responses to the CDN. This setting is valid only when // InputType is CMAF . OutputHeaderConfiguration *types.OutputHeaderConfiguration // The comma-separated list of tag key:value pairs assigned to the channel. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetChannelPolicyInput ¶
type GetChannelPolicyInput struct { // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. // // This member is required. ChannelName *string // contains filtered or unexported fields }
type GetChannelPolicyOutput ¶
type GetChannelPolicyOutput struct { // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. // // This member is required. ChannelName *string // The policy assigned to the channel. // // This member is required. Policy *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetHarvestJobAPIClient ¶ added in v1.19.0
type GetHarvestJobAPIClient interface {
GetHarvestJob(context.Context, *GetHarvestJobInput, ...func(*Options)) (*GetHarvestJobOutput, error)
}
GetHarvestJobAPIClient is a client that implements the GetHarvestJob operation.
type GetHarvestJobInput ¶ added in v1.19.0
type GetHarvestJobInput struct { // The name of the channel group containing the channel associated with the // harvest job. // // This member is required. ChannelGroupName *string // The name of the channel associated with the harvest job. // // This member is required. ChannelName *string // The name of the harvest job to retrieve. // // This member is required. HarvestJobName *string // The name of the origin endpoint associated with the harvest job. // // This member is required. OriginEndpointName *string // contains filtered or unexported fields }
The request object for retrieving a specific harvest job.
type GetHarvestJobOutput ¶ added in v1.19.0
type GetHarvestJobOutput struct { // The Amazon Resource Name (ARN) of the harvest job. // // This member is required. Arn *string // The name of the channel group containing the channel associated with the // harvest job. // // This member is required. ChannelGroupName *string // The name of the channel associated with the harvest job. // // This member is required. ChannelName *string // The date and time when the harvest job was created. // // This member is required. CreatedAt *time.Time // The S3 destination where the harvested content is being placed. // // This member is required. Destination *types.Destination // The name of the harvest job. // // This member is required. HarvestJobName *string // A list of manifests that are being or have been harvested. // // This member is required. HarvestedManifests *types.HarvestedManifests // The date and time when the harvest job was last modified. // // This member is required. ModifiedAt *time.Time // The name of the origin endpoint associated with the harvest job. // // This member is required. OriginEndpointName *string // The configuration for when the harvest job is scheduled to run, including start // and end times. // // This member is required. ScheduleConfiguration *types.HarvesterScheduleConfiguration // The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, // COMPLETED, FAILED). // // This member is required. Status types.HarvestJobStatus // The description of the harvest job, if provided. Description *string // The current version of the harvest job. Used for concurrency control. ETag *string // An error message if the harvest job encountered any issues. ErrorMessage *string // A collection of tags associated with the harvest job. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
The response object containing the details of the requested harvest job.
type GetOriginEndpointInput ¶
type GetOriginEndpointInput struct { // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. // // This member is required. ChannelName *string // The name that describes the origin endpoint. The name is the primary identifier // for the origin endpoint, and and must be unique for your account in the AWS // Region and channel. // // This member is required. OriginEndpointName *string // contains filtered or unexported fields }
type GetOriginEndpointOutput ¶
type GetOriginEndpointOutput struct { // The Amazon Resource Name (ARN) associated with the resource. // // This member is required. Arn *string // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. // // This member is required. ChannelName *string // The type of container attached to this origin endpoint. // // This member is required. ContainerType types.ContainerType // The date and time the origin endpoint was created. // // This member is required. CreatedAt *time.Time // The date and time the origin endpoint was modified. // // This member is required. ModifiedAt *time.Time // The name that describes the origin endpoint. The name is the primary identifier // for the origin endpoint, and and must be unique for your account in the AWS // Region and channel. // // This member is required. OriginEndpointName *string // The segment configuration, including the segment name, duration, and other // configuration values. // // This member is required. Segment *types.Segment // A DASH manifest configuration. DashManifests []types.GetDashManifestConfiguration // The description for your origin endpoint. Description *string // The current Entity Tag (ETag) associated with this resource. The entity tag can // be used to safely make concurrent updates to the resource. ETag *string // The failover settings for the endpoint. ForceEndpointErrorConfiguration *types.ForceEndpointErrorConfiguration // An HTTP live streaming (HLS) manifest configuration. HlsManifests []types.GetHlsManifestConfiguration // A low-latency HLS manifest configuration. LowLatencyHlsManifests []types.GetLowLatencyHlsManifestConfiguration // The size of the window (in seconds) to create a window of the live stream // that's available for on-demand viewing. Viewers can start-over or catch-up on // content that falls within the window. StartoverWindowSeconds *int32 // The comma-separated list of tag key:value pairs assigned to the origin endpoint. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetOriginEndpointPolicyInput ¶
type GetOriginEndpointPolicyInput struct { // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. // // This member is required. ChannelName *string // The name that describes the origin endpoint. The name is the primary identifier // for the origin endpoint, and and must be unique for your account in the AWS // Region and channel. // // This member is required. OriginEndpointName *string // contains filtered or unexported fields }
type GetOriginEndpointPolicyOutput ¶
type GetOriginEndpointPolicyOutput struct { // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. // // This member is required. ChannelName *string // The name that describes the origin endpoint. The name is the primary identifier // for the origin endpoint, and and must be unique for your account in the AWS // Region and channel. // // This member is required. OriginEndpointName *string // The policy assigned to the origin endpoint. // // This member is required. Policy *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type HTTPSignerV4 ¶
type HarvestJobFinishedWaiter ¶ added in v1.19.0
type HarvestJobFinishedWaiter struct {
// contains filtered or unexported fields
}
HarvestJobFinishedWaiter defines the waiters for HarvestJobFinished
func NewHarvestJobFinishedWaiter ¶ added in v1.19.0
func NewHarvestJobFinishedWaiter(client GetHarvestJobAPIClient, optFns ...func(*HarvestJobFinishedWaiterOptions)) *HarvestJobFinishedWaiter
NewHarvestJobFinishedWaiter constructs a HarvestJobFinishedWaiter.
func (*HarvestJobFinishedWaiter) Wait ¶ added in v1.19.0
func (w *HarvestJobFinishedWaiter) Wait(ctx context.Context, params *GetHarvestJobInput, maxWaitDur time.Duration, optFns ...func(*HarvestJobFinishedWaiterOptions)) error
Wait calls the waiter function for HarvestJobFinished waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
func (*HarvestJobFinishedWaiter) WaitForOutput ¶ added in v1.19.0
func (w *HarvestJobFinishedWaiter) WaitForOutput(ctx context.Context, params *GetHarvestJobInput, maxWaitDur time.Duration, optFns ...func(*HarvestJobFinishedWaiterOptions)) (*GetHarvestJobOutput, error)
WaitForOutput calls the waiter function for HarvestJobFinished waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type HarvestJobFinishedWaiterOptions ¶ added in v1.19.0
type HarvestJobFinishedWaiterOptions 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. // // Passing options here is functionally equivalent to passing values to this // config's ClientOptions field that extend the inner client's APIOptions directly. APIOptions []func(*middleware.Stack) error // Functional options to be passed to all operations invoked by this client. // // Function values that modify the inner APIOptions are applied after the waiter // config's own APIOptions modifiers. ClientOptions []func(*Options) // MinDelay is the minimum amount of time to delay between retries. If unset, // HarvestJobFinishedWaiter will use default minimum delay of 2 seconds. Note that // MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or // set to zero, HarvestJobFinishedWaiter will use default max delay of 120 seconds. // Note that MaxDelay must resolve to value greater than or equal to the MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. // // By default service-modeled logic will populate this option. This option can // thus be used to define a custom waiter state with fall-back to service-modeled // waiter state mutators.The function returns an error in case of a failure state. // In case of retry state, this function returns a bool value of true and nil // error, while in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *GetHarvestJobInput, *GetHarvestJobOutput, error) (bool, error) }
HarvestJobFinishedWaiterOptions are waiter options for HarvestJobFinishedWaiter
type IdempotencyTokenProvider ¶
IdempotencyTokenProvider interface for providing idempotency token
type ListChannelGroupsAPIClient ¶
type ListChannelGroupsAPIClient interface {
ListChannelGroups(context.Context, *ListChannelGroupsInput, ...func(*Options)) (*ListChannelGroupsOutput, error)
}
ListChannelGroupsAPIClient is a client that implements the ListChannelGroups operation.
type ListChannelGroupsInput ¶
type ListChannelGroupsOutput ¶
type ListChannelGroupsOutput struct { // The objects being returned. Items []types.ChannelGroupListConfiguration // The pagination token from the GET list request. Use the token to fetch the next // page of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListChannelGroupsPaginator ¶
type ListChannelGroupsPaginator struct {
// contains filtered or unexported fields
}
ListChannelGroupsPaginator is a paginator for ListChannelGroups
func NewListChannelGroupsPaginator ¶
func NewListChannelGroupsPaginator(client ListChannelGroupsAPIClient, params *ListChannelGroupsInput, optFns ...func(*ListChannelGroupsPaginatorOptions)) *ListChannelGroupsPaginator
NewListChannelGroupsPaginator returns a new ListChannelGroupsPaginator
func (*ListChannelGroupsPaginator) HasMorePages ¶
func (p *ListChannelGroupsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListChannelGroupsPaginator) NextPage ¶
func (p *ListChannelGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListChannelGroupsOutput, error)
NextPage retrieves the next ListChannelGroups page.
type ListChannelGroupsPaginatorOptions ¶
type ListChannelGroupsPaginatorOptions struct { // The maximum number of results to return in the response. 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 }
ListChannelGroupsPaginatorOptions is the paginator options for ListChannelGroups
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 { // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The maximum number of results to return in the response. MaxResults *int32 // The pagination token from the GET list request. Use the token to fetch the next // page of results. NextToken *string // contains filtered or unexported fields }
type ListChannelsOutput ¶
type ListChannelsOutput struct { // The objects being returned. Items []types.ChannelListConfiguration // The pagination token from the GET list request. 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 { // The maximum number of results to return in the response. 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 ListHarvestJobsAPIClient ¶ added in v1.19.0
type ListHarvestJobsAPIClient interface {
ListHarvestJobs(context.Context, *ListHarvestJobsInput, ...func(*Options)) (*ListHarvestJobsOutput, error)
}
ListHarvestJobsAPIClient is a client that implements the ListHarvestJobs operation.
type ListHarvestJobsInput ¶ added in v1.19.0
type ListHarvestJobsInput struct { // The name of the channel group to filter the harvest jobs by. If specified, only // harvest jobs associated with channels in this group will be returned. // // This member is required. ChannelGroupName *string // The name of the channel to filter the harvest jobs by. If specified, only // harvest jobs associated with this channel will be returned. ChannelName *string // The maximum number of harvest jobs to return in a single request. If not // specified, a default value will be used. MaxResults *int32 // A token used for pagination. Provide this value in subsequent requests to // retrieve the next set of results. NextToken *string // The name of the origin endpoint to filter the harvest jobs by. If specified, // only harvest jobs associated with this origin endpoint will be returned. OriginEndpointName *string // The status to filter the harvest jobs by. If specified, only harvest jobs with // this status will be returned. Status types.HarvestJobStatus // contains filtered or unexported fields }
The request object for listing harvest jobs.
type ListHarvestJobsOutput ¶ added in v1.19.0
type ListHarvestJobsOutput struct { // An array of harvest job objects that match the specified criteria. Items []types.HarvestJob // A token used for pagination. Include this value in subsequent requests to // retrieve the next set of results. If null, there are no more results to // retrieve. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
The response object containing the list of harvest jobs that match the specified criteria.
type ListHarvestJobsPaginator ¶ added in v1.19.0
type ListHarvestJobsPaginator struct {
// contains filtered or unexported fields
}
ListHarvestJobsPaginator is a paginator for ListHarvestJobs
func NewListHarvestJobsPaginator ¶ added in v1.19.0
func NewListHarvestJobsPaginator(client ListHarvestJobsAPIClient, params *ListHarvestJobsInput, optFns ...func(*ListHarvestJobsPaginatorOptions)) *ListHarvestJobsPaginator
NewListHarvestJobsPaginator returns a new ListHarvestJobsPaginator
func (*ListHarvestJobsPaginator) HasMorePages ¶ added in v1.19.0
func (p *ListHarvestJobsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListHarvestJobsPaginator) NextPage ¶ added in v1.19.0
func (p *ListHarvestJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListHarvestJobsOutput, error)
NextPage retrieves the next ListHarvestJobs page.
type ListHarvestJobsPaginatorOptions ¶ added in v1.19.0
type ListHarvestJobsPaginatorOptions struct { // The maximum number of harvest jobs to return in a single request. If not // specified, a default value will be used. 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 }
ListHarvestJobsPaginatorOptions is the paginator options for ListHarvestJobs
type ListOriginEndpointsAPIClient ¶
type ListOriginEndpointsAPIClient interface {
ListOriginEndpoints(context.Context, *ListOriginEndpointsInput, ...func(*Options)) (*ListOriginEndpointsOutput, error)
}
ListOriginEndpointsAPIClient is a client that implements the ListOriginEndpoints operation.
type ListOriginEndpointsInput ¶
type ListOriginEndpointsInput struct { // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. // // This member is required. ChannelName *string // The maximum number of results to return in the response. MaxResults *int32 // The pagination token from the GET list request. Use the token to fetch the next // page of results. NextToken *string // contains filtered or unexported fields }
type ListOriginEndpointsOutput ¶
type ListOriginEndpointsOutput struct { // The objects being returned. Items []types.OriginEndpointListConfiguration // The pagination token from the GET list request. Use the token to fetch the next // page of results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListOriginEndpointsPaginator ¶
type ListOriginEndpointsPaginator struct {
// contains filtered or unexported fields
}
ListOriginEndpointsPaginator is a paginator for ListOriginEndpoints
func NewListOriginEndpointsPaginator ¶
func NewListOriginEndpointsPaginator(client ListOriginEndpointsAPIClient, params *ListOriginEndpointsInput, optFns ...func(*ListOriginEndpointsPaginatorOptions)) *ListOriginEndpointsPaginator
NewListOriginEndpointsPaginator returns a new ListOriginEndpointsPaginator
func (*ListOriginEndpointsPaginator) HasMorePages ¶
func (p *ListOriginEndpointsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListOriginEndpointsPaginator) NextPage ¶
func (p *ListOriginEndpointsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOriginEndpointsOutput, error)
NextPage retrieves the next ListOriginEndpoints page.
type ListOriginEndpointsPaginatorOptions ¶
type ListOriginEndpointsPaginatorOptions struct { // The maximum number of results to return in the response. 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 }
ListOriginEndpointsPaginatorOptions is the paginator options for ListOriginEndpoints
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The ARN of the CloudWatch resource that you want to view tags for. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // Contains a map of the key-value pairs for the resource tag or tags assigned to // the resource. 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 // Provides idempotency tokens values that will be automatically populated into // idempotent API operations. IdempotencyTokenProvider IdempotencyTokenProvider // The logger writer interface to write logging messages to. Logger logging.Logger // The client meter provider. MeterProvider metrics.MeterProvider // 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 client tracer provider. TracerProvider tracing.TracerProvider // 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) GetIdentityResolver ¶ added in v1.6.2
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
type PutChannelPolicyInput ¶
type PutChannelPolicyInput struct { // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. // // This member is required. ChannelName *string // The policy to attach to the specified channel. // // This member is required. Policy *string // contains filtered or unexported fields }
type PutChannelPolicyOutput ¶
type PutChannelPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PutOriginEndpointPolicyInput ¶
type PutOriginEndpointPolicyInput struct { // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. // // This member is required. ChannelName *string // The name that describes the origin endpoint. The name is the primary identifier // for the origin endpoint, and and must be unique for your account in the AWS // Region and channel. // // This member is required. OriginEndpointName *string // The policy to attach to the specified origin endpoint. // // This member is required. Policy *string // contains filtered or unexported fields }
type PutOriginEndpointPolicyOutput ¶
type PutOriginEndpointPolicyOutput 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 TagResourceInput ¶
type TagResourceInput struct { // The ARN of the MediaPackage resource that you're adding tags to. // // This member is required. ResourceArn *string // Contains a map of the key-value pairs for the resource tag or tags assigned to // the resource. // // 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 { // The ARN of the MediaPackage resource that you're removing tags from. // // This member is required. ResourceArn *string // The list of tag keys to remove from the resource. // // 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 UpdateChannelGroupInput ¶
type UpdateChannelGroupInput struct { // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // Any descriptive information that you want to add to the channel group for // future identification purposes. Description *string // The expected current Entity Tag (ETag) for the resource. If the specified ETag // does not match the resource's current entity tag, the update request will be // rejected. ETag *string // contains filtered or unexported fields }
type UpdateChannelGroupOutput ¶
type UpdateChannelGroupOutput struct { // The Amazon Resource Name (ARN) associated with the resource. // // This member is required. Arn *string // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The date and time the channel group was created. // // This member is required. CreatedAt *time.Time // The output domain where the source stream is sent. Integrate the domain with a // downstream CDN (such as Amazon CloudFront) or playback device. // // This member is required. EgressDomain *string // The date and time the channel group was modified. // // This member is required. ModifiedAt *time.Time // The description for your channel group. Description *string // The current Entity Tag (ETag) associated with this resource. The entity tag can // be used to safely make concurrent updates to the resource. ETag *string // The comma-separated list of tag key:value pairs assigned to the channel group. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateChannelInput ¶
type UpdateChannelInput struct { // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. // // This member is required. ChannelName *string // Any descriptive information that you want to add to the channel for future // identification purposes. Description *string // The expected current Entity Tag (ETag) for the resource. If the specified ETag // does not match the resource's current entity tag, the update request will be // rejected. ETag *string // The configuration for input switching based on the media quality confidence // score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid // only when InputType is CMAF . InputSwitchConfiguration *types.InputSwitchConfiguration // The settings for what common media server data (CMSD) headers AWS Elemental // MediaPackage includes in responses to the CDN. This setting is valid only when // InputType is CMAF . OutputHeaderConfiguration *types.OutputHeaderConfiguration // contains filtered or unexported fields }
type UpdateChannelOutput ¶
type UpdateChannelOutput struct { // The Amazon Resource Name (ARN) associated with the resource. // // This member is required. Arn *string // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. // // This member is required. ChannelName *string // The date and time the channel was created. // // This member is required. CreatedAt *time.Time // The date and time the channel was modified. // // This member is required. ModifiedAt *time.Time // The description for your channel. Description *string // The current Entity Tag (ETag) associated with this resource. The entity tag can // be used to safely make concurrent updates to the resource. ETag *string // The list of ingest endpoints. IngestEndpoints []types.IngestEndpoint // The configuration for input switching based on the media quality confidence // score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid // only when InputType is CMAF . InputSwitchConfiguration *types.InputSwitchConfiguration // The input type will be an immutable field which will be used to define whether // the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default // to HLS to preserve current behavior. // // The allowed values are: // // - HLS - The HLS streaming specification (which defines M3U8 manifests and TS // segments). // // - CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments // with optional DASH manifests). InputType types.InputType // The settings for what common media server data (CMSD) headers AWS Elemental // MediaPackage includes in responses to the CDN. This setting is valid only when // InputType is CMAF . OutputHeaderConfiguration *types.OutputHeaderConfiguration // The comma-separated list of tag key:value pairs assigned to the channel. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateOriginEndpointInput ¶
type UpdateOriginEndpointInput struct { // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. // // This member is required. ChannelName *string // The type of container attached to this origin endpoint. A container type is a // file format that encapsulates one or more media streams, such as audio and // video, into a single file. // // This member is required. ContainerType types.ContainerType // The name that describes the origin endpoint. The name is the primary identifier // for the origin endpoint, and and must be unique for your account in the AWS // Region and channel. // // This member is required. OriginEndpointName *string // A DASH manifest configuration. DashManifests []types.CreateDashManifestConfiguration // Any descriptive information that you want to add to the origin endpoint for // future identification purposes. Description *string // The expected current Entity Tag (ETag) for the resource. If the specified ETag // does not match the resource's current entity tag, the update request will be // rejected. ETag *string // The failover settings for the endpoint. ForceEndpointErrorConfiguration *types.ForceEndpointErrorConfiguration // An HTTP live streaming (HLS) manifest configuration. HlsManifests []types.CreateHlsManifestConfiguration // A low-latency HLS manifest configuration. LowLatencyHlsManifests []types.CreateLowLatencyHlsManifestConfiguration // The segment configuration, including the segment name, duration, and other // configuration values. Segment *types.Segment // The size of the window (in seconds) to create a window of the live stream // that's available for on-demand viewing. Viewers can start-over or catch-up on // content that falls within the window. The maximum startover window is 1,209,600 // seconds (14 days). StartoverWindowSeconds *int32 // contains filtered or unexported fields }
type UpdateOriginEndpointOutput ¶
type UpdateOriginEndpointOutput struct { // The ARN associated with the resource. // // This member is required. Arn *string // The name that describes the channel group. The name is the primary identifier // for the channel group, and must be unique for your account in the AWS Region. // // This member is required. ChannelGroupName *string // The name that describes the channel. The name is the primary identifier for the // channel, and must be unique for your account in the AWS Region and channel // group. // // This member is required. ChannelName *string // The type of container attached to this origin endpoint. // // This member is required. ContainerType types.ContainerType // The date and time the origin endpoint was created. // // This member is required. CreatedAt *time.Time // The date and time the origin endpoint was modified. // // This member is required. ModifiedAt *time.Time // The name that describes the origin endpoint. The name is the primary identifier // for the origin endpoint, and and must be unique for your account in the AWS // Region and channel. // // This member is required. OriginEndpointName *string // The segment configuration, including the segment name, duration, and other // configuration values. // // This member is required. Segment *types.Segment // A DASH manifest configuration. DashManifests []types.GetDashManifestConfiguration // The description of the origin endpoint. Description *string // The current Entity Tag (ETag) associated with this resource. The entity tag can // be used to safely make concurrent updates to the resource. ETag *string // The failover settings for the endpoint. ForceEndpointErrorConfiguration *types.ForceEndpointErrorConfiguration // An HTTP live streaming (HLS) manifest configuration. HlsManifests []types.GetHlsManifestConfiguration // A low-latency HLS manifest configuration. LowLatencyHlsManifests []types.GetLowLatencyHlsManifestConfiguration // The size of the window (in seconds) to create a window of the live stream // that's available for on-demand viewing. Viewers can start-over or catch-up on // content that falls within the window. StartoverWindowSeconds *int32 // The comma-separated list of tag key:value pairs assigned to the origin endpoint. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files ¶
- api_client.go
- api_op_CancelHarvestJob.go
- api_op_CreateChannel.go
- api_op_CreateChannelGroup.go
- api_op_CreateHarvestJob.go
- api_op_CreateOriginEndpoint.go
- api_op_DeleteChannel.go
- api_op_DeleteChannelGroup.go
- api_op_DeleteChannelPolicy.go
- api_op_DeleteOriginEndpoint.go
- api_op_DeleteOriginEndpointPolicy.go
- api_op_GetChannel.go
- api_op_GetChannelGroup.go
- api_op_GetChannelPolicy.go
- api_op_GetHarvestJob.go
- api_op_GetOriginEndpoint.go
- api_op_GetOriginEndpointPolicy.go
- api_op_ListChannelGroups.go
- api_op_ListChannels.go
- api_op_ListHarvestJobs.go
- api_op_ListOriginEndpoints.go
- api_op_ListTagsForResource.go
- api_op_PutChannelPolicy.go
- api_op_PutOriginEndpointPolicy.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateChannel.go
- api_op_UpdateChannelGroup.go
- api_op_UpdateOriginEndpoint.go
- auth.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- options.go
- serializers.go
- validators.go