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
|
// 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/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/mediatailor/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates a prefetch schedule for a playback configuration. A prefetch schedule
// allows you to tell MediaTailor to fetch and prepare certain ads before an ad
// break happens. For more information about ad prefetching, see Using ad
// prefetching (https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html)
// in the MediaTailor User Guide.
func (c *Client) CreatePrefetchSchedule(ctx context.Context, params *CreatePrefetchScheduleInput, optFns ...func(*Options)) (*CreatePrefetchScheduleOutput, error) {
if params == nil {
params = &CreatePrefetchScheduleInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreatePrefetchSchedule", params, optFns, c.addOperationCreatePrefetchScheduleMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreatePrefetchScheduleOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreatePrefetchScheduleInput struct {
// The configuration settings for MediaTailor's consumption of the prefetched ads
// from the ad decision server. Each consumption configuration contains an end time
// and an optional start time that define the consumption window. Prefetch
// schedules automatically expire no earlier than seven days after the end time.
//
// This member is required.
Consumption *types.PrefetchConsumption
// The name to assign to the schedule request.
//
// This member is required.
Name *string
// The name to assign to the playback configuration.
//
// This member is required.
PlaybackConfigurationName *string
// The configuration settings for retrieval of prefetched ads from the ad decision
// server. Only one set of prefetched ads will be retrieved and subsequently
// consumed for each ad break.
//
// This member is required.
Retrieval *types.PrefetchRetrieval
// An optional stream identifier that MediaTailor uses to prefetch ads for
// multiple streams that use the same playback configuration. If StreamId is
// specified, MediaTailor returns all of the prefetch schedules with an exact match
// on StreamId . If not specified, MediaTailor returns all of the prefetch
// schedules for the playback configuration, regardless of StreamId .
StreamId *string
noSmithyDocumentSerde
}
type CreatePrefetchScheduleOutput struct {
// The ARN to assign to the prefetch schedule.
Arn *string
// The configuration settings for MediaTailor's consumption of the prefetched ads
// from the ad decision server. Each consumption configuration contains an end time
// and an optional start time that define the consumption window. Prefetch
// schedules automatically expire no earlier than seven days after the end time.
Consumption *types.PrefetchConsumption
// The name to assign to the prefetch schedule.
Name *string
// The name to assign to the playback configuration.
PlaybackConfigurationName *string
// The configuration settings for retrieval of prefetched ads from the ad decision
// server. Only one set of prefetched ads will be retrieved and subsequently
// consumed for each ad break.
Retrieval *types.PrefetchRetrieval
// An optional stream identifier that MediaTailor uses to prefetch ads for
// multiple streams that use the same playback configuration. If StreamId is
// specified, MediaTailor returns all of the prefetch schedules with an exact match
// on StreamId . If not specified, MediaTailor returns all of the prefetch
// schedules for the playback configuration, regardless of StreamId .
StreamId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreatePrefetchScheduleMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpCreatePrefetchSchedule{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpCreatePrefetchSchedule{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreatePrefetchSchedule"); 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 = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.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 = addOpCreatePrefetchScheduleValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreatePrefetchSchedule(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.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_opCreatePrefetchSchedule(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreatePrefetchSchedule",
}
}
|