mediatailor

package
v1.20.14 Latest Latest
Warning

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

Go to latest
Published: Jul 2, 2019 License: Apache-2.0 Imports: 8 Imported by: 43

Documentation

Overview

Package mediatailor provides the client and types for making API requests to AWS 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 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 (
	// OriginManifestTypeSinglePeriod is a OriginManifestType enum value
	OriginManifestTypeSinglePeriod = "SINGLE_PERIOD"

	// OriginManifestTypeMultiPeriod is a OriginManifestType enum value
	OriginManifestTypeMultiPeriod = "MULTI_PERIOD"
)
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

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 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 added in v1.15.76

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 *string `type:"string" enum:"OriginManifestType"`
	// contains filtered or unexported fields
}

The configuration for DASH content.

func (DashConfiguration) GoString added in v1.15.76

func (s DashConfiguration) GoString() string

GoString returns the string representation

func (*DashConfiguration) SetManifestEndpointPrefix added in v1.15.76

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

SetManifestEndpointPrefix sets the ManifestEndpointPrefix field's value.

func (*DashConfiguration) SetMpdLocation added in v1.16.0

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

SetMpdLocation sets the MpdLocation field's value.

func (*DashConfiguration) SetOriginManifestType added in v1.19.16

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

SetOriginManifestType sets the OriginManifestType field's value.

func (DashConfiguration) String added in v1.15.76

func (s DashConfiguration) String() string

String returns the string representation

type DashConfigurationForPut added in v1.16.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 *string `type:"string" enum:"OriginManifestType"`
	// contains filtered or unexported fields
}

The configuration for DASH PUT operations.

func (DashConfigurationForPut) GoString added in v1.16.0

func (s DashConfigurationForPut) GoString() string

GoString returns the string representation

func (*DashConfigurationForPut) SetMpdLocation added in v1.16.0

SetMpdLocation sets the MpdLocation field's value.

func (*DashConfigurationForPut) SetOriginManifestType added in v1.19.16

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

SetOriginManifestType sets the OriginManifestType field's value.

func (DashConfigurationForPut) String added in v1.16.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) GoString

GoString returns the string representation

func (*DeletePlaybackConfigurationInput) SetName

SetName sets the Name field's value.

func (DeletePlaybackConfigurationInput) String

String returns the string representation

func (*DeletePlaybackConfigurationInput) Validate

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

GoString returns the string representation

func (DeletePlaybackConfigurationOutput) 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

GoString returns the string representation

func (*GetPlaybackConfigurationInput) SetName

SetName sets the Name field's value.

func (GetPlaybackConfigurationInput) 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 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 identifier for the playback configuration.
	Name *string `type:"string"`

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

GoString returns the string representation

func (*GetPlaybackConfigurationOutput) SetAdDecisionServerUrl

SetAdDecisionServerUrl sets the AdDecisionServerUrl field's value.

func (*GetPlaybackConfigurationOutput) SetCdnConfiguration

SetCdnConfiguration sets the CdnConfiguration field's value.

func (*GetPlaybackConfigurationOutput) SetDashConfiguration added in v1.15.76

SetDashConfiguration sets the DashConfiguration field's value.

func (*GetPlaybackConfigurationOutput) SetHlsConfiguration

SetHlsConfiguration sets the HlsConfiguration field's value.

func (*GetPlaybackConfigurationOutput) SetName

SetName sets the Name field's value.

func (*GetPlaybackConfigurationOutput) SetPlaybackConfigurationArn added in v1.16.34

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

SetPlaybackConfigurationArn sets the PlaybackConfigurationArn 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

SetSlateAdUrl sets the SlateAdUrl field's value.

func (*GetPlaybackConfigurationOutput) SetTags added in v1.16.34

SetTags sets the Tags field's value.

func (*GetPlaybackConfigurationOutput) SetTranscodeProfileName added in v1.15.76

SetTranscodeProfileName sets the TranscodeProfileName field's value.

func (*GetPlaybackConfigurationOutput) SetVideoContentSourceUrl

SetVideoContentSourceUrl sets the VideoContentSourceUrl field's value.

func (GetPlaybackConfigurationOutput) 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

GoString returns the string representation

func (*ListPlaybackConfigurationsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListPlaybackConfigurationsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListPlaybackConfigurationsInput) 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) GoString

GoString returns the string representation

func (*ListPlaybackConfigurationsOutput) SetItems

SetItems sets the Items field's value.

func (*ListPlaybackConfigurationsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListPlaybackConfigurationsOutput) String

String returns the string representation

type ListTagsForResourceInput added in v1.16.34

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) GoString added in v1.16.34

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetResourceArn added in v1.16.34

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String added in v1.16.34

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v1.16.34

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.16.34

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

func (ListTagsForResourceOutput) GoString added in v1.16.34

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetTags added in v1.16.34

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.16.34

func (s ListTagsForResourceOutput) 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 playback 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 playback 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 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.

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) ListTagsForResource added in v1.16.34

func (c *MediaTailor) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS MediaTailor.

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

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 ListTagsForResource for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" One of the parameters in the request is invalid.

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

func (*MediaTailor) ListTagsForResourceRequest added in v1.16.34

func (c *MediaTailor) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource 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 ListTagsForResource for more information on using the ListTagsForResource 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 ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(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/ListTagsForResource

func (*MediaTailor) ListTagsForResourceWithContext added in v1.16.34

func (c *MediaTailor) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

See ListTagsForResource 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 playback 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.

func (*MediaTailor) TagResource added in v1.16.34

func (c *MediaTailor) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS MediaTailor.

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

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 TagResource for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" One of the parameters in the request is invalid.

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

func (*MediaTailor) TagResourceRequest added in v1.16.34

func (c *MediaTailor) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource 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 TagResource for more information on using the TagResource 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 TagResourceRequest method.
req, resp := client.TagResourceRequest(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/TagResource

func (*MediaTailor) TagResourceWithContext added in v1.16.34

func (c *MediaTailor) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

See TagResource 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) UntagResource added in v1.16.34

func (c *MediaTailor) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS MediaTailor.

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

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 UntagResource for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" One of the parameters in the request is invalid.

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

func (*MediaTailor) UntagResourceRequest added in v1.16.34

func (c *MediaTailor) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource 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 UntagResource for more information on using the UntagResource 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 UntagResourceRequest method.
req, resp := client.UntagResourceRequest(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/UntagResource

func (*MediaTailor) UntagResourceWithContext added in v1.16.34

func (c *MediaTailor) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

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

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

	// The configuration for HLS content.
	HlsConfiguration *HlsConfiguration `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 (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) SetDashConfiguration added in v1.16.34

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

SetDashConfiguration sets the DashConfiguration field's value.

func (*PlaybackConfiguration) SetHlsConfiguration added in v1.16.34

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

SetHlsConfiguration sets the HlsConfiguration field's value.

func (*PlaybackConfiguration) SetName

SetName sets the Name field's value.

func (*PlaybackConfiguration) SetPlaybackConfigurationArn added in v1.16.34

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

SetPlaybackConfigurationArn sets the PlaybackConfigurationArn field's value.

func (*PlaybackConfiguration) SetPlaybackEndpointPrefix added in v1.16.34

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

SetPlaybackEndpointPrefix sets the PlaybackEndpointPrefix field's value.

func (*PlaybackConfiguration) SetSessionInitializationEndpointPrefix added in v1.16.34

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

SetSessionInitializationEndpointPrefix sets the SessionInitializationEndpointPrefix field's value.

func (*PlaybackConfiguration) SetSlateAdUrl

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

SetSlateAdUrl sets the SlateAdUrl field's value.

func (*PlaybackConfiguration) SetTags added in v1.16.34

SetTags sets the Tags field's value.

func (*PlaybackConfiguration) SetTranscodeProfileName added in v1.16.34

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

SetTranscodeProfileName sets the TranscodeProfileName 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 25,000 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 DASH content.
	DashConfiguration *DashConfigurationForPut `type:"structure"`

	// The identifier for the playback 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 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) GoString

GoString returns the string representation

func (*PutPlaybackConfigurationInput) SetAdDecisionServerUrl

SetAdDecisionServerUrl sets the AdDecisionServerUrl field's value.

func (*PutPlaybackConfigurationInput) SetCdnConfiguration

SetCdnConfiguration sets the CdnConfiguration field's value.

func (*PutPlaybackConfigurationInput) SetDashConfiguration added in v1.16.0

SetDashConfiguration sets the DashConfiguration field's value.

func (*PutPlaybackConfigurationInput) SetName

SetName sets the Name field's value.

func (*PutPlaybackConfigurationInput) SetSlateAdUrl

SetSlateAdUrl sets the SlateAdUrl field's value.

func (*PutPlaybackConfigurationInput) SetTags added in v1.16.34

SetTags sets the Tags field's value.

func (*PutPlaybackConfigurationInput) SetTranscodeProfileName added in v1.15.76

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

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 DASH content.
	DashConfiguration *DashConfiguration `type:"structure"`

	// The configuration for HLS content.
	HlsConfiguration *HlsConfiguration `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) GoString

GoString returns the string representation

func (*PutPlaybackConfigurationOutput) SetAdDecisionServerUrl

SetAdDecisionServerUrl sets the AdDecisionServerUrl field's value.

func (*PutPlaybackConfigurationOutput) SetCdnConfiguration

SetCdnConfiguration sets the CdnConfiguration field's value.

func (*PutPlaybackConfigurationOutput) SetDashConfiguration added in v1.15.76

SetDashConfiguration sets the DashConfiguration field's value.

func (*PutPlaybackConfigurationOutput) SetHlsConfiguration

SetHlsConfiguration sets the HlsConfiguration field's value.

func (*PutPlaybackConfigurationOutput) SetName

SetName sets the Name field's value.

func (*PutPlaybackConfigurationOutput) SetPlaybackConfigurationArn added in v1.16.34

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

SetPlaybackConfigurationArn sets the PlaybackConfigurationArn 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

SetSlateAdUrl sets the SlateAdUrl field's value.

func (*PutPlaybackConfigurationOutput) SetTags added in v1.16.34

SetTags sets the Tags field's value.

func (*PutPlaybackConfigurationOutput) SetTranscodeProfileName added in v1.15.76

SetTranscodeProfileName sets the TranscodeProfileName field's value.

func (*PutPlaybackConfigurationOutput) SetVideoContentSourceUrl

SetVideoContentSourceUrl sets the VideoContentSourceUrl field's value.

func (PutPlaybackConfigurationOutput) String

String returns the string representation

type TagResourceInput added in v1.16.34

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) GoString added in v1.16.34

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceArn added in v1.16.34

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags added in v1.16.34

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.16.34

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v1.16.34

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.16.34

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

func (TagResourceOutput) GoString added in v1.16.34

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String added in v1.16.34

func (s TagResourceOutput) String() string

String returns the string representation

type UntagResourceInput added in v1.16.34

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) GoString added in v1.16.34

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceArn added in v1.16.34

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys added in v1.16.34

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.16.34

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v1.16.34

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.16.34

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

func (UntagResourceOutput) GoString added in v1.16.34

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String added in v1.16.34

func (s UntagResourceOutput) String() string

String returns the string representation

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