package mediapackage
import "github.com/aws/aws-sdk-go-v2/service/mediapackage"
Package mediapackage provides the API client, operations, and parameter types for AWS Elemental MediaPackage.
AWS Elemental MediaPackage
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) ConfigureLogs(ctx context.Context, params *ConfigureLogsInput, optFns ...func(*Options)) (*ConfigureLogsOutput, error)
- func (c *Client) CreateChannel(ctx context.Context, params *CreateChannelInput, optFns ...func(*Options)) (*CreateChannelOutput, error)
- func (c *Client) CreateHarvestJob(ctx context.Context, params *CreateHarvestJobInput, optFns ...func(*Options)) (*CreateHarvestJobOutput, error)
- func (c *Client) CreateOriginEndpoint(ctx context.Context, params *CreateOriginEndpointInput, optFns ...func(*Options)) (*CreateOriginEndpointOutput, error)
- func (c *Client) DeleteChannel(ctx context.Context, params *DeleteChannelInput, optFns ...func(*Options)) (*DeleteChannelOutput, error)
- func (c *Client) DeleteOriginEndpoint(ctx context.Context, params *DeleteOriginEndpointInput, optFns ...func(*Options)) (*DeleteOriginEndpointOutput, error)
- func (c *Client) DescribeChannel(ctx context.Context, params *DescribeChannelInput, optFns ...func(*Options)) (*DescribeChannelOutput, error)
- func (c *Client) DescribeHarvestJob(ctx context.Context, params *DescribeHarvestJobInput, optFns ...func(*Options)) (*DescribeHarvestJobOutput, error)
- func (c *Client) DescribeOriginEndpoint(ctx context.Context, params *DescribeOriginEndpointInput, optFns ...func(*Options)) (*DescribeOriginEndpointOutput, 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, optFns ...func(*Options)) (*ListOriginEndpointsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
- func (c *Client) RotateChannelCredentials(ctx context.Context, params *RotateChannelCredentialsInput, optFns ...func(*Options)) (*RotateChannelCredentialsOutput, error)
- func (c *Client) RotateIngestEndpointCredentials(ctx context.Context, params *RotateIngestEndpointCredentialsInput, optFns ...func(*Options)) (*RotateIngestEndpointCredentialsOutput, 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) UpdateOriginEndpoint(ctx context.Context, params *UpdateOriginEndpointInput, optFns ...func(*Options)) (*UpdateOriginEndpointOutput, error)
- type ConfigureLogsInput
- type ConfigureLogsOutput
- type CreateChannelInput
- type CreateChannelOutput
- type CreateHarvestJobInput
- type CreateHarvestJobOutput
- type CreateOriginEndpointInput
- type CreateOriginEndpointOutput
- type DeleteChannelInput
- type DeleteChannelOutput
- type DeleteOriginEndpointInput
- type DeleteOriginEndpointOutput
- type DescribeChannelInput
- type DescribeChannelOutput
- type DescribeHarvestJobInput
- type DescribeHarvestJobOutput
- type DescribeOriginEndpointInput
- type DescribeOriginEndpointOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type HTTPClient
- type HTTPSignerV4
- type ListChannelsAPIClient
- type ListChannelsInput
- type ListChannelsOutput
- type ListChannelsPaginator
- func NewListChannelsPaginator(client ListChannelsAPIClient, params *ListChannelsInput, optFns ...func(*ListChannelsPaginatorOptions)) *ListChannelsPaginator
- func (p *ListChannelsPaginator) HasMorePages() bool
- func (p *ListChannelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListChannelsOutput, error)
- type ListChannelsPaginatorOptions
- type ListHarvestJobsAPIClient
- type ListHarvestJobsInput
- type ListHarvestJobsOutput
- type ListHarvestJobsPaginator
- func NewListHarvestJobsPaginator(client ListHarvestJobsAPIClient, params *ListHarvestJobsInput, optFns ...func(*ListHarvestJobsPaginatorOptions)) *ListHarvestJobsPaginator
- func (p *ListHarvestJobsPaginator) HasMorePages() bool
- func (p *ListHarvestJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListHarvestJobsOutput, error)
- type ListHarvestJobsPaginatorOptions
- type ListOriginEndpointsAPIClient
- type ListOriginEndpointsInput
- type ListOriginEndpointsOutput
- type ListOriginEndpointsPaginator
- func NewListOriginEndpointsPaginator(client ListOriginEndpointsAPIClient, params *ListOriginEndpointsInput, optFns ...func(*ListOriginEndpointsPaginatorOptions)) *ListOriginEndpointsPaginator
- func (p *ListOriginEndpointsPaginator) HasMorePages() bool
- func (p *ListOriginEndpointsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOriginEndpointsOutput, error)
- type ListOriginEndpointsPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type RotateChannelCredentialsInput
- type RotateChannelCredentialsOutput
- type RotateIngestEndpointCredentialsInput
- type RotateIngestEndpointCredentialsOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateChannelInput
- type UpdateChannelOutput
- type UpdateOriginEndpointInput
- type UpdateOriginEndpointOutput
Constants ¶
const ServiceAPIVersion = "2017-10-12"
const ServiceID = "MediaPackage"
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 ¶
func WithEndpointResolver(v EndpointResolver) func(*Options)
WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS Elemental MediaPackage.
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) ConfigureLogs ¶
func (c *Client) ConfigureLogs(ctx context.Context, params *ConfigureLogsInput, optFns ...func(*Options)) (*ConfigureLogsOutput, error)
Changes the Channel's properities to configure log subscription
func (*Client) CreateChannel ¶
func (c *Client) CreateChannel(ctx context.Context, params *CreateChannelInput, optFns ...func(*Options)) (*CreateChannelOutput, error)
Creates a new Channel.
func (*Client) CreateHarvestJob ¶
func (c *Client) CreateHarvestJob(ctx context.Context, params *CreateHarvestJobInput, optFns ...func(*Options)) (*CreateHarvestJobOutput, error)
Creates a new HarvestJob record.
func (*Client) CreateOriginEndpoint ¶
func (c *Client) CreateOriginEndpoint(ctx context.Context, params *CreateOriginEndpointInput, optFns ...func(*Options)) (*CreateOriginEndpointOutput, error)
Creates a new OriginEndpoint record.
func (*Client) DeleteChannel ¶
func (c *Client) DeleteChannel(ctx context.Context, params *DeleteChannelInput, optFns ...func(*Options)) (*DeleteChannelOutput, error)
Deletes an existing Channel.
func (*Client) DeleteOriginEndpoint ¶
func (c *Client) DeleteOriginEndpoint(ctx context.Context, params *DeleteOriginEndpointInput, optFns ...func(*Options)) (*DeleteOriginEndpointOutput, error)
Deletes an existing OriginEndpoint.
func (*Client) DescribeChannel ¶
func (c *Client) DescribeChannel(ctx context.Context, params *DescribeChannelInput, optFns ...func(*Options)) (*DescribeChannelOutput, error)
Gets details about a Channel.
func (*Client) DescribeHarvestJob ¶
func (c *Client) DescribeHarvestJob(ctx context.Context, params *DescribeHarvestJobInput, optFns ...func(*Options)) (*DescribeHarvestJobOutput, error)
Gets details about an existing HarvestJob.
func (*Client) DescribeOriginEndpoint ¶
func (c *Client) DescribeOriginEndpoint(ctx context.Context, params *DescribeOriginEndpointInput, optFns ...func(*Options)) (*DescribeOriginEndpointOutput, error)
Gets details about an existing OriginEndpoint.
func (*Client) ListChannels ¶
func (c *Client) ListChannels(ctx context.Context, params *ListChannelsInput, optFns ...func(*Options)) (*ListChannelsOutput, error)
Returns a collection of Channels.
func (*Client) ListHarvestJobs ¶
func (c *Client) ListHarvestJobs(ctx context.Context, params *ListHarvestJobsInput, optFns ...func(*Options)) (*ListHarvestJobsOutput, error)
Returns a collection of HarvestJob records.
func (*Client) ListOriginEndpoints ¶
func (c *Client) ListOriginEndpoints(ctx context.Context, params *ListOriginEndpointsInput, optFns ...func(*Options)) (*ListOriginEndpointsOutput, error)
Returns a collection of OriginEndpoint records.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
func (*Client) RotateChannelCredentials ¶
func (c *Client) RotateChannelCredentials(ctx context.Context, params *RotateChannelCredentialsInput, optFns ...func(*Options)) (*RotateChannelCredentialsOutput, error)
Changes the Channel's first IngestEndpoint's username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials instead
Deprecated: This API is deprecated. Please use RotateIngestEndpointCredentials instead
func (*Client) RotateIngestEndpointCredentials ¶
func (c *Client) RotateIngestEndpointCredentials(ctx context.Context, params *RotateIngestEndpointCredentialsInput, optFns ...func(*Options)) (*RotateIngestEndpointCredentialsOutput, error)
Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
func (*Client) UpdateChannel ¶
func (c *Client) UpdateChannel(ctx context.Context, params *UpdateChannelInput, optFns ...func(*Options)) (*UpdateChannelOutput, error)
Updates an existing Channel.
func (*Client) UpdateOriginEndpoint ¶
func (c *Client) UpdateOriginEndpoint(ctx context.Context, params *UpdateOriginEndpointInput, optFns ...func(*Options)) (*UpdateOriginEndpointOutput, error)
Updates an existing OriginEndpoint.
type ConfigureLogsInput ¶
type ConfigureLogsInput struct { // The ID of the channel to log subscription. // // This member is required. Id *string // Configure egress access logging. EgressAccessLogs *types.EgressAccessLogs // Configure ingress access logging. IngressAccessLogs *types.IngressAccessLogs // contains filtered or unexported fields }
the option to configure log subscription.
type ConfigureLogsOutput ¶
type ConfigureLogsOutput struct { // The Amazon Resource Name (ARN) assigned to the Channel. Arn *string // A short text description of the Channel. Description *string // Configure egress access logging. EgressAccessLogs *types.EgressAccessLogs // An HTTP Live Streaming (HLS) ingest resource configuration. HlsIngest *types.HlsIngest // The ID of the Channel. Id *string // Configure ingress access logging. IngressAccessLogs *types.IngressAccessLogs // A collection of tags associated with a resource 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 ID of the Channel. The ID must be unique within the region and it cannot be // changed after a Channel is created. // // This member is required. Id *string // A short text description of the Channel. Description *string // A collection of tags associated with a resource Tags map[string]string // contains filtered or unexported fields }
A new Channel configuration.
type CreateChannelOutput ¶
type CreateChannelOutput struct { // The Amazon Resource Name (ARN) assigned to the Channel. Arn *string // A short text description of the Channel. Description *string // Configure egress access logging. EgressAccessLogs *types.EgressAccessLogs // An HTTP Live Streaming (HLS) ingest resource configuration. HlsIngest *types.HlsIngest // The ID of the Channel. Id *string // Configure ingress access logging. IngressAccessLogs *types.IngressAccessLogs // A collection of tags associated with a resource Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateHarvestJobInput ¶
type CreateHarvestJobInput struct { // The end of the time-window which will be harvested // // This member is required. EndTime *string // The ID of the HarvestJob. The ID must be unique within the region and it cannot // be changed after the HarvestJob is submitted // // This member is required. Id *string // The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot // be changed after the HarvestJob is submitted. // // This member is required. OriginEndpointId *string // Configuration parameters for where in an S3 bucket to place the harvested // content // // This member is required. S3Destination *types.S3Destination // The start of the time-window which will be harvested // // This member is required. StartTime *string // contains filtered or unexported fields }
Configuration parameters used to create a new HarvestJob.
type CreateHarvestJobOutput ¶
type CreateHarvestJobOutput struct { // The Amazon Resource Name (ARN) assigned to the HarvestJob. Arn *string // The ID of the Channel that the HarvestJob will harvest from. ChannelId *string // The time the HarvestJob was submitted CreatedAt *string // The end of the time-window which will be harvested. EndTime *string // The ID of the HarvestJob. The ID must be unique within the region and it cannot // be changed after the HarvestJob is submitted. Id *string // The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot // be changed after the HarvestJob is submitted. OriginEndpointId *string // Configuration parameters for where in an S3 bucket to place the harvested // content S3Destination *types.S3Destination // The start of the time-window which will be harvested. StartTime *string // The current status of the HarvestJob. Consider setting up a CloudWatch Event to // listen for HarvestJobs as they succeed or fail. In the event of failure, the // CloudWatch Event will include an explanation of why the HarvestJob failed. Status types.Status // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateOriginEndpointInput ¶
type CreateOriginEndpointInput struct { // The ID of the Channel that the OriginEndpoint will be associated with. This // cannot be changed after the OriginEndpoint is created. // // This member is required. ChannelId *string // The ID of the OriginEndpoint. The ID must be unique within the region and it // cannot be changed after the OriginEndpoint is created. // // This member is required. Id *string // CDN Authorization credentials Authorization *types.Authorization // A Common Media Application Format (CMAF) packaging configuration. CmafPackage *types.CmafPackageCreateOrUpdateParameters // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. DashPackage *types.DashPackage // A short text description of the OriginEndpoint. Description *string // An HTTP Live Streaming (HLS) packaging configuration. HlsPackage *types.HlsPackage // A short string that will be used as the filename of the OriginEndpoint URL // (defaults to "index"). ManifestName *string // A Microsoft Smooth Streaming (MSS) packaging configuration. MssPackage *types.MssPackage // Control whether origination of video is allowed for this OriginEndpoint. If set // to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of // access control. If set to DENY, the OriginEndpoint may not be requested. This // can be helpful for Live to VOD harvesting, or for temporarily disabling // origination Origination types.Origination // Maximum duration (seconds) of content to retain for startover playback. If not // specified, startover playback will be disabled for the OriginEndpoint. StartoverWindowSeconds int32 // A collection of tags associated with a resource Tags map[string]string // Amount of delay (seconds) to enforce on the playback of live content. If not // specified, there will be no time delay in effect for the OriginEndpoint. TimeDelaySeconds int32 // A list of source IP CIDR blocks that will be allowed to access the // OriginEndpoint. Whitelist []string // contains filtered or unexported fields }
Configuration parameters used to create a new OriginEndpoint.
type CreateOriginEndpointOutput ¶
type CreateOriginEndpointOutput struct { // The Amazon Resource Name (ARN) assigned to the OriginEndpoint. Arn *string // CDN Authorization credentials Authorization *types.Authorization // The ID of the Channel the OriginEndpoint is associated with. ChannelId *string // A Common Media Application Format (CMAF) packaging configuration. CmafPackage *types.CmafPackage // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. DashPackage *types.DashPackage // A short text description of the OriginEndpoint. Description *string // An HTTP Live Streaming (HLS) packaging configuration. HlsPackage *types.HlsPackage // The ID of the OriginEndpoint. Id *string // A short string appended to the end of the OriginEndpoint URL. ManifestName *string // A Microsoft Smooth Streaming (MSS) packaging configuration. MssPackage *types.MssPackage // Control whether origination of video is allowed for this OriginEndpoint. If set // to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of // access control. If set to DENY, the OriginEndpoint may not be requested. This // can be helpful for Live to VOD harvesting, or for temporarily disabling // origination Origination types.Origination // Maximum duration (seconds) of content to retain for startover playback. If not // specified, startover playback will be disabled for the OriginEndpoint. StartoverWindowSeconds int32 // A collection of tags associated with a resource Tags map[string]string // Amount of delay (seconds) to enforce on the playback of live content. If not // specified, there will be no time delay in effect for the OriginEndpoint. TimeDelaySeconds int32 // The URL of the packaged OriginEndpoint for consumption. Url *string // A list of source IP CIDR blocks that will be allowed to access the // OriginEndpoint. Whitelist []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteChannelInput ¶
type DeleteChannelInput struct { // The ID of the Channel to delete. // // This member is required. Id *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 DeleteOriginEndpointInput ¶
type DeleteOriginEndpointInput struct { // The ID of the OriginEndpoint to delete. // // This member is required. Id *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 DescribeChannelInput ¶
type DescribeChannelInput struct { // The ID of a Channel. // // This member is required. Id *string // contains filtered or unexported fields }
type DescribeChannelOutput ¶
type DescribeChannelOutput struct { // The Amazon Resource Name (ARN) assigned to the Channel. Arn *string // A short text description of the Channel. Description *string // Configure egress access logging. EgressAccessLogs *types.EgressAccessLogs // An HTTP Live Streaming (HLS) ingest resource configuration. HlsIngest *types.HlsIngest // The ID of the Channel. Id *string // Configure ingress access logging. IngressAccessLogs *types.IngressAccessLogs // A collection of tags associated with a resource Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeHarvestJobInput ¶
type DescribeHarvestJobInput struct { // The ID of the HarvestJob. // // This member is required. Id *string // contains filtered or unexported fields }
type DescribeHarvestJobOutput ¶
type DescribeHarvestJobOutput struct { // The Amazon Resource Name (ARN) assigned to the HarvestJob. Arn *string // The ID of the Channel that the HarvestJob will harvest from. ChannelId *string // The time the HarvestJob was submitted CreatedAt *string // The end of the time-window which will be harvested. EndTime *string // The ID of the HarvestJob. The ID must be unique within the region and it cannot // be changed after the HarvestJob is submitted. Id *string // The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot // be changed after the HarvestJob is submitted. OriginEndpointId *string // Configuration parameters for where in an S3 bucket to place the harvested // content S3Destination *types.S3Destination // The start of the time-window which will be harvested. StartTime *string // The current status of the HarvestJob. Consider setting up a CloudWatch Event to // listen for HarvestJobs as they succeed or fail. In the event of failure, the // CloudWatch Event will include an explanation of why the HarvestJob failed. Status types.Status // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeOriginEndpointInput ¶
type DescribeOriginEndpointInput struct { // The ID of the OriginEndpoint. // // This member is required. Id *string // contains filtered or unexported fields }
type DescribeOriginEndpointOutput ¶
type DescribeOriginEndpointOutput struct { // The Amazon Resource Name (ARN) assigned to the OriginEndpoint. Arn *string // CDN Authorization credentials Authorization *types.Authorization // The ID of the Channel the OriginEndpoint is associated with. ChannelId *string // A Common Media Application Format (CMAF) packaging configuration. CmafPackage *types.CmafPackage // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. DashPackage *types.DashPackage // A short text description of the OriginEndpoint. Description *string // An HTTP Live Streaming (HLS) packaging configuration. HlsPackage *types.HlsPackage // The ID of the OriginEndpoint. Id *string // A short string appended to the end of the OriginEndpoint URL. ManifestName *string // A Microsoft Smooth Streaming (MSS) packaging configuration. MssPackage *types.MssPackage // Control whether origination of video is allowed for this OriginEndpoint. If set // to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of // access control. If set to DENY, the OriginEndpoint may not be requested. This // can be helpful for Live to VOD harvesting, or for temporarily disabling // origination Origination types.Origination // Maximum duration (seconds) of content to retain for startover playback. If not // specified, startover playback will be disabled for the OriginEndpoint. StartoverWindowSeconds int32 // A collection of tags associated with a resource Tags map[string]string // Amount of delay (seconds) to enforce on the playback of live content. If not // specified, there will be no time delay in effect for the OriginEndpoint. TimeDelaySeconds int32 // The URL of the packaged OriginEndpoint for consumption. Url *string // A list of source IP CIDR blocks that will be allowed to access the // OriginEndpoint. Whitelist []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error }
type 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 { // Upper bound on number of records to return. MaxResults int32 // A token used to resume pagination from the end of a previous request. NextToken *string // contains filtered or unexported fields }
type ListChannelsOutput ¶
type ListChannelsOutput struct { // A list of Channel records. Channels []types.Channel // A token that can be used to resume pagination from the end of the collection. 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 { // Upper bound on number of records to return. 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 ¶
type ListHarvestJobsAPIClient interface { ListHarvestJobs(context.Context, *ListHarvestJobsInput, ...func(*Options)) (*ListHarvestJobsOutput, error) }
ListHarvestJobsAPIClient is a client that implements the ListHarvestJobs operation.
type ListHarvestJobsInput ¶
type ListHarvestJobsInput struct { // When specified, the request will return only HarvestJobs associated with the // given Channel ID. IncludeChannelId *string // When specified, the request will return only HarvestJobs in the given status. IncludeStatus *string // The upper bound on the number of records to return. MaxResults int32 // A token used to resume pagination from the end of a previous request. NextToken *string // contains filtered or unexported fields }
type ListHarvestJobsOutput ¶
type ListHarvestJobsOutput struct { // A list of HarvestJob records. HarvestJobs []types.HarvestJob // A token that can be used to resume pagination from the end of the collection. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListHarvestJobsPaginator ¶
type ListHarvestJobsPaginator struct {
// contains filtered or unexported fields
}
ListHarvestJobsPaginator is a paginator for ListHarvestJobs
func NewListHarvestJobsPaginator ¶
func NewListHarvestJobsPaginator(client ListHarvestJobsAPIClient, params *ListHarvestJobsInput, optFns ...func(*ListHarvestJobsPaginatorOptions)) *ListHarvestJobsPaginator
NewListHarvestJobsPaginator returns a new ListHarvestJobsPaginator
func (*ListHarvestJobsPaginator) HasMorePages ¶
func (p *ListHarvestJobsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListHarvestJobsPaginator) NextPage ¶
func (p *ListHarvestJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListHarvestJobsOutput, error)
NextPage retrieves the next ListHarvestJobs page.
type ListHarvestJobsPaginatorOptions ¶
type ListHarvestJobsPaginatorOptions struct { // The upper bound on the number of records to return. 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 { // When specified, the request will return only OriginEndpoints associated with the // given Channel ID. ChannelId *string // The upper bound on the number of records to return. MaxResults int32 // A token used to resume pagination from the end of a previous request. NextToken *string // contains filtered or unexported fields }
type ListOriginEndpointsOutput ¶
type ListOriginEndpointsOutput struct { // A token that can be used to resume pagination from the end of the collection. NextToken *string // A list of OriginEndpoint records. OriginEndpoints []types.OriginEndpoint // 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 upper bound on the number of records to return. 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 { // This member is required. ResourceArn *string // contains filtered or unexported fields }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { 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 // 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. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. 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. If specified in an operation call's functional // options with a value that is different than the constructed client's Options, // the Client's Retryer will be wrapped to use the operation's specific // RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. Currently does not support per operation call // overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // contains filtered or unexported fields }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
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 RotateChannelCredentialsInput ¶
type RotateChannelCredentialsInput struct { // The ID of the channel to update. // // This member is required. Id *string // contains filtered or unexported fields }
type RotateChannelCredentialsOutput ¶
type RotateChannelCredentialsOutput struct { // The Amazon Resource Name (ARN) assigned to the Channel. Arn *string // A short text description of the Channel. Description *string // Configure egress access logging. EgressAccessLogs *types.EgressAccessLogs // An HTTP Live Streaming (HLS) ingest resource configuration. HlsIngest *types.HlsIngest // The ID of the Channel. Id *string // Configure ingress access logging. IngressAccessLogs *types.IngressAccessLogs // A collection of tags associated with a resource Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type RotateIngestEndpointCredentialsInput ¶
type RotateIngestEndpointCredentialsInput struct { // The ID of the channel the IngestEndpoint is on. // // This member is required. Id *string // The id of the IngestEndpoint whose credentials should be rotated // // This member is required. IngestEndpointId *string // contains filtered or unexported fields }
type RotateIngestEndpointCredentialsOutput ¶
type RotateIngestEndpointCredentialsOutput struct { // The Amazon Resource Name (ARN) assigned to the Channel. Arn *string // A short text description of the Channel. Description *string // Configure egress access logging. EgressAccessLogs *types.EgressAccessLogs // An HTTP Live Streaming (HLS) ingest resource configuration. HlsIngest *types.HlsIngest // The ID of the Channel. Id *string // Configure ingress access logging. IngressAccessLogs *types.IngressAccessLogs // A collection of tags associated with a resource Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type TagResourceInput ¶
type TagResourceInput struct { // This member is required. ResourceArn *string // 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 { // This member is required. ResourceArn *string // The key(s) of tag to be deleted // // This member is required. TagKeys []string // contains filtered or unexported fields }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateChannelInput ¶
type UpdateChannelInput struct { // The ID of the Channel to update. // // This member is required. Id *string // A short text description of the Channel. Description *string // contains filtered or unexported fields }
Configuration parameters used to update the Channel.
type UpdateChannelOutput ¶
type UpdateChannelOutput struct { // The Amazon Resource Name (ARN) assigned to the Channel. Arn *string // A short text description of the Channel. Description *string // Configure egress access logging. EgressAccessLogs *types.EgressAccessLogs // An HTTP Live Streaming (HLS) ingest resource configuration. HlsIngest *types.HlsIngest // The ID of the Channel. Id *string // Configure ingress access logging. IngressAccessLogs *types.IngressAccessLogs // A collection of tags associated with a resource 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 ID of the OriginEndpoint to update. // // This member is required. Id *string // CDN Authorization credentials Authorization *types.Authorization // A Common Media Application Format (CMAF) packaging configuration. CmafPackage *types.CmafPackageCreateOrUpdateParameters // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. DashPackage *types.DashPackage // A short text description of the OriginEndpoint. Description *string // An HTTP Live Streaming (HLS) packaging configuration. HlsPackage *types.HlsPackage // A short string that will be appended to the end of the Endpoint URL. ManifestName *string // A Microsoft Smooth Streaming (MSS) packaging configuration. MssPackage *types.MssPackage // Control whether origination of video is allowed for this OriginEndpoint. If set // to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of // access control. If set to DENY, the OriginEndpoint may not be requested. This // can be helpful for Live to VOD harvesting, or for temporarily disabling // origination Origination types.Origination // Maximum duration (in seconds) of content to retain for startover playback. If // not specified, startover playback will be disabled for the OriginEndpoint. StartoverWindowSeconds int32 // Amount of delay (in seconds) to enforce on the playback of live content. If not // specified, there will be no time delay in effect for the OriginEndpoint. TimeDelaySeconds int32 // A list of source IP CIDR blocks that will be allowed to access the // OriginEndpoint. Whitelist []string // contains filtered or unexported fields }
Configuration parameters used to update an existing OriginEndpoint.
type UpdateOriginEndpointOutput ¶
type UpdateOriginEndpointOutput struct { // The Amazon Resource Name (ARN) assigned to the OriginEndpoint. Arn *string // CDN Authorization credentials Authorization *types.Authorization // The ID of the Channel the OriginEndpoint is associated with. ChannelId *string // A Common Media Application Format (CMAF) packaging configuration. CmafPackage *types.CmafPackage // A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. DashPackage *types.DashPackage // A short text description of the OriginEndpoint. Description *string // An HTTP Live Streaming (HLS) packaging configuration. HlsPackage *types.HlsPackage // The ID of the OriginEndpoint. Id *string // A short string appended to the end of the OriginEndpoint URL. ManifestName *string // A Microsoft Smooth Streaming (MSS) packaging configuration. MssPackage *types.MssPackage // Control whether origination of video is allowed for this OriginEndpoint. If set // to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of // access control. If set to DENY, the OriginEndpoint may not be requested. This // can be helpful for Live to VOD harvesting, or for temporarily disabling // origination Origination types.Origination // Maximum duration (seconds) of content to retain for startover playback. If not // specified, startover playback will be disabled for the OriginEndpoint. StartoverWindowSeconds int32 // A collection of tags associated with a resource Tags map[string]string // Amount of delay (seconds) to enforce on the playback of live content. If not // specified, there will be no time delay in effect for the OriginEndpoint. TimeDelaySeconds int32 // The URL of the packaged OriginEndpoint for consumption. Url *string // A list of source IP CIDR blocks that will be allowed to access the // OriginEndpoint. Whitelist []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files ¶
api_client.go api_op_ConfigureLogs.go api_op_CreateChannel.go api_op_CreateHarvestJob.go api_op_CreateOriginEndpoint.go api_op_DeleteChannel.go api_op_DeleteOriginEndpoint.go api_op_DescribeChannel.go api_op_DescribeHarvestJob.go api_op_DescribeOriginEndpoint.go api_op_ListChannels.go api_op_ListHarvestJobs.go api_op_ListOriginEndpoints.go api_op_ListTagsForResource.go api_op_RotateChannelCredentials.go api_op_RotateIngestEndpointCredentials.go api_op_TagResource.go api_op_UntagResource.go api_op_UpdateChannel.go api_op_UpdateOriginEndpoint.go deserializers.go doc.go endpoints.go go_module_metadata.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v1.16.3
- Published
- Jun 29, 2022
- Platform
- js/wasm
- Imports
- 31 packages
- Last checked
- now –
Tools for package owners.