elastictranscoder

package module
v0.26.0 Latest Latest
Warning

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

Go to latest
Published: Sep 30, 2020 License: Apache-2.0 Imports: 25 Imported by: 0

Documentation

Index

Constants

View Source
const ServiceAPIVersion = "2012-09-25"
View Source
const ServiceID = "Elastic Transcoder"

Variables

This section is empty.

Functions

func AddResolveEndpointMiddleware

func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func RemoveResolveEndpointMiddleware

func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error

Types

type CancelJobInput

type CancelJobInput struct {
	// The identifier of the job that you want to cancel. To get a list of the jobs
	// (including their jobId) that have a status of Submitted, use the
	// ListJobsByStatus () API action.
	Id *string
}

The CancelJobRequest structure.

type CancelJobOutput

type CancelJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response body contains a JSON object. If the job is successfully canceled, the value of Success is true.

type Client

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

AWS Elastic Transcoder Service The AWS Elastic Transcoder Service.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CancelJob

func (c *Client) CancelJob(ctx context.Context, params *CancelJobInput, optFns ...func(*Options)) (*CancelJobOutput, error)

The CancelJob operation cancels an unfinished job. You can only cancel a job that has a status of Submitted. To prevent a pipeline from starting to process a job while you're getting the job identifier, use UpdatePipelineStatus () to temporarily pause the pipeline.

func (*Client) CreateJob

func (c *Client) CreateJob(ctx context.Context, params *CreateJobInput, optFns ...func(*Options)) (*CreateJobOutput, error)

When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is created. If you have specified more than one output for your jobs (for example, one output for the Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list the jobs (as opposed to the AWS Console).

func (*Client) CreatePipeline

func (c *Client) CreatePipeline(ctx context.Context, params *CreatePipelineInput, optFns ...func(*Options)) (*CreatePipelineOutput, error)

The CreatePipeline operation creates a pipeline with settings that you specify.

func (*Client) CreatePreset

func (c *Client) CreatePreset(ctx context.Context, params *CreatePresetInput, optFns ...func(*Options)) (*CreatePresetOutput, error)

The CreatePreset operation creates a preset with settings that you specify. Elastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements and to determine whether they comply with H.264 standards. If your settings are not valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response (ValidationException) and does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message in the response. This helps you determine whether your settings comply with the H.264 standard while giving you greater flexibility with respect to the video that Elastic Transcoder produces. Elastic Transcoder uses the H.264 video-compression format. For more information, see the International Telecommunication Union publication Recommendation ITU-T H.264: Advanced video coding for generic audiovisual services.

func (*Client) DeletePipeline

func (c *Client) DeletePipeline(ctx context.Context, params *DeletePipelineInput, optFns ...func(*Options)) (*DeletePipelineOutput, error)

The DeletePipeline operation removes a pipeline. You can only delete a pipeline that has never been used or that is not currently in use (doesn't contain any active jobs). If the pipeline is currently in use, DeletePipeline returns an error.

func (*Client) DeletePreset

func (c *Client) DeletePreset(ctx context.Context, params *DeletePresetInput, optFns ...func(*Options)) (*DeletePresetOutput, error)

The DeletePreset operation removes a preset that you've added in an AWS region. You can't delete the default presets that are included with Elastic Transcoder.

func (*Client) ListJobsByPipeline

func (c *Client) ListJobsByPipeline(ctx context.Context, params *ListJobsByPipelineInput, optFns ...func(*Options)) (*ListJobsByPipelineOutput, error)

The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline. Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains one element for each job that satisfies the search criteria.

func (*Client) ListJobsByStatus

func (c *Client) ListJobsByStatus(ctx context.Context, params *ListJobsByStatusInput, optFns ...func(*Options)) (*ListJobsByStatusOutput, error)

The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria.

func (*Client) ListPipelines

func (c *Client) ListPipelines(ctx context.Context, params *ListPipelinesInput, optFns ...func(*Options)) (*ListPipelinesOutput, error)

The ListPipelines operation gets a list of the pipelines associated with the current AWS account.

func (*Client) ListPresets

func (c *Client) ListPresets(ctx context.Context, params *ListPresetsInput, optFns ...func(*Options)) (*ListPresetsOutput, error)

The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that you've added in an AWS region.

func (*Client) ReadJob

func (c *Client) ReadJob(ctx context.Context, params *ReadJobInput, optFns ...func(*Options)) (*ReadJobOutput, error)

The ReadJob operation returns detailed information about a job.

func (*Client) ReadPipeline

func (c *Client) ReadPipeline(ctx context.Context, params *ReadPipelineInput, optFns ...func(*Options)) (*ReadPipelineOutput, error)

The ReadPipeline operation gets detailed information about a pipeline.

func (*Client) ReadPreset

func (c *Client) ReadPreset(ctx context.Context, params *ReadPresetInput, optFns ...func(*Options)) (*ReadPresetOutput, error)

The ReadPreset operation gets detailed information about a preset.

func (*Client) TestRole

func (c *Client) TestRole(ctx context.Context, params *TestRoleInput, optFns ...func(*Options)) (*TestRoleOutput, error)

The TestRole operation tests the IAM role used to create the pipeline. The TestRole action lets you determine whether the IAM role you are using has sufficient permissions to let Elastic Transcoder perform tasks associated with the transcoding process. The action attempts to assume the specified IAM role, checks read access to the input and output buckets, and tries to send a test notification to Amazon SNS topics that you specify.

func (*Client) UpdatePipeline

func (c *Client) UpdatePipeline(ctx context.Context, params *UpdatePipelineInput, optFns ...func(*Options)) (*UpdatePipelineOutput, error)

Use the UpdatePipeline operation to update settings for a pipeline. When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings.

func (*Client) UpdatePipelineNotifications

func (c *Client) UpdatePipelineNotifications(ctx context.Context, params *UpdatePipelineNotificationsInput, optFns ...func(*Options)) (*UpdatePipelineNotificationsOutput, error)

With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline. When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request.

func (*Client) UpdatePipelineStatus

func (c *Client) UpdatePipelineStatus(ctx context.Context, params *UpdatePipelineStatusInput, optFns ...func(*Options)) (*UpdatePipelineStatusOutput, error)

The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs. Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a CancelJob () request.

type CreateJobInput

type CreateJobInput struct {
	// If you specify a preset in PresetId for which the value of Container is fmp4
	// (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the
	// master playlists that you want Elastic Transcoder to create. The maximum number
	// of master playlists in a job is 30.
	Playlists []*types.CreateJobPlaylist
	// The Id of the pipeline that you want Elastic Transcoder to use for transcoding.
	// The pipeline determines several settings, including the Amazon S3 bucket from
	// which Elastic Transcoder gets the files to transcode and the bucket into which
	// Elastic Transcoder puts the transcoded files.
	PipelineId *string
	// The value, if any, that you want Elastic Transcoder to prepend to the names of
	// all files that this job creates, including output files, thumbnails, and
	// playlists.
	OutputKeyPrefix *string
	// A section of the request body that provides information about the file that is
	// being transcoded.
	Input *types.JobInput
	// A section of the request body that provides information about the transcoded
	// (target) file. We strongly recommend that you use the Outputs syntax instead of
	// the Output syntax.
	Output *types.CreateJobOutput
	// A section of the request body that provides information about the transcoded
	// (target) files. We recommend that you use the Outputs syntax instead of the
	// Output syntax.
	Outputs []*types.CreateJobOutput
	// User-defined metadata that you want to associate with an Elastic Transcoder job.
	// You specify metadata in key/value pairs, and you can add up to 10 key/value
	// pairs per job. Elastic Transcoder does not guarantee that key/value pairs are
	// returned in the same order in which you specify them.
	UserMetadata map[string]*string
	// A section of the request body that provides information about the files that are
	// being transcoded.
	Inputs []*types.JobInput
}

The CreateJobRequest structure.

type CreateJobOutput

type CreateJobOutput struct {
	// A section of the response body that provides information about the job that is
	// created.
	Job *types.Job

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The CreateJobResponse structure.

type CreatePipelineInput

type CreatePipelineInput struct {
	// The name of the pipeline. We recommend that the name be unique within the AWS
	// account, but uniqueness is not enforced. Constraints: Maximum 40 characters.
	Name *string
	// The optional ContentConfig object specifies information about the Amazon S3
	// bucket in which you want Elastic Transcoder to save transcoded files and
	// playlists: which bucket to use, which users you want to have access to the
	// files, the type of access you want users to have, and the storage class that you
	// want to assign to the files. If you specify values for ContentConfig, you must
	// also specify values for ThumbnailConfig. If you specify values for ContentConfig
	// and ThumbnailConfig, omit the OutputBucket object.
	//
	//     * Bucket: The Amazon S3
	// bucket in which you want Elastic Transcoder to save transcoded files and
	// playlists.
	//
	//     * Permissions (Optional): The Permissions object specifies which
	// users you want to have access to transcoded files and the type of access you
	// want them to have. You can grant permissions to a maximum of 30 users and/or
	// predefined Amazon S3 groups.
	//
	//     * Grantee Type: Specify the type of value that
	// appears in the Grantee object:
	//
	//         * Canonical: The value in the Grantee
	// object is either the canonical user ID for an AWS account or an origin access
	// identity for an Amazon CloudFront distribution. For more information about
	// canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple
	// Storage Service Developer Guide. For more information about using CloudFront
	// origin access identities to require that users use CloudFront URLs instead of
	// Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your
	// Amazon S3 Content. A canonical user ID is not the same as an AWS account
	// number.
	//
	//         * Email: The value in the Grantee object is the registered
	// email address of an AWS account.
	//
	//         * Group: The value in the Grantee
	// object is one of the following predefined Amazon S3 groups: AllUsers,
	// AuthenticatedUsers, or LogDelivery.
	//
	//     * Grantee: The AWS user or group that
	// you want to have access to transcoded files and playlists. To identify the user
	// or group, you can specify the canonical user ID for an AWS account, an origin
	// access identity for a CloudFront distribution, the registered email address of
	// an AWS account, or a predefined Amazon S3 group
	//
	//     * Access: The permission
	// that you want to give to the AWS user that you specified in Grantee. Permissions
	// are granted on the files that Elastic Transcoder adds to the bucket, including
	// playlists and video files. Valid values include:
	//
	//         * READ: The grantee
	// can read the objects and metadata for objects that Elastic Transcoder adds to
	// the Amazon S3 bucket.
	//
	//         * READ_ACP: The grantee can read the object ACL
	// for objects that Elastic Transcoder adds to the Amazon S3 bucket.
	//
	//         *
	// WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder
	// adds to the Amazon S3 bucket.
	//
	//         * FULL_CONTROL: The grantee has READ,
	// READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds
	// to the Amazon S3 bucket.
	//
	//     * StorageClass: The Amazon S3 storage class,
	// Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the
	// video files and playlists that it stores in your Amazon S3 bucket.
	ContentConfig *types.PipelineOutputConfig
	// The Amazon Simple Notification Service (Amazon SNS) topic that you want to
	// notify to report job status. To receive notifications, you must also subscribe
	// to the new topic in the Amazon SNS console.
	//
	//     * Progressing: The topic ARN
	// for the Amazon Simple Notification Service (Amazon SNS) topic that you want to
	// notify when Elastic Transcoder has started to process a job in this pipeline.
	// This is the ARN that Amazon SNS returned when you created the topic. For more
	// information, see Create a Topic in the Amazon Simple Notification Service
	// Developer Guide.
	//
	//     * Complete: The topic ARN for the Amazon SNS topic that
	// you want to notify when Elastic Transcoder has finished processing a job in this
	// pipeline. This is the ARN that Amazon SNS returned when you created the topic.
	//
	//
	// * Warning: The topic ARN for the Amazon SNS topic that you want to notify when
	// Elastic Transcoder encounters a warning condition while processing a job in this
	// pipeline. This is the ARN that Amazon SNS returned when you created the topic.
	//
	//
	// * Error: The topic ARN for the Amazon SNS topic that you want to notify when
	// Elastic Transcoder encounters an error condition while processing a job in this
	// pipeline. This is the ARN that Amazon SNS returned when you created the topic.
	Notifications *types.Notifications
	// The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder
	// to use to create the pipeline.
	Role *string
	// The ThumbnailConfig object specifies several values, including the Amazon S3
	// bucket in which you want Elastic Transcoder to save thumbnail files, which users
	// you want to have access to the files, the type of access you want users to have,
	// and the storage class that you want to assign to the files. If you specify
	// values for ContentConfig, you must also specify values for ThumbnailConfig even
	// if you don't want to create thumbnails. If you specify values for ContentConfig
	// and ThumbnailConfig, omit the OutputBucket object.
	//
	//     * Bucket: The Amazon S3
	// bucket in which you want Elastic Transcoder to save thumbnail files.
	//
	//     *
	// Permissions (Optional): The Permissions object specifies which users and/or
	// predefined Amazon S3 groups you want to have access to thumbnail files, and the
	// type of access you want them to have. You can grant permissions to a maximum of
	// 30 users and/or predefined Amazon S3 groups.
	//
	//     * GranteeType: Specify the
	// type of value that appears in the Grantee object:
	//
	//         * Canonical: The
	// value in the Grantee object is either the canonical user ID for an AWS account
	// or an origin access identity for an Amazon CloudFront distribution. A canonical
	// user ID is not the same as an AWS account number.
	//
	//         * Email: The value in
	// the Grantee object is the registered email address of an AWS account.
	//
	//         *
	// Group: The value in the Grantee object is one of the following predefined Amazon
	// S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.
	//
	//     * Grantee: The AWS
	// user or group that you want to have access to thumbnail files. To identify the
	// user or group, you can specify the canonical user ID for an AWS account, an
	// origin access identity for a CloudFront distribution, the registered email
	// address of an AWS account, or a predefined Amazon S3 group.
	//
	//     * Access: The
	// permission that you want to give to the AWS user that you specified in Grantee.
	// Permissions are granted on the thumbnail files that Elastic Transcoder adds to
	// the bucket. Valid values include:
	//
	//         * READ: The grantee can read the
	// thumbnails and metadata for objects that Elastic Transcoder adds to the Amazon
	// S3 bucket.
	//
	//         * READ_ACP: The grantee can read the object ACL for
	// thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
	//
	//         *
	// WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic
	// Transcoder adds to the Amazon S3 bucket.
	//
	//         * FULL_CONTROL: The grantee
	// has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic
	// Transcoder adds to the Amazon S3 bucket.
	//
	//     * StorageClass: The Amazon S3
	// storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder
	// to assign to the thumbnails that it stores in your Amazon S3 bucket.
	ThumbnailConfig *types.PipelineOutputConfig
	// The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded
	// files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.)
	// Specify this value when all of the following are true:
	//
	//     * You want to save
	// transcoded files, thumbnails (if any), and playlists (if any) together in one
	// bucket.
	//
	//     * You do not want to specify the users or groups who have access to
	// the transcoded files, thumbnails, and playlists.
	//
	//     * You do not want to
	// specify the permissions that Elastic Transcoder grants to the  files. </p>
	// <important> <p>When Elastic Transcoder saves files in <code>OutputBucket</code>,
	// it grants full control over the files only to the AWS account that owns the role
	// that is specified by <code>Role</code>.</p> </important> </li> <li> <p>You want
	// to associate the transcoded files and thumbnails with the Amazon S3 Standard
	// storage class.</p> </li> </ul> <p>If you want to save transcoded files and
	// playlists in one bucket and thumbnails in another bucket, specify which users
	// can access the transcoded files or the permissions the users have, or change the
	// Amazon S3 storage class, omit <code>OutputBucket</code> and specify values for
	// <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead.</p>
	OutputBucket *string
	// The Amazon S3 bucket in which you saved the media files that you want to
	// transcode.
	InputBucket *string
	// The AWS Key Management Service (AWS KMS) key that you want to use with this
	// pipeline. If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't
	// need to provide a key with your job because a default key, known as an AWS-KMS
	// key, is created for you automatically. You need to provide an AWS-KMS key only
	// if you want to use a non-default AWS-KMS key, or if you are using an
	// Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.
	AwsKmsKeyArn *string
}

The CreatePipelineRequest structure.

type CreatePipelineOutput

type CreatePipelineOutput struct {
	// A section of the response body that provides information about the pipeline that
	// is created.
	Pipeline *types.Pipeline
	// Elastic Transcoder returns a warning if the resources used by your pipeline are
	// not in the same region as the pipeline. Using resources in the same region, such
	// as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key,
	// reduces processing time and prevents cross-regional charges.
	Warnings []*types.Warning

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

When you create a pipeline, Elastic Transcoder returns the values that you specified in the request.

type CreatePresetInput

type CreatePresetInput struct {
	// The name of the preset. We recommend that the name be unique within the AWS
	// account, but uniqueness is not enforced.
	Name *string
	// A description of the preset.
	Description *string
	// The container type for the output file. Valid values include flac, flv, fmp4,
	// gif, mp3, mp4, mpg, mxf, oga, ogg, ts, and webm.
	Container *string
	// A section of the request body that specifies the video parameters.
	Video *types.VideoParameters
	// A section of the request body that specifies the thumbnail parameters, if any.
	Thumbnails *types.Thumbnails
	// A section of the request body that specifies the audio parameters.
	Audio *types.AudioParameters
}

The CreatePresetRequest structure.

type CreatePresetOutput

type CreatePresetOutput struct {
	// A section of the response body that provides information about the preset that
	// is created.
	Preset *types.Preset
	// If the preset settings don't comply with the standards for the video codec but
	// Elastic Transcoder created the preset, this message explains the reason the
	// preset settings don't meet the standard. Elastic Transcoder created the preset
	// because the settings might produce acceptable output.
	Warning *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The CreatePresetResponse structure.

type DeletePipelineInput

type DeletePipelineInput struct {
	// The identifier of the pipeline that you want to delete.
	Id *string
}

The DeletePipelineRequest structure.

type DeletePipelineOutput

type DeletePipelineOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The DeletePipelineResponse structure.

type DeletePresetInput

type DeletePresetInput struct {
	// The identifier of the preset for which you want to get detailed information.
	Id *string
}

The DeletePresetRequest structure.

type DeletePresetOutput

type DeletePresetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The DeletePresetResponse structure.

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error
}

type ListJobsByPipelineInput

type ListJobsByPipelineInput struct {
	// To list jobs in chronological order by the date and time that they were
	// submitted, enter true. To list jobs in reverse chronological order, enter false.
	Ascending *string
	// The ID of the pipeline for which you want to get job information.
	PipelineId *string
	// When Elastic Transcoder returns more than one page of results, use pageToken in
	// subsequent GET requests to get each successive page of results.
	PageToken *string
}

The ListJobsByPipelineRequest structure.

type ListJobsByPipelineOutput

type ListJobsByPipelineOutput struct {
	// A value that you use to access the second and subsequent pages of results, if
	// any. When the jobs in the specified pipeline fit on one page or when you've
	// reached the last page of results, the value of NextPageToken is null.
	NextPageToken *string
	// An array of Job objects that are in the specified pipeline.
	Jobs []*types.Job

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The ListJobsByPipelineResponse structure.

type ListJobsByStatusInput

type ListJobsByStatusInput struct {
	// To list jobs in chronological order by the date and time that they were
	// submitted, enter true. To list jobs in reverse chronological order, enter false.
	Ascending *string
	// To get information about all of the jobs associated with the current AWS account
	// that have a given status, specify the following status: Submitted, Progressing,
	// Complete, Canceled, or Error.
	Status *string
	// When Elastic Transcoder returns more than one page of results, use pageToken in
	// subsequent GET requests to get each successive page of results.
	PageToken *string
}

The ListJobsByStatusRequest structure.

type ListJobsByStatusOutput

type ListJobsByStatusOutput struct {
	// An array of Job objects that have the specified status.
	Jobs []*types.Job
	// A value that you use to access the second and subsequent pages of results, if
	// any. When the jobs in the specified pipeline fit on one page or when you've
	// reached the last page of results, the value of NextPageToken is null.
	NextPageToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The ListJobsByStatusResponse structure.

type ListPipelinesInput

type ListPipelinesInput struct {
	// To list pipelines in chronological order by the date and time that they were
	// created, enter true. To list pipelines in reverse chronological order, enter
	// false.
	Ascending *string
	// When Elastic Transcoder returns more than one page of results, use pageToken in
	// subsequent GET requests to get each successive page of results.
	PageToken *string
}

The ListPipelineRequest structure.

type ListPipelinesOutput

type ListPipelinesOutput struct {
	// An array of Pipeline objects.
	Pipelines []*types.Pipeline
	// A value that you use to access the second and subsequent pages of results, if
	// any. When the pipelines fit on one page or when you've reached the last page of
	// results, the value of NextPageToken is null.
	NextPageToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

A list of the pipelines associated with the current AWS account.

type ListPresetsInput

type ListPresetsInput struct {
	// When Elastic Transcoder returns more than one page of results, use pageToken in
	// subsequent GET requests to get each successive page of results.
	PageToken *string
	// To list presets in chronological order by the date and time that they were
	// created, enter true. To list presets in reverse chronological order, enter
	// false.
	Ascending *string
}

The ListPresetsRequest structure.

type ListPresetsOutput

type ListPresetsOutput struct {
	// An array of Preset objects.
	Presets []*types.Preset
	// A value that you use to access the second and subsequent pages of results, if
	// any. When the presets fit on one page or when you've reached the last page of
	// results, the value of NextPageToken is null.
	NextPageToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The ListPresetsResponse structure.

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions ResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetCredentials

func (o Options) GetCredentials() aws.CredentialsProvider

func (Options) GetEndpointOptions

func (o Options) GetEndpointOptions() ResolverOptions

func (Options) GetEndpointResolver

func (o Options) GetEndpointResolver() EndpointResolver

func (Options) GetHTTPSignerV4

func (o Options) GetHTTPSignerV4() HTTPSignerV4

func (Options) GetRegion

func (o Options) GetRegion() string

func (Options) GetRetryer

func (o Options) GetRetryer() retry.Retryer

type ReadJobInput

type ReadJobInput struct {
	// The identifier of the job for which you want to get detailed information.
	Id *string
}

The ReadJobRequest structure.

type ReadJobOutput

type ReadJobOutput struct {
	// A section of the response body that provides information about the job.
	Job *types.Job

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The ReadJobResponse structure.

type ReadPipelineInput

type ReadPipelineInput struct {
	// The identifier of the pipeline to read.
	Id *string
}

The ReadPipelineRequest structure.

type ReadPipelineOutput

type ReadPipelineOutput struct {
	// A section of the response body that provides information about the pipeline.
	Pipeline *types.Pipeline
	// Elastic Transcoder returns a warning if the resources used by your pipeline are
	// not in the same region as the pipeline. Using resources in the same region, such
	// as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key,
	// reduces processing time and prevents cross-regional charges.
	Warnings []*types.Warning

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The ReadPipelineResponse structure.

type ReadPresetInput

type ReadPresetInput struct {
	// The identifier of the preset for which you want to get detailed information.
	Id *string
}

The ReadPresetRequest structure.

type ReadPresetOutput

type ReadPresetOutput struct {
	// A section of the response body that provides information about the preset.
	Preset *types.Preset

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The ReadPresetResponse structure.

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type ResolveEndpointMiddlewareOptions

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions

type ResolverOptions = internalendpoints.Options

ResolverOptions is the service endpoint resolver options

type TestRoleInput

type TestRoleInput struct {
	// The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder
	// to test.
	Role *string
	// The Amazon S3 bucket that Elastic Transcoder writes transcoded media files to.
	// The action attempts to read from this bucket.
	OutputBucket *string
	// The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics
	// that you want the action to send a test notification to.
	Topics []*string
	// The Amazon S3 bucket that contains media files to be transcoded. The action
	// attempts to read from this bucket.
	InputBucket *string
}

The TestRoleRequest structure.

type TestRoleOutput

type TestRoleOutput struct {
	// If the operation is successful, this value is true; otherwise, the value is
	// false.
	Success *string
	// If the Success element contains false, this value is an array of one or more
	// error messages that were generated during the test process.
	Messages []*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The TestRoleResponse structure.

type UpdatePipelineInput

type UpdatePipelineInput struct {
	// The ID of the pipeline that you want to update.
	Id *string
	// The AWS Key Management Service (AWS KMS) key that you want to use with this
	// pipeline. If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't
	// need to provide a key with your job because a default key, known as an AWS-KMS
	// key, is created for you automatically. You need to provide an AWS-KMS key only
	// if you want to use a non-default AWS-KMS key, or if you are using an
	// Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.
	AwsKmsKeyArn *string
	// The ThumbnailConfig object specifies several values, including the Amazon S3
	// bucket in which you want Elastic Transcoder to save thumbnail files, which users
	// you want to have access to the files, the type of access you want users to have,
	// and the storage class that you want to assign to the files. If you specify
	// values for ContentConfig, you must also specify values for ThumbnailConfig even
	// if you don't want to create thumbnails. If you specify values for ContentConfig
	// and ThumbnailConfig, omit the OutputBucket object.
	//
	//     * Bucket: The Amazon S3
	// bucket in which you want Elastic Transcoder to save thumbnail files.
	//
	//     *
	// Permissions (Optional): The Permissions object specifies which users and/or
	// predefined Amazon S3 groups you want to have access to thumbnail files, and the
	// type of access you want them to have. You can grant permissions to a maximum of
	// 30 users and/or predefined Amazon S3 groups.
	//
	//     * GranteeType: Specify the
	// type of value that appears in the Grantee object:
	//
	//         * Canonical: The
	// value in the Grantee object is either the canonical user ID for an AWS account
	// or an origin access identity for an Amazon CloudFront distribution. A canonical
	// user ID is not the same as an AWS account number.
	//
	//         * Email: The value in
	// the Grantee object is the registered email address of an AWS account.
	//
	//         *
	// Group: The value in the Grantee object is one of the following predefined Amazon
	// S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.
	//
	//     * Grantee: The AWS
	// user or group that you want to have access to thumbnail files. To identify the
	// user or group, you can specify the canonical user ID for an AWS account, an
	// origin access identity for a CloudFront distribution, the registered email
	// address of an AWS account, or a predefined Amazon S3 group.
	//
	//     * Access: The
	// permission that you want to give to the AWS user that you specified in Grantee.
	// Permissions are granted on the thumbnail files that Elastic Transcoder adds to
	// the bucket. Valid values include:
	//
	//         * READ: The grantee can read the
	// thumbnails and metadata for objects that Elastic Transcoder adds to the Amazon
	// S3 bucket.
	//
	//         * READ_ACP: The grantee can read the object ACL for
	// thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
	//
	//         *
	// WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic
	// Transcoder adds to the Amazon S3 bucket.
	//
	//         * FULL_CONTROL: The grantee
	// has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic
	// Transcoder adds to the Amazon S3 bucket.
	//
	//     * StorageClass: The Amazon S3
	// storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder
	// to assign to the thumbnails that it stores in your Amazon S3 bucket.
	ThumbnailConfig *types.PipelineOutputConfig
	// The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that
	// you want to notify to report job status. To receive notifications, you must also
	// subscribe to the new topic in the Amazon SNS console.
	//
	//     * Progressing: The
	// topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you
	// want to notify when Elastic Transcoder has started to process jobs that are
	// added to this pipeline. This is the ARN that Amazon SNS returned when you
	// created the topic.
	//
	//     * Complete: The topic ARN for the Amazon SNS topic that
	// you want to notify when Elastic Transcoder has finished processing a job. This
	// is the ARN that Amazon SNS returned when you created the topic.
	//
	//     * Warning:
	// The topic ARN for the Amazon SNS topic that you want to notify when Elastic
	// Transcoder encounters a warning condition. This is the ARN that Amazon SNS
	// returned when you created the topic.
	//
	//     * Error: The topic ARN for the Amazon
	// SNS topic that you want to notify when Elastic Transcoder encounters an error
	// condition. This is the ARN that Amazon SNS returned when you created the topic.
	Notifications *types.Notifications
	// The Amazon S3 bucket in which you saved the media files that you want to
	// transcode and the graphics that you want to use as watermarks.
	InputBucket *string
	// The optional ContentConfig object specifies information about the Amazon S3
	// bucket in which you want Elastic Transcoder to save transcoded files and
	// playlists: which bucket to use, which users you want to have access to the
	// files, the type of access you want users to have, and the storage class that you
	// want to assign to the files. If you specify values for ContentConfig, you must
	// also specify values for ThumbnailConfig. If you specify values for ContentConfig
	// and ThumbnailConfig, omit the OutputBucket object.
	//
	//     * Bucket: The Amazon S3
	// bucket in which you want Elastic Transcoder to save transcoded files and
	// playlists.
	//
	//     * Permissions (Optional): The Permissions object specifies which
	// users you want to have access to transcoded files and the type of access you
	// want them to have. You can grant permissions to a maximum of 30 users and/or
	// predefined Amazon S3 groups.
	//
	//     * Grantee Type: Specify the type of value that
	// appears in the Grantee object:
	//
	//         * Canonical: The value in the Grantee
	// object is either the canonical user ID for an AWS account or an origin access
	// identity for an Amazon CloudFront distribution. For more information about
	// canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple
	// Storage Service Developer Guide. For more information about using CloudFront
	// origin access identities to require that users use CloudFront URLs instead of
	// Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your
	// Amazon S3 Content. A canonical user ID is not the same as an AWS account
	// number.
	//
	//         * Email: The value in the Grantee object is the registered
	// email address of an AWS account.
	//
	//         * Group: The value in the Grantee
	// object is one of the following predefined Amazon S3 groups: AllUsers,
	// AuthenticatedUsers, or LogDelivery.
	//
	//     * Grantee: The AWS user or group that
	// you want to have access to transcoded files and playlists. To identify the user
	// or group, you can specify the canonical user ID for an AWS account, an origin
	// access identity for a CloudFront distribution, the registered email address of
	// an AWS account, or a predefined Amazon S3 group
	//
	//     * Access: The permission
	// that you want to give to the AWS user that you specified in Grantee. Permissions
	// are granted on the files that Elastic Transcoder adds to the bucket, including
	// playlists and video files. Valid values include:
	//
	//         * READ: The grantee
	// can read the objects and metadata for objects that Elastic Transcoder adds to
	// the Amazon S3 bucket.
	//
	//         * READ_ACP: The grantee can read the object ACL
	// for objects that Elastic Transcoder adds to the Amazon S3 bucket.
	//
	//         *
	// WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder
	// adds to the Amazon S3 bucket.
	//
	//         * FULL_CONTROL: The grantee has READ,
	// READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds
	// to the Amazon S3 bucket.
	//
	//     * StorageClass: The Amazon S3 storage class,
	// Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the
	// video files and playlists that it stores in your Amazon S3 bucket.
	ContentConfig *types.PipelineOutputConfig
	// The name of the pipeline. We recommend that the name be unique within the AWS
	// account, but uniqueness is not enforced. Constraints: Maximum 40 characters
	Name *string
	// The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder
	// to use to transcode jobs for this pipeline.
	Role *string
}

The UpdatePipelineRequest structure.

type UpdatePipelineNotificationsInput

type UpdatePipelineNotificationsInput struct {
	// The identifier of the pipeline for which you want to change notification
	// settings.
	Id *string
	// The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that
	// you want to notify to report job status. To receive notifications, you must also
	// subscribe to the new topic in the Amazon SNS console.
	//
	//     * Progressing: The
	// topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you
	// want to notify when Elastic Transcoder has started to process jobs that are
	// added to this pipeline. This is the ARN that Amazon SNS returned when you
	// created the topic.
	//
	//     * Complete: The topic ARN for the Amazon SNS topic that
	// you want to notify when Elastic Transcoder has finished processing a job. This
	// is the ARN that Amazon SNS returned when you created the topic.
	//
	//     * Warning:
	// The topic ARN for the Amazon SNS topic that you want to notify when Elastic
	// Transcoder encounters a warning condition. This is the ARN that Amazon SNS
	// returned when you created the topic.
	//
	//     * Error: The topic ARN for the Amazon
	// SNS topic that you want to notify when Elastic Transcoder encounters an error
	// condition. This is the ARN that Amazon SNS returned when you created the topic.
	Notifications *types.Notifications
}

The UpdatePipelineNotificationsRequest structure.

type UpdatePipelineNotificationsOutput

type UpdatePipelineNotificationsOutput struct {
	// A section of the response body that provides information about the pipeline
	// associated with this notification.
	Pipeline *types.Pipeline

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The UpdatePipelineNotificationsResponse structure.

type UpdatePipelineOutput

type UpdatePipelineOutput struct {
	// Elastic Transcoder returns a warning if the resources used by your pipeline are
	// not in the same region as the pipeline. Using resources in the same region, such
	// as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key,
	// reduces processing time and prevents cross-regional charges.
	Warnings []*types.Warning
	// The pipeline updated by this UpdatePipelineResponse call.
	Pipeline *types.Pipeline

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

When you update a pipeline, Elastic Transcoder returns the values that you specified in the request.

type UpdatePipelineStatusInput

type UpdatePipelineStatusInput struct {
	// The identifier of the pipeline to update.
	Id *string
	// The desired status of the pipeline:
	//
	//     * Active: The pipeline is processing
	// jobs.
	//
	//     * Paused: The pipeline is not currently processing jobs.
	Status *string
}

The UpdatePipelineStatusRequest structure.

type UpdatePipelineStatusOutput

type UpdatePipelineStatusOutput struct {
	// A section of the response body that provides information about the pipeline.
	Pipeline *types.Pipeline

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

When you update status for a pipeline, Elastic Transcoder returns the values that you specified in the request.

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL