mediatailor

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 7 Imported by: 10

Documentation

Overview

Package mediatailor provides the client and types for making API requests to MediaTailor.

See https://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23 for more information on this service.

See mediatailor package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/mediatailor/

Using the Client

To use MediaTailor with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the MediaTailor client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/mediatailor/#New

Index

Constants

View Source 
const (
	ServiceName = "MediaTailor"     // Service's name
	ServiceID   = "MediaTailor"     // Service's identifier
	EndpointsID = "api.mediatailor" // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// One of the parameters in the request is invalid.
	ErrCodeBadRequestException = "BadRequestException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AvailSuppression added in v0.21.0 

type AvailSuppression struct {
	Mode Mode `type:"string" enum:"true"`

	// Sets the mode for avail suppression, also known as ad suppression. By default,
	// ad suppression is off and all ad breaks are filled by MediaTailor with ads
	// or slate.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

func (AvailSuppression) MarshalFields added in v0.21.0 

func (s AvailSuppression) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AvailSuppression) String added in v0.21.0 

func (s AvailSuppression) String() string

String returns the string representation

type Bumper added in v0.24.0 

type Bumper struct {
	EndUrl *string `type:"string"`

	StartUrl *string `type:"string"`
	// contains filtered or unexported fields
}

The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break.

func (Bumper) MarshalFields added in v0.24.0 

func (s Bumper) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Bumper) String added in v0.24.0 

func (s Bumper) String() string

String returns the string representation

type CdnConfiguration 

type CdnConfiguration struct {

	// A non-default content delivery network (CDN) to serve ad segments. By default,
	// AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings
	// as its CDN for ad segments. To set up an alternate CDN, create a rule in
	// your CDN for the following origin: ads.mediatailor.<region>.amazonaws.com.
	// Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental
	// MediaTailor serves a manifest, it reports your CDN as the source for ad segments.
	AdSegmentUrlPrefix *string `type:"string"`

	// A content delivery network (CDN) to cache content segments, so that content
	// requests don’t always have to go to the origin server. First, create a
	// rule in your CDN for the content segment origin server. Then specify the
	// rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor
	// serves a manifest, it reports your CDN as the source for content segments.
	ContentSegmentUrlPrefix *string `type:"string"`
	// contains filtered or unexported fields
}

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

func (CdnConfiguration) MarshalFields 

func (s CdnConfiguration) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CdnConfiguration) String 

func (s CdnConfiguration) String() string

String returns the string representation

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to MediaTailor. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := mediatailor.New(myConfig)

func (*Client) DeletePlaybackConfigurationRequest added in v0.9.0 

func (c *Client) DeletePlaybackConfigurationRequest(input *DeletePlaybackConfigurationInput) DeletePlaybackConfigurationRequest

DeletePlaybackConfigurationRequest returns a request value for making API operation for AWS MediaTailor.

Deletes the playback configuration for the specified name. 

// Example sending a request using DeletePlaybackConfigurationRequest.
req := client.DeletePlaybackConfigurationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeletePlaybackConfiguration

func (*Client) GetPlaybackConfigurationRequest added in v0.9.0 

func (c *Client) GetPlaybackConfigurationRequest(input *GetPlaybackConfigurationInput) GetPlaybackConfigurationRequest

GetPlaybackConfigurationRequest returns a request value for making API operation for AWS MediaTailor.

Returns the playback configuration for the specified name. 

// Example sending a request using GetPlaybackConfigurationRequest.
req := client.GetPlaybackConfigurationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetPlaybackConfiguration

func (*Client) ListPlaybackConfigurationsRequest added in v0.9.0 

func (c *Client) ListPlaybackConfigurationsRequest(input *ListPlaybackConfigurationsInput) ListPlaybackConfigurationsRequest

ListPlaybackConfigurationsRequest returns a request value for making API operation for AWS MediaTailor.

Returns a list of the playback configurations defined in AWS Elemental MediaTailor. You can specify a maximum number of configurations to return at a time. The default maximum is 50. Results are returned in pagefuls. If MediaTailor has more configurations than the specified maximum, it provides parameters in the response that you can use to retrieve the next pageful. 

// Example sending a request using ListPlaybackConfigurationsRequest.
req := client.ListPlaybackConfigurationsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListPlaybackConfigurations

func (*Client) ListTagsForResourceRequest added in v0.9.0 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for AWS MediaTailor.

Returns a list of the tags assigned to the specified playback configuration resource. 

// Example sending a request using ListTagsForResourceRequest.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListTagsForResource

func (*Client) PutPlaybackConfigurationRequest added in v0.9.0 

func (c *Client) PutPlaybackConfigurationRequest(input *PutPlaybackConfigurationInput) PutPlaybackConfigurationRequest

PutPlaybackConfigurationRequest returns a request value for making API operation for AWS MediaTailor.

Adds a new playback configuration to AWS Elemental MediaTailor. 

// Example sending a request using PutPlaybackConfigurationRequest.
req := client.PutPlaybackConfigurationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/PutPlaybackConfiguration

func (*Client) TagResourceRequest added in v0.9.0 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for AWS MediaTailor.

Adds tags to the specified playback configuration resource. You can specify one or more tags to add. 

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/TagResource

func (*Client) UntagResourceRequest added in v0.9.0 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for AWS MediaTailor.

Removes tags from the specified playback configuration resource. You can specify one or more tags to remove. 

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UntagResource

type DashConfiguration added in v0.6.0 

type DashConfiguration struct {

	// The URL generated by MediaTailor to initiate a playback session. The session
	// uses server-side reporting. This setting is ignored in PUT operations.
	ManifestEndpointPrefix *string `type:"string"`

	// The setting that controls whether MediaTailor includes the Location tag in
	// DASH manifests. MediaTailor populates the Location tag with the URL for manifest
	// update requests, to be used by players that don't support sticky redirects.
	// Disable this if you have CDN routing rules set up for accessing MediaTailor
	// manifests, and you are either using client-side reporting or your players
	// support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT.
	// The EMT_DEFAULT setting enables the inclusion of the tag and is the default
	// value.
	MpdLocation *string `type:"string"`

	// The setting that controls whether MediaTailor handles manifests from the
	// origin server as multi-period manifests or single-period manifests. If your
	// origin server produces single-period manifests, set this to SINGLE_PERIOD.
	// The default setting is MULTI_PERIOD. For multi-period manifests, omit this
	// setting or set it to MULTI_PERIOD.
	OriginManifestType OriginManifestType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

The configuration for DASH content.

func (DashConfiguration) MarshalFields added in v0.6.0 

func (s DashConfiguration) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DashConfiguration) String added in v0.6.0 

func (s DashConfiguration) String() string

String returns the string representation

type DashConfigurationForPut added in v0.7.0 

type DashConfigurationForPut struct {

	// The setting that controls whether MediaTailor includes the Location tag in
	// DASH manifests. MediaTailor populates the Location tag with the URL for manifest
	// update requests, to be used by players that don't support sticky redirects.
	// Disable this if you have CDN routing rules set up for accessing MediaTailor
	// manifests, and you are either using client-side reporting or your players
	// support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT.
	// The EMT_DEFAULT setting enables the inclusion of the tag and is the default
	// value.
	MpdLocation *string `type:"string"`

	// The setting that controls whether MediaTailor handles manifests from the
	// origin server as multi-period manifests or single-period manifests. If your
	// origin server produces single-period manifests, set this to SINGLE_PERIOD.
	// The default setting is MULTI_PERIOD. For multi-period manifests, omit this
	// setting or set it to MULTI_PERIOD.
	OriginManifestType OriginManifestType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

The configuration for DASH PUT operations.

func (DashConfigurationForPut) MarshalFields added in v0.7.0 

func (s DashConfigurationForPut) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DashConfigurationForPut) String added in v0.7.0 

func (s DashConfigurationForPut) String() string

String returns the string representation

type DeletePlaybackConfigurationInput 

type DeletePlaybackConfigurationInput struct {

	// Name is a required field
	Name *string `location:"uri" locationName:"Name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeletePlaybackConfigurationInput) MarshalFields 

func (s DeletePlaybackConfigurationInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeletePlaybackConfigurationInput) String 

func (s DeletePlaybackConfigurationInput) String() string

String returns the string representation

func (*DeletePlaybackConfigurationInput) Validate 

func (s *DeletePlaybackConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeletePlaybackConfigurationOutput 

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

func (DeletePlaybackConfigurationOutput) MarshalFields 

func (s DeletePlaybackConfigurationOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeletePlaybackConfigurationOutput) String 

func (s DeletePlaybackConfigurationOutput) String() string

String returns the string representation

type DeletePlaybackConfigurationRequest 

type DeletePlaybackConfigurationRequest struct {
	*aws.Request
	Input *DeletePlaybackConfigurationInput
	Copy  func(*DeletePlaybackConfigurationInput) DeletePlaybackConfigurationRequest
}

DeletePlaybackConfigurationRequest is the request type for the DeletePlaybackConfiguration API operation.

func (DeletePlaybackConfigurationRequest) Send 

func (r DeletePlaybackConfigurationRequest) Send(ctx context.Context) (*DeletePlaybackConfigurationResponse, error)

Send marshals and sends the DeletePlaybackConfiguration API request.

type DeletePlaybackConfigurationResponse added in v0.9.0 

type DeletePlaybackConfigurationResponse struct {
	*DeletePlaybackConfigurationOutput
	// contains filtered or unexported fields
}

DeletePlaybackConfigurationResponse is the response type for the DeletePlaybackConfiguration API operation.

func (*DeletePlaybackConfigurationResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeletePlaybackConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeletePlaybackConfiguration request.

type GetPlaybackConfigurationInput 

type GetPlaybackConfigurationInput struct {

	// Name is a required field
	Name *string `location:"uri" locationName:"Name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetPlaybackConfigurationInput) MarshalFields 

func (s GetPlaybackConfigurationInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetPlaybackConfigurationInput) String 

func (s GetPlaybackConfigurationInput) String() string

String returns the string representation

func (*GetPlaybackConfigurationInput) Validate 

func (s *GetPlaybackConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetPlaybackConfigurationOutput 

type GetPlaybackConfigurationOutput struct {

	// The URL for the ad decision server (ADS). This includes the specification
	// of static parameters and placeholders for dynamic parameters. AWS Elemental
	// MediaTailor substitutes player-specific and session-specific parameters as
	// needed when calling the ADS. Alternately, for testing, you can provide a
	// static VAST URL. The maximum length is 25,000 characters.
	AdDecisionServerUrl *string `type:"string"`

	// The configuration for Avail Suppression.
	AvailSuppression *AvailSuppression `type:"structure"`

	// The configuration for bumpers. Bumpers are short audio or video clips that
	// play at the start or before the end of an ad break.
	Bumper *Bumper `type:"structure"`

	// The configuration for using a content delivery network (CDN), like Amazon
	// CloudFront, for content and ad segment management.
	CdnConfiguration *CdnConfiguration `type:"structure"`

	// The configuration for DASH content.
	DashConfiguration *DashConfiguration `type:"structure"`

	// The configuration for HLS content.
	HlsConfiguration *HlsConfiguration `type:"structure"`

	// The configuration for pre-roll ad insertion.
	LivePreRollConfiguration *LivePreRollConfiguration `type:"structure"`

	// The identifier for the playback configuration.
	Name *string `type:"string"`

	PersonalizationThresholdSeconds *int64 `min:"1" type:"integer"`

	// The Amazon Resource Name (ARN) for the playback configuration.
	PlaybackConfigurationArn *string `type:"string"`

	// The URL that the player accesses to get a manifest from AWS Elemental MediaTailor.
	// This session will use server-side reporting.
	PlaybackEndpointPrefix *string `type:"string"`

	// The URL that the player uses to initialize a session that uses client-side
	// reporting.
	SessionInitializationEndpointPrefix *string `type:"string"`

	// The URL for a high-quality video asset to transcode and use to fill in time
	// that's not used by ads. AWS Elemental MediaTailor shows the slate to fill
	// in gaps in media content. Configuring the slate is optional for non-VPAID
	// playback configurations. For VPAID, the slate is required because MediaTailor
	// provides it in the slots designated for dynamic ad content. The slate must
	// be a high-quality asset that contains both audio and video.
	SlateAdUrl *string `type:"string"`

	// The tags assigned to the playback configuration.
	Tags map[string]string `locationName:"tags" type:"map"`

	// The name that is used to associate this playback configuration with a custom
	// transcode profile. This overrides the dynamic transcoding defaults of MediaTailor.
	// Use this only if you have already set up custom profiles with the help of
	// AWS Support.
	TranscodeProfileName *string `type:"string"`

	// The URL prefix for the master playlist for the stream, minus the asset ID.
	// The maximum length is 512 characters.
	VideoContentSourceUrl *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetPlaybackConfigurationOutput) MarshalFields 

func (s GetPlaybackConfigurationOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetPlaybackConfigurationOutput) String 

func (s GetPlaybackConfigurationOutput) String() string

String returns the string representation

type GetPlaybackConfigurationRequest 

type GetPlaybackConfigurationRequest struct {
	*aws.Request
	Input *GetPlaybackConfigurationInput
	Copy  func(*GetPlaybackConfigurationInput) GetPlaybackConfigurationRequest
}

GetPlaybackConfigurationRequest is the request type for the GetPlaybackConfiguration API operation.

func (GetPlaybackConfigurationRequest) Send 

func (r GetPlaybackConfigurationRequest) Send(ctx context.Context) (*GetPlaybackConfigurationResponse, error)

Send marshals and sends the GetPlaybackConfiguration API request.

type GetPlaybackConfigurationResponse added in v0.9.0 

type GetPlaybackConfigurationResponse struct {
	*GetPlaybackConfigurationOutput
	// contains filtered or unexported fields
}

GetPlaybackConfigurationResponse is the response type for the GetPlaybackConfiguration API operation.

func (*GetPlaybackConfigurationResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetPlaybackConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetPlaybackConfiguration request.

type HlsConfiguration 

type HlsConfiguration struct {

	// The URL that is used to initiate a playback session for devices that support
	// Apple HLS. The session uses server-side reporting.
	ManifestEndpointPrefix *string `type:"string"`
	// contains filtered or unexported fields
}

The configuration for HLS content.

func (HlsConfiguration) MarshalFields 

func (s HlsConfiguration) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (HlsConfiguration) String 

func (s HlsConfiguration) String() string

String returns the string representation

type ListPlaybackConfigurationsInput 

type ListPlaybackConfigurationsInput struct {
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListPlaybackConfigurationsInput) MarshalFields 

func (s ListPlaybackConfigurationsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListPlaybackConfigurationsInput) String 

func (s ListPlaybackConfigurationsInput) String() string

String returns the string representation

func (*ListPlaybackConfigurationsInput) Validate 

func (s *ListPlaybackConfigurationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListPlaybackConfigurationsOutput 

type ListPlaybackConfigurationsOutput struct {

	// Array of playback configurations. This might be all the available configurations
	// or a subset, depending on the settings that you provide and the total number
	// of configurations stored.
	Items []PlaybackConfiguration `type:"list"`

	// Pagination token returned by the GET list request when results exceed the
	// maximum allowed. Use the token to fetch the next page of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListPlaybackConfigurationsOutput) MarshalFields 

func (s ListPlaybackConfigurationsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListPlaybackConfigurationsOutput) String 

func (s ListPlaybackConfigurationsOutput) String() string

String returns the string representation

type ListPlaybackConfigurationsRequest 

type ListPlaybackConfigurationsRequest struct {
	*aws.Request
	Input *ListPlaybackConfigurationsInput
	Copy  func(*ListPlaybackConfigurationsInput) ListPlaybackConfigurationsRequest
}

ListPlaybackConfigurationsRequest is the request type for the ListPlaybackConfigurations API operation.

func (ListPlaybackConfigurationsRequest) Send 

func (r ListPlaybackConfigurationsRequest) Send(ctx context.Context) (*ListPlaybackConfigurationsResponse, error)

Send marshals and sends the ListPlaybackConfigurations API request.

type ListPlaybackConfigurationsResponse added in v0.9.0 

type ListPlaybackConfigurationsResponse struct {
	*ListPlaybackConfigurationsOutput
	// contains filtered or unexported fields
}

ListPlaybackConfigurationsResponse is the response type for the ListPlaybackConfigurations API operation.

func (*ListPlaybackConfigurationsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListPlaybackConfigurationsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListPlaybackConfigurations request.

type ListTagsForResourceInput added in v0.8.0 

type ListTagsForResourceInput struct {

	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) MarshalFields added in v0.8.0 

func (s ListTagsForResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceInput) String added in v0.8.0 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v0.8.0 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v0.8.0 

type ListTagsForResourceOutput struct {
	Tags map[string]string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) MarshalFields added in v0.8.0 

func (s ListTagsForResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceOutput) String added in v0.8.0 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest added in v0.8.0 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send added in v0.8.0 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.9.0 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type LivePreRollConfiguration added in v0.18.0 

type LivePreRollConfiguration struct {

	// The URL for the ad decision server (ADS) for pre-roll ads. This includes
	// the specification of static parameters and placeholders for dynamic parameters.
	// AWS Elemental MediaTailor substitutes player-specific and session-specific
	// parameters as needed when calling the ADS. Alternately, for testing, you
	// can provide a static VAST URL. The maximum length is 25,000 characters.
	AdDecisionServerUrl *string `type:"string"`

	// The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor
	// won't play pre-roll ads to exceed this duration, regardless of the total
	// duration of ads that the ADS returns.
	MaxDurationSeconds *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The configuration for pre-roll ad insertion.

func (LivePreRollConfiguration) MarshalFields added in v0.18.0 

func (s LivePreRollConfiguration) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (LivePreRollConfiguration) String added in v0.18.0 

func (s LivePreRollConfiguration) String() string

String returns the string representation

type Mode added in v0.21.0 

type Mode string
const (
	ModeOff            Mode = "OFF"
	ModeBehindLiveEdge Mode = "BEHIND_LIVE_EDGE"
)

Enum values for Mode

func (Mode) MarshalValue added in v0.21.0 

func (enum Mode) MarshalValue() (string, error)

func (Mode) MarshalValueBuf added in v0.21.0 

func (enum Mode) MarshalValueBuf(b []byte) ([]byte, error)

type OriginManifestType added in v0.8.0 

type OriginManifestType string
const (
	OriginManifestTypeSinglePeriod OriginManifestType = "SINGLE_PERIOD"
	OriginManifestTypeMultiPeriod  OriginManifestType = "MULTI_PERIOD"
)

Enum values for OriginManifestType

func (OriginManifestType) MarshalValue added in v0.8.0 

func (enum OriginManifestType) MarshalValue() (string, error)

func (OriginManifestType) MarshalValueBuf added in v0.8.0 

func (enum OriginManifestType) MarshalValueBuf(b []byte) ([]byte, error)

type PlaybackConfiguration 

type PlaybackConfiguration struct {
	AdDecisionServerUrl *string `type:"string"`

	// The configuration for using a content delivery network (CDN), like Amazon
	// CloudFront, for content and ad segment management.
	CdnConfiguration *CdnConfiguration `type:"structure"`

	// The configuration for DASH content.
	DashConfiguration *DashConfiguration `type:"structure"`

	// The configuration for HLS content.
	HlsConfiguration *HlsConfiguration `type:"structure"`

	Name *string `type:"string"`

	PersonalizationThresholdSeconds *int64 `min:"1" type:"integer"`

	PlaybackConfigurationArn *string `type:"string"`

	PlaybackEndpointPrefix *string `type:"string"`

	SessionInitializationEndpointPrefix *string `type:"string"`

	SlateAdUrl *string `type:"string"`

	Tags map[string]string `locationName:"tags" type:"map"`

	TranscodeProfileName *string `type:"string"`

	VideoContentSourceUrl *string `type:"string"`
	// contains filtered or unexported fields
}

func (PlaybackConfiguration) MarshalFields 

func (s PlaybackConfiguration) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PlaybackConfiguration) String 

func (s PlaybackConfiguration) String() string

String returns the string representation

type PutPlaybackConfigurationInput 

type PutPlaybackConfigurationInput struct {

	// The URL for the ad decision server (ADS). This includes the specification
	// of static parameters and placeholders for dynamic parameters. AWS Elemental
	// MediaTailor substitutes player-specific and session-specific parameters as
	// needed when calling the ADS. Alternately, for testing you can provide a static
	// VAST URL. The maximum length is 25,000 characters.
	AdDecisionServerUrl *string `type:"string"`

	// The configuration for Avail Suppression.
	AvailSuppression *AvailSuppression `type:"structure"`

	// The configuration for bumpers. Bumpers are short audio or video clips that
	// play at the start or before the end of an ad break.
	Bumper *Bumper `type:"structure"`

	// The configuration for using a content delivery network (CDN), like Amazon
	// CloudFront, for content and ad segment management.
	CdnConfiguration *CdnConfiguration `type:"structure"`

	// The configuration for DASH content.
	DashConfiguration *DashConfigurationForPut `type:"structure"`

	// The configuration for pre-roll ad insertion.
	LivePreRollConfiguration *LivePreRollConfiguration `type:"structure"`

	// The identifier for the playback configuration.
	Name *string `type:"string"`

	PersonalizationThresholdSeconds *int64 `min:"1" type:"integer"`

	// The URL for a high-quality video asset to transcode and use to fill in time
	// that's not used by ads. AWS Elemental MediaTailor shows the slate to fill
	// in gaps in media content. Configuring the slate is optional for non-VPAID
	// configurations. For VPAID, the slate is required because MediaTailor provides
	// it in the slots that are designated for dynamic ad content. The slate must
	// be a high-quality asset that contains both audio and video.
	SlateAdUrl *string `type:"string"`

	// The tags to assign to the playback configuration.
	Tags map[string]string `locationName:"tags" type:"map"`

	// The name that is used to associate this playback configuration with a custom
	// transcode profile. This overrides the dynamic transcoding defaults of MediaTailor.
	// Use this only if you have already set up custom profiles with the help of
	// AWS Support.
	TranscodeProfileName *string `type:"string"`

	// The URL prefix for the master playlist for the stream, minus the asset ID.
	// The maximum length is 512 characters.
	VideoContentSourceUrl *string `type:"string"`
	// contains filtered or unexported fields
}

func (PutPlaybackConfigurationInput) MarshalFields 

func (s PutPlaybackConfigurationInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutPlaybackConfigurationInput) String 

func (s PutPlaybackConfigurationInput) String() string

String returns the string representation

func (*PutPlaybackConfigurationInput) Validate added in v0.20.0 

func (s *PutPlaybackConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutPlaybackConfigurationOutput 

type PutPlaybackConfigurationOutput struct {
	AdDecisionServerUrl *string `type:"string"`

	AvailSuppression *AvailSuppression `type:"structure"`

	// The configuration for bumpers. Bumpers are short audio or video clips that
	// play at the start or before the end of an ad break.
	Bumper *Bumper `type:"structure"`

	// The configuration for using a content delivery network (CDN), like Amazon
	// CloudFront, for content and ad segment management.
	CdnConfiguration *CdnConfiguration `type:"structure"`

	// The configuration for DASH content.
	DashConfiguration *DashConfiguration `type:"structure"`

	// The configuration for HLS content.
	HlsConfiguration *HlsConfiguration `type:"structure"`

	// The configuration for pre-roll ad insertion.
	LivePreRollConfiguration *LivePreRollConfiguration `type:"structure"`

	Name *string `type:"string"`

	PlaybackConfigurationArn *string `type:"string"`

	PlaybackEndpointPrefix *string `type:"string"`

	SessionInitializationEndpointPrefix *string `type:"string"`

	SlateAdUrl *string `type:"string"`

	Tags map[string]string `locationName:"tags" type:"map"`

	TranscodeProfileName *string `type:"string"`

	VideoContentSourceUrl *string `type:"string"`
	// contains filtered or unexported fields
}

func (PutPlaybackConfigurationOutput) MarshalFields 

func (s PutPlaybackConfigurationOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutPlaybackConfigurationOutput) String 

func (s PutPlaybackConfigurationOutput) String() string

String returns the string representation

type PutPlaybackConfigurationRequest 

type PutPlaybackConfigurationRequest struct {
	*aws.Request
	Input *PutPlaybackConfigurationInput
	Copy  func(*PutPlaybackConfigurationInput) PutPlaybackConfigurationRequest
}

PutPlaybackConfigurationRequest is the request type for the PutPlaybackConfiguration API operation.

func (PutPlaybackConfigurationRequest) Send 

func (r PutPlaybackConfigurationRequest) Send(ctx context.Context) (*PutPlaybackConfigurationResponse, error)

Send marshals and sends the PutPlaybackConfiguration API request.

type PutPlaybackConfigurationResponse added in v0.9.0 

type PutPlaybackConfigurationResponse struct {
	*PutPlaybackConfigurationOutput
	// contains filtered or unexported fields
}

PutPlaybackConfigurationResponse is the response type for the PutPlaybackConfiguration API operation.

func (*PutPlaybackConfigurationResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutPlaybackConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutPlaybackConfiguration request.

type TagResourceInput added in v0.8.0 

type TagResourceInput struct {

	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"`

	// Tags is a required field
	Tags map[string]string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) MarshalFields added in v0.8.0 

func (s TagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceInput) String added in v0.8.0 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v0.8.0 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v0.8.0 

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

func (TagResourceOutput) MarshalFields added in v0.8.0 

func (s TagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceOutput) String added in v0.8.0 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest added in v0.8.0 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send added in v0.8.0 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse added in v0.9.0 

type TagResourceResponse struct {
	*TagResourceOutput
	// contains filtered or unexported fields
}

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type UntagResourceInput added in v0.8.0 

type UntagResourceInput struct {

	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"`

	// TagKeys is a required field
	TagKeys []string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) MarshalFields added in v0.8.0 

func (s UntagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceInput) String added in v0.8.0 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v0.8.0 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v0.8.0 

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

func (UntagResourceOutput) MarshalFields added in v0.8.0 

func (s UntagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceOutput) String added in v0.8.0 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest added in v0.8.0 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send added in v0.8.0 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse added in v0.9.0 

type UntagResourceResponse struct {
	*UntagResourceOutput
	// contains filtered or unexported fields
}

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

Source Files

View all Source files

Directories

Path Synopsis
Package mediatailoriface provides an interface to enable mocking the AWS MediaTailor service client for testing your code.
 Package mediatailoriface provides an interface to enable mocking the AWS MediaTailor service client for testing your code.

Jump to

Keyboard shortcuts

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