mediatailor

package
v1.16.9-custom-go-mod Latest Latest
Warning

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

 Go to latest Published: Mar 29, 2021 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

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

Use the AWS Elemental MediaTailor SDK to configure scalable ad insertion for your live and VOD content. With AWS Elemental MediaTailor, you can serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the AWS Elemental MediaTailor User Guide.Through the SDK, you manage AWS Elemental MediaTailor configurations the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).

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 contact AWS 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 AWS MediaTailor client MediaTailor 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 = "api.mediatailor" // Name of service.
	EndpointsID = ServiceName       // ID to lookup a service endpoint with.
	ServiceID   = "MediaTailor"     // ServiceID is a unique identifer of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

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) GoString 

func (s CdnConfiguration) GoString() string

GoString returns the string representation

func (*CdnConfiguration) SetAdSegmentUrlPrefix 

func (s *CdnConfiguration) SetAdSegmentUrlPrefix(v string) *CdnConfiguration

SetAdSegmentUrlPrefix sets the AdSegmentUrlPrefix field's value.

func (*CdnConfiguration) SetContentSegmentUrlPrefix 

func (s *CdnConfiguration) SetContentSegmentUrlPrefix(v string) *CdnConfiguration

SetContentSegmentUrlPrefix sets the ContentSegmentUrlPrefix field's value.

func (CdnConfiguration) String 

func (s CdnConfiguration) String() string

String returns the string representation

type DashConfiguration 

type DashConfiguration struct {

	// The URL that is used to initiate a playback session for devices that support
	// DASH.
	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"`
	// contains filtered or unexported fields
}

The configuration object for dash content.

func (DashConfiguration) GoString 

func (s DashConfiguration) GoString() string

GoString returns the string representation

func (*DashConfiguration) SetManifestEndpointPrefix 

func (s *DashConfiguration) SetManifestEndpointPrefix(v string) *DashConfiguration

SetManifestEndpointPrefix sets the ManifestEndpointPrefix field's value.

func (*DashConfiguration) SetMpdLocation 

func (s *DashConfiguration) SetMpdLocation(v string) *DashConfiguration

SetMpdLocation sets the MpdLocation field's value.

func (DashConfiguration) String 

func (s DashConfiguration) String() string

String returns the string representation

type DashConfigurationForPut 

type DashConfigurationForPut struct {
	MpdLocation *string `type:"string"`
	// contains filtered or unexported fields
}

func (DashConfigurationForPut) GoString 

func (s DashConfigurationForPut) GoString() string

GoString returns the string representation

func (*DashConfigurationForPut) SetMpdLocation 

func (s *DashConfigurationForPut) SetMpdLocation(v string) *DashConfigurationForPut

SetMpdLocation sets the MpdLocation field's value.

func (DashConfigurationForPut) String 

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) GoString 

func (s DeletePlaybackConfigurationInput) GoString() string

GoString returns the string representation

func (*DeletePlaybackConfigurationInput) SetName 

func (s *DeletePlaybackConfigurationInput) SetName(v string) *DeletePlaybackConfigurationInput

SetName sets the Name field's value.

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) GoString 

func (s DeletePlaybackConfigurationOutput) GoString() string

GoString returns the string representation

func (DeletePlaybackConfigurationOutput) String 

func (s DeletePlaybackConfigurationOutput) String() string

String returns the string representation

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) GoString 

func (s GetPlaybackConfigurationInput) GoString() string

GoString returns the string representation

func (*GetPlaybackConfigurationInput) SetName 

func (s *GetPlaybackConfigurationInput) SetName(v string) *GetPlaybackConfigurationInput

SetName sets the Name field's value.

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 25000 characters.
	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 object for dash content.
	DashConfiguration *DashConfiguration `type:"structure"`

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

	// The identifier for the configuration.
	Name *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"`

	// 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 AWS Elemental 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"`

	// Associate this playbackConfiguration with a custom transcode profile, overriding
	// MediaTailor's dynamic transcoding defaults. Do not include this field if
	// you have not setup custom profiles with the MediaTailor service team.
	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) GoString 

func (s GetPlaybackConfigurationOutput) GoString() string

GoString returns the string representation

func (*GetPlaybackConfigurationOutput) SetAdDecisionServerUrl 

func (s *GetPlaybackConfigurationOutput) SetAdDecisionServerUrl(v string) *GetPlaybackConfigurationOutput

SetAdDecisionServerUrl sets the AdDecisionServerUrl field's value.

func (*GetPlaybackConfigurationOutput) SetCdnConfiguration 

func (s *GetPlaybackConfigurationOutput) SetCdnConfiguration(v *CdnConfiguration) *GetPlaybackConfigurationOutput

SetCdnConfiguration sets the CdnConfiguration field's value.

func (*GetPlaybackConfigurationOutput) SetDashConfiguration 

func (s *GetPlaybackConfigurationOutput) SetDashConfiguration(v *DashConfiguration) *GetPlaybackConfigurationOutput

SetDashConfiguration sets the DashConfiguration field's value.

func (*GetPlaybackConfigurationOutput) SetHlsConfiguration 

func (s *GetPlaybackConfigurationOutput) SetHlsConfiguration(v *HlsConfiguration) *GetPlaybackConfigurationOutput

SetHlsConfiguration sets the HlsConfiguration field's value.

func (*GetPlaybackConfigurationOutput) SetName 

func (s *GetPlaybackConfigurationOutput) SetName(v string) *GetPlaybackConfigurationOutput

SetName sets the Name field's value.

func (*GetPlaybackConfigurationOutput) SetPlaybackEndpointPrefix 

func (s *GetPlaybackConfigurationOutput) SetPlaybackEndpointPrefix(v string) *GetPlaybackConfigurationOutput

SetPlaybackEndpointPrefix sets the PlaybackEndpointPrefix field's value.

func (*GetPlaybackConfigurationOutput) SetSessionInitializationEndpointPrefix 

func (s *GetPlaybackConfigurationOutput) SetSessionInitializationEndpointPrefix(v string) *GetPlaybackConfigurationOutput

SetSessionInitializationEndpointPrefix sets the SessionInitializationEndpointPrefix field's value.

func (*GetPlaybackConfigurationOutput) SetSlateAdUrl 

func (s *GetPlaybackConfigurationOutput) SetSlateAdUrl(v string) *GetPlaybackConfigurationOutput

SetSlateAdUrl sets the SlateAdUrl field's value.

func (*GetPlaybackConfigurationOutput) SetTranscodeProfileName 

func (s *GetPlaybackConfigurationOutput) SetTranscodeProfileName(v string) *GetPlaybackConfigurationOutput

SetTranscodeProfileName sets the TranscodeProfileName field's value.

func (*GetPlaybackConfigurationOutput) SetVideoContentSourceUrl 

func (s *GetPlaybackConfigurationOutput) SetVideoContentSourceUrl(v string) *GetPlaybackConfigurationOutput

SetVideoContentSourceUrl sets the VideoContentSourceUrl field's value.

func (GetPlaybackConfigurationOutput) String 

func (s GetPlaybackConfigurationOutput) String() string

String returns the string representation

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) GoString 

func (s HlsConfiguration) GoString() string

GoString returns the string representation

func (*HlsConfiguration) SetManifestEndpointPrefix 

func (s *HlsConfiguration) SetManifestEndpointPrefix(v string) *HlsConfiguration

SetManifestEndpointPrefix sets the ManifestEndpointPrefix field's value.

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) GoString 

func (s ListPlaybackConfigurationsInput) GoString() string

GoString returns the string representation

func (*ListPlaybackConfigurationsInput) SetMaxResults 

func (s *ListPlaybackConfigurationsInput) SetMaxResults(v int64) *ListPlaybackConfigurationsInput

SetMaxResults sets the MaxResults field's value.

func (*ListPlaybackConfigurationsInput) SetNextToken 

func (s *ListPlaybackConfigurationsInput) SetNextToken(v string) *ListPlaybackConfigurationsInput

SetNextToken sets the NextToken field's value.

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 may be all of the available configurations
	// or a subset, depending on the settings you provide and on the total number
	// of configurations stored.
	Items []*PlaybackConfiguration `type:"list"`

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

func (ListPlaybackConfigurationsOutput) GoString 

func (s ListPlaybackConfigurationsOutput) GoString() string

GoString returns the string representation

func (*ListPlaybackConfigurationsOutput) SetItems 

func (s *ListPlaybackConfigurationsOutput) SetItems(v []*PlaybackConfiguration) *ListPlaybackConfigurationsOutput

SetItems sets the Items field's value.

func (*ListPlaybackConfigurationsOutput) SetNextToken 

func (s *ListPlaybackConfigurationsOutput) SetNextToken(v string) *ListPlaybackConfigurationsOutput

SetNextToken sets the NextToken field's value.

func (ListPlaybackConfigurationsOutput) String 

func (s ListPlaybackConfigurationsOutput) String() string

String returns the string representation

type MediaTailor 

type MediaTailor struct {
	*client.Client
}

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

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

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *MediaTailor

New creates a new instance of the MediaTailor client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a MediaTailor client from just a session.
svc := mediatailor.New(mySession)

// Create a MediaTailor client with additional configuration
svc := mediatailor.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*MediaTailor) DeletePlaybackConfiguration 

func (c *MediaTailor) DeletePlaybackConfiguration(input *DeletePlaybackConfigurationInput) (*DeletePlaybackConfigurationOutput, error)

DeletePlaybackConfiguration API operation for AWS MediaTailor.

Deletes the configuration for the specified name.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS MediaTailor's API operation DeletePlaybackConfiguration for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeletePlaybackConfiguration

func (*MediaTailor) DeletePlaybackConfigurationRequest 

func (c *MediaTailor) DeletePlaybackConfigurationRequest(input *DeletePlaybackConfigurationInput) (req *request.Request, output *DeletePlaybackConfigurationOutput)

DeletePlaybackConfigurationRequest generates a "aws/request.Request" representing the client's request for the DeletePlaybackConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeletePlaybackConfiguration for more information on using the DeletePlaybackConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeletePlaybackConfigurationRequest method.
req, resp := client.DeletePlaybackConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*MediaTailor) DeletePlaybackConfigurationWithContext 

func (c *MediaTailor) DeletePlaybackConfigurationWithContext(ctx aws.Context, input *DeletePlaybackConfigurationInput, opts ...request.Option) (*DeletePlaybackConfigurationOutput, error)

DeletePlaybackConfigurationWithContext is the same as DeletePlaybackConfiguration with the addition of the ability to pass a context and additional request options.

See DeletePlaybackConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*MediaTailor) GetPlaybackConfiguration 

func (c *MediaTailor) GetPlaybackConfiguration(input *GetPlaybackConfigurationInput) (*GetPlaybackConfigurationOutput, error)

GetPlaybackConfiguration API operation for AWS MediaTailor.

Returns the configuration for the specified name.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS MediaTailor's API operation GetPlaybackConfiguration for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetPlaybackConfiguration

func (*MediaTailor) GetPlaybackConfigurationRequest 

func (c *MediaTailor) GetPlaybackConfigurationRequest(input *GetPlaybackConfigurationInput) (req *request.Request, output *GetPlaybackConfigurationOutput)

GetPlaybackConfigurationRequest generates a "aws/request.Request" representing the client's request for the GetPlaybackConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetPlaybackConfiguration for more information on using the GetPlaybackConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetPlaybackConfigurationRequest method.
req, resp := client.GetPlaybackConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*MediaTailor) GetPlaybackConfigurationWithContext 

func (c *MediaTailor) GetPlaybackConfigurationWithContext(ctx aws.Context, input *GetPlaybackConfigurationInput, opts ...request.Option) (*GetPlaybackConfigurationOutput, error)

GetPlaybackConfigurationWithContext is the same as GetPlaybackConfiguration with the addition of the ability to pass a context and additional request options.

See GetPlaybackConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*MediaTailor) ListPlaybackConfigurations 

func (c *MediaTailor) ListPlaybackConfigurations(input *ListPlaybackConfigurationsInput) (*ListPlaybackConfigurationsOutput, error)

ListPlaybackConfigurations API operation for AWS MediaTailor.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS MediaTailor's API operation ListPlaybackConfigurations for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListPlaybackConfigurations

func (*MediaTailor) ListPlaybackConfigurationsRequest 

func (c *MediaTailor) ListPlaybackConfigurationsRequest(input *ListPlaybackConfigurationsInput) (req *request.Request, output *ListPlaybackConfigurationsOutput)

ListPlaybackConfigurationsRequest generates a "aws/request.Request" representing the client's request for the ListPlaybackConfigurations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPlaybackConfigurations for more information on using the ListPlaybackConfigurations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListPlaybackConfigurationsRequest method.
req, resp := client.ListPlaybackConfigurationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*MediaTailor) ListPlaybackConfigurationsWithContext 

func (c *MediaTailor) ListPlaybackConfigurationsWithContext(ctx aws.Context, input *ListPlaybackConfigurationsInput, opts ...request.Option) (*ListPlaybackConfigurationsOutput, error)

ListPlaybackConfigurationsWithContext is the same as ListPlaybackConfigurations with the addition of the ability to pass a context and additional request options.

See ListPlaybackConfigurations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*MediaTailor) PutPlaybackConfiguration 

func (c *MediaTailor) PutPlaybackConfiguration(input *PutPlaybackConfigurationInput) (*PutPlaybackConfigurationOutput, error)

PutPlaybackConfiguration API operation for AWS MediaTailor.

Adds a new configuration to AWS Elemental MediaTailor.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS MediaTailor's API operation PutPlaybackConfiguration for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/PutPlaybackConfiguration

func (*MediaTailor) PutPlaybackConfigurationRequest 

func (c *MediaTailor) PutPlaybackConfigurationRequest(input *PutPlaybackConfigurationInput) (req *request.Request, output *PutPlaybackConfigurationOutput)

PutPlaybackConfigurationRequest generates a "aws/request.Request" representing the client's request for the PutPlaybackConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutPlaybackConfiguration for more information on using the PutPlaybackConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutPlaybackConfigurationRequest method.
req, resp := client.PutPlaybackConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*MediaTailor) PutPlaybackConfigurationWithContext 

func (c *MediaTailor) PutPlaybackConfigurationWithContext(ctx aws.Context, input *PutPlaybackConfigurationInput, opts ...request.Option) (*PutPlaybackConfigurationOutput, error)

PutPlaybackConfigurationWithContext is the same as PutPlaybackConfiguration with the addition of the ability to pass a context and additional request options.

See PutPlaybackConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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"`

	Name *string `type:"string"`

	SlateAdUrl *string `type:"string"`

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

func (PlaybackConfiguration) GoString 

func (s PlaybackConfiguration) GoString() string

GoString returns the string representation

func (*PlaybackConfiguration) SetAdDecisionServerUrl 

func (s *PlaybackConfiguration) SetAdDecisionServerUrl(v string) *PlaybackConfiguration

SetAdDecisionServerUrl sets the AdDecisionServerUrl field's value.

func (*PlaybackConfiguration) SetCdnConfiguration 

func (s *PlaybackConfiguration) SetCdnConfiguration(v *CdnConfiguration) *PlaybackConfiguration

SetCdnConfiguration sets the CdnConfiguration field's value.

func (*PlaybackConfiguration) SetName 

func (s *PlaybackConfiguration) SetName(v string) *PlaybackConfiguration

SetName sets the Name field's value.

func (*PlaybackConfiguration) SetSlateAdUrl 

func (s *PlaybackConfiguration) SetSlateAdUrl(v string) *PlaybackConfiguration

SetSlateAdUrl sets the SlateAdUrl field's value.

func (*PlaybackConfiguration) SetVideoContentSourceUrl 

func (s *PlaybackConfiguration) SetVideoContentSourceUrl(v string) *PlaybackConfiguration

SetVideoContentSourceUrl sets the VideoContentSourceUrl field's value.

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 25000 characters.
	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"`

	DashConfiguration *DashConfigurationForPut `type:"structure"`

	// The identifier for the configuration.
	Name *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
	// configurations. For VPAID, the slate is required because AWS Elemental 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"`

	// Associate this playbackConfiguration with a custom transcode profile, overriding
	// MediaTailor's dynamic transcoding defaults. Do not include this field if
	// you have not setup custom profiles with the MediaTailor service team.
	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) GoString 

func (s PutPlaybackConfigurationInput) GoString() string

GoString returns the string representation

func (*PutPlaybackConfigurationInput) SetAdDecisionServerUrl 

func (s *PutPlaybackConfigurationInput) SetAdDecisionServerUrl(v string) *PutPlaybackConfigurationInput

SetAdDecisionServerUrl sets the AdDecisionServerUrl field's value.

func (*PutPlaybackConfigurationInput) SetCdnConfiguration 

func (s *PutPlaybackConfigurationInput) SetCdnConfiguration(v *CdnConfiguration) *PutPlaybackConfigurationInput

SetCdnConfiguration sets the CdnConfiguration field's value.

func (*PutPlaybackConfigurationInput) SetDashConfiguration 

func (s *PutPlaybackConfigurationInput) SetDashConfiguration(v *DashConfigurationForPut) *PutPlaybackConfigurationInput

SetDashConfiguration sets the DashConfiguration field's value.

func (*PutPlaybackConfigurationInput) SetName 

func (s *PutPlaybackConfigurationInput) SetName(v string) *PutPlaybackConfigurationInput

SetName sets the Name field's value.

func (*PutPlaybackConfigurationInput) SetSlateAdUrl 

func (s *PutPlaybackConfigurationInput) SetSlateAdUrl(v string) *PutPlaybackConfigurationInput

SetSlateAdUrl sets the SlateAdUrl field's value.

func (*PutPlaybackConfigurationInput) SetTranscodeProfileName 

func (s *PutPlaybackConfigurationInput) SetTranscodeProfileName(v string) *PutPlaybackConfigurationInput

SetTranscodeProfileName sets the TranscodeProfileName field's value.

func (*PutPlaybackConfigurationInput) SetVideoContentSourceUrl 

func (s *PutPlaybackConfigurationInput) SetVideoContentSourceUrl(v string) *PutPlaybackConfigurationInput

SetVideoContentSourceUrl sets the VideoContentSourceUrl field's value.

func (PutPlaybackConfigurationInput) String 

func (s PutPlaybackConfigurationInput) String() string

String returns the string representation

type PutPlaybackConfigurationOutput 

type PutPlaybackConfigurationOutput 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 object for dash content.
	DashConfiguration *DashConfiguration `type:"structure"`

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

	Name *string `type:"string"`

	PlaybackEndpointPrefix *string `type:"string"`

	SessionInitializationEndpointPrefix *string `type:"string"`

	SlateAdUrl *string `type:"string"`

	TranscodeProfileName *string `type:"string"`

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

func (PutPlaybackConfigurationOutput) GoString 

func (s PutPlaybackConfigurationOutput) GoString() string

GoString returns the string representation

func (*PutPlaybackConfigurationOutput) SetAdDecisionServerUrl 

func (s *PutPlaybackConfigurationOutput) SetAdDecisionServerUrl(v string) *PutPlaybackConfigurationOutput

SetAdDecisionServerUrl sets the AdDecisionServerUrl field's value.

func (*PutPlaybackConfigurationOutput) SetCdnConfiguration 

func (s *PutPlaybackConfigurationOutput) SetCdnConfiguration(v *CdnConfiguration) *PutPlaybackConfigurationOutput

SetCdnConfiguration sets the CdnConfiguration field's value.

func (*PutPlaybackConfigurationOutput) SetDashConfiguration 

func (s *PutPlaybackConfigurationOutput) SetDashConfiguration(v *DashConfiguration) *PutPlaybackConfigurationOutput

SetDashConfiguration sets the DashConfiguration field's value.

func (*PutPlaybackConfigurationOutput) SetHlsConfiguration 

func (s *PutPlaybackConfigurationOutput) SetHlsConfiguration(v *HlsConfiguration) *PutPlaybackConfigurationOutput

SetHlsConfiguration sets the HlsConfiguration field's value.

func (*PutPlaybackConfigurationOutput) SetName 

func (s *PutPlaybackConfigurationOutput) SetName(v string) *PutPlaybackConfigurationOutput

SetName sets the Name field's value.

func (*PutPlaybackConfigurationOutput) SetPlaybackEndpointPrefix 

func (s *PutPlaybackConfigurationOutput) SetPlaybackEndpointPrefix(v string) *PutPlaybackConfigurationOutput

SetPlaybackEndpointPrefix sets the PlaybackEndpointPrefix field's value.

func (*PutPlaybackConfigurationOutput) SetSessionInitializationEndpointPrefix 

func (s *PutPlaybackConfigurationOutput) SetSessionInitializationEndpointPrefix(v string) *PutPlaybackConfigurationOutput

SetSessionInitializationEndpointPrefix sets the SessionInitializationEndpointPrefix field's value.

func (*PutPlaybackConfigurationOutput) SetSlateAdUrl 

func (s *PutPlaybackConfigurationOutput) SetSlateAdUrl(v string) *PutPlaybackConfigurationOutput

SetSlateAdUrl sets the SlateAdUrl field's value.

func (*PutPlaybackConfigurationOutput) SetTranscodeProfileName 

func (s *PutPlaybackConfigurationOutput) SetTranscodeProfileName(v string) *PutPlaybackConfigurationOutput

SetTranscodeProfileName sets the TranscodeProfileName field's value.

func (*PutPlaybackConfigurationOutput) SetVideoContentSourceUrl 

func (s *PutPlaybackConfigurationOutput) SetVideoContentSourceUrl(v string) *PutPlaybackConfigurationOutput

SetVideoContentSourceUrl sets the VideoContentSourceUrl field's value.

func (PutPlaybackConfigurationOutput) String 

func (s PutPlaybackConfigurationOutput) String() string

String returns the string representation

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.