package mediatailor

import "github.com/aws/aws-sdk-go-v2/service/mediatailor"

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

const (
	ServiceName = "api.mediatailor" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName       // Service ID for Regions and Endpoints metadata.
)

Service information constants

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CdnConfiguration

func (CdnConfiguration) GoString 

func (s CdnConfiguration) GoString() string

GoString returns the string representation

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 DeletePlaybackConfigurationInput 

type DeletePlaybackConfigurationInput struct {

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

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

func (DeletePlaybackConfigurationInput) GoString 

func (s DeletePlaybackConfigurationInput) GoString() string

GoString returns the string representation

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
}

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

func (DeletePlaybackConfigurationOutput) GoString 

func (s DeletePlaybackConfigurationOutput) GoString() string

GoString returns the string representation

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

func (s DeletePlaybackConfigurationOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

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 a API request type for the DeletePlaybackConfiguration API operation.

func (DeletePlaybackConfigurationRequest) Send 

func (r DeletePlaybackConfigurationRequest) Send() (*DeletePlaybackConfigurationOutput, error)

Send marshals and sends the DeletePlaybackConfiguration API 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
}

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

func (GetPlaybackConfigurationInput) GoString 

func (s GetPlaybackConfigurationInput) GoString() string

GoString returns the string representation

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

	// 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
}

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

func (GetPlaybackConfigurationOutput) GoString 

func (s GetPlaybackConfigurationOutput) GoString() string

GoString returns the string representation

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

func (s GetPlaybackConfigurationOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

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 a API request type for the GetPlaybackConfiguration API operation.

func (GetPlaybackConfigurationRequest) Send 

func (r GetPlaybackConfigurationRequest) Send() (*GetPlaybackConfigurationOutput, error)

Send marshals and sends the GetPlaybackConfiguration API 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/HlsConfiguration

func (HlsConfiguration) GoString 

func (s HlsConfiguration) GoString() string

GoString returns the string representation

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
}

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

func (ListPlaybackConfigurationsInput) GoString 

func (s ListPlaybackConfigurationsInput) GoString() string

GoString returns the string representation

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 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
}

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

func (ListPlaybackConfigurationsOutput) GoString 

func (s ListPlaybackConfigurationsOutput) GoString() string

GoString returns the string representation

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

func (s ListPlaybackConfigurationsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

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 a API request type for the ListPlaybackConfigurations API operation.

func (ListPlaybackConfigurationsRequest) Send 

func (r ListPlaybackConfigurationsRequest) Send() (*ListPlaybackConfigurationsOutput, error)

Send marshals and sends the ListPlaybackConfigurations API request.

type MediaTailor 

type MediaTailor struct {
	*aws.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(config aws.Config) *MediaTailor

New creates a new instance of the MediaTailor client with a config.

Example: 

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

func (*MediaTailor) DeletePlaybackConfigurationRequest 

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

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

Deletes the configuration for the specified name. 

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

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

func (*MediaTailor) GetPlaybackConfigurationRequest 

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

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

Returns the configuration for the specified name. 

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

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

func (*MediaTailor) ListPlaybackConfigurationsRequest 

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

ListPlaybackConfigurationsRequest returns a request value for making 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. 

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

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

func (*MediaTailor) PutPlaybackConfigurationRequest 

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

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

Adds a new configuration to AWS Elemental MediaTailor. 

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

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

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
}

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

func (PlaybackConfiguration) GoString 

func (s PlaybackConfiguration) GoString() string

GoString returns the string representation

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

	// 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
}

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

func (PutPlaybackConfigurationInput) GoString 

func (s PutPlaybackConfigurationInput) GoString() string

GoString returns the string representation

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

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 for HLS content.
	HlsConfiguration *HlsConfiguration `type:"structure"`

	Name *string `type:"string"`

	PlaybackEndpointPrefix *string `type:"string"`

	SessionInitializationEndpointPrefix *string `type:"string"`

	SlateAdUrl *string `type:"string"`

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

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

func (PutPlaybackConfigurationOutput) GoString 

func (s PutPlaybackConfigurationOutput) GoString() string

GoString returns the string representation

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

func (s PutPlaybackConfigurationOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

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 a API request type for the PutPlaybackConfiguration API operation.

func (PutPlaybackConfigurationRequest) Send 

func (r PutPlaybackConfigurationRequest) Send() (*PutPlaybackConfigurationOutput, error)

Send marshals and sends the PutPlaybackConfiguration API request.

Source Files

api.go doc.go errors.go service.go

Directories

PathSynopsis
service/mediatailor/mediatailorifacePackage mediatailoriface provides an interface to enable mocking the AWS MediaTailor service client for testing your code.
Version
v0.5.0
Published
Sep 27, 2018
Platform
windows/amd64
Imports
5 packages
Last checked
10 minutes ago –

Tools for package owners.