/
api_op_GetPlaybackConfiguration.go
239 lines (205 loc) · 8.86 KB
/
api_op_GetPlaybackConfiguration.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
// Code generated by smithy-go-codegen DO NOT EDIT.
package mediatailor
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/mediatailor/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Retrieves a playback configuration. For information about MediaTailor
// configurations, see [Working with configurations in AWS Elemental MediaTailor].
//
// [Working with configurations in AWS Elemental MediaTailor]: https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html
func (c *Client) GetPlaybackConfiguration(ctx context.Context, params *GetPlaybackConfigurationInput, optFns ...func(*Options)) (*GetPlaybackConfigurationOutput, error) {
if params == nil {
params = &GetPlaybackConfigurationInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetPlaybackConfiguration", params, optFns, c.addOperationGetPlaybackConfigurationMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetPlaybackConfigurationOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetPlaybackConfigurationInput struct {
// The identifier for the playback configuration.
//
// This member is required.
Name *string
noSmithyDocumentSerde
}
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
// The configuration for avail suppression, also known as ad suppression. For more
// information about ad suppression, see [Ad Suppression].
//
// [Ad Suppression]: https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html
AvailSuppression *types.AvailSuppression
// The configuration for bumpers. Bumpers are short audio or video clips that play
// at the start or before the end of an ad break. To learn more about bumpers, see [Bumpers]
// .
//
// [Bumpers]: https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html
Bumper *types.Bumper
// The configuration for using a content delivery network (CDN), like Amazon
// CloudFront, for content and ad segment management.
CdnConfiguration *types.CdnConfiguration
// The player parameters and aliases used as dynamic variables during session
// initialization. For more information, see [Domain Variables].
//
// [Domain Variables]: https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html
ConfigurationAliases map[string]map[string]string
// The configuration for DASH content.
DashConfiguration *types.DashConfiguration
// The configuration for HLS content.
HlsConfiguration *types.HlsConfiguration
// The setting that controls whether players can use stitched or guided ad
// insertion. The default, STITCHED_ONLY , forces all player sessions to use
// stitched (server-side) ad insertion. Choosing PLAYER_SELECT allows players to
// select either stitched or guided ad insertion at session-initialization time.
// The default for players that do not specify an insertion mode is stitched.
InsertionMode types.InsertionMode
// The configuration for pre-roll ad insertion.
LivePreRollConfiguration *types.LivePreRollConfiguration
// The Amazon CloudWatch log settings for a playback configuration.
LogConfiguration *types.LogConfiguration
// The configuration for manifest processing rules. Manifest processing rules
// enable customization of the personalized manifests created by MediaTailor.
ManifestProcessingRules *types.ManifestProcessingRules
// The identifier for the playback configuration.
Name *string
// Defines the maximum duration of underfilled ad time (in seconds) allowed in an
// ad break. If the duration of underfilled ad time exceeds the personalization
// threshold, then the personalization of the ad break is abandoned and the
// underlying content is shown. This feature applies to ad replacement in live and
// VOD streams, rather than ad insertion, because it relies on an underlying
// content stream. For more information about ad break behavior, including ad
// replacement and insertion, see [Ad Behavior in AWS Elemental MediaTailor].
//
// [Ad Behavior in AWS Elemental MediaTailor]: https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html
PersonalizationThresholdSeconds *int32
// The Amazon Resource Name (ARN) for the playback configuration.
PlaybackConfigurationArn *string
// The URL that the player accesses to get a manifest from AWS Elemental
// MediaTailor. This session will use server-side reporting.
PlaybackEndpointPrefix *string
// The URL that the player uses to initialize a session that uses client-side
// reporting.
SessionInitializationEndpointPrefix *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
// The tags assigned to the playback configuration. Tags are key-value pairs that
// you can associate with Amazon resources to help with organization, access
// control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources].
//
// [Tagging AWS Elemental MediaTailor Resources]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
Tags map[string]string
// 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
// The URL prefix for the parent manifest for the stream, minus the asset ID. The
// maximum length is 512 characters.
VideoContentSourceUrl *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetPlaybackConfigurationMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpGetPlaybackConfiguration{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetPlaybackConfiguration{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "GetPlaybackConfiguration"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpGetPlaybackConfigurationValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetPlaybackConfiguration(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opGetPlaybackConfiguration(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "GetPlaybackConfiguration",
}
}