chimesdkmediapipelines

package module
v1.15.5 Latest Latest
Warning

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

 Go to latest Published: Mar 29, 2024 License: Apache-2.0 Imports: 41 Imported by: 2

Documentation

Overview

Package chimesdkmediapipelines provides the API client, operations, and parameter types for Amazon Chime SDK Media Pipelines.

The Amazon Chime SDK media pipeline APIs in this section allow software developers to create Amazon Chime SDK media pipelines that capture, concatenate, or stream your Amazon Chime SDK meetings. For more information about media pipelines, see Amazon Chime SDK media pipelines (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_Operations_Amazon_Chime_SDK_Media_Pipelines.html) .

Index

Constants

View Source 
const ServiceAPIVersion = "2021-07-15"
View Source 
const ServiceID = "Chime SDK Media Pipelines"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.6.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.12.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.12.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.12.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.12.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client 

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

Client provides the API client to make operations call for Amazon Chime SDK Media Pipelines.

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

func (c *Client) CreateMediaCapturePipeline(ctx context.Context, params *CreateMediaCapturePipelineInput, optFns ...func(*Options)) (*CreateMediaCapturePipelineOutput, error)

Creates a media pipeline.

func (*Client) CreateMediaConcatenationPipeline added in v1.1.0 

func (c *Client) CreateMediaConcatenationPipeline(ctx context.Context, params *CreateMediaConcatenationPipelineInput, optFns ...func(*Options)) (*CreateMediaConcatenationPipelineOutput, error)

Creates a media concatenation pipeline.

func (*Client) CreateMediaInsightsPipeline added in v1.3.0 

func (c *Client) CreateMediaInsightsPipeline(ctx context.Context, params *CreateMediaInsightsPipelineInput, optFns ...func(*Options)) (*CreateMediaInsightsPipelineOutput, error)

Creates a media insights pipeline.

func (*Client) CreateMediaInsightsPipelineConfiguration added in v1.3.0 

func (c *Client) CreateMediaInsightsPipelineConfiguration(ctx context.Context, params *CreateMediaInsightsPipelineConfigurationInput, optFns ...func(*Options)) (*CreateMediaInsightsPipelineConfigurationOutput, error)

A structure that contains the static configurations for a media insights pipeline.

func (*Client) CreateMediaLiveConnectorPipeline added in v1.1.0 

func (c *Client) CreateMediaLiveConnectorPipeline(ctx context.Context, params *CreateMediaLiveConnectorPipelineInput, optFns ...func(*Options)) (*CreateMediaLiveConnectorPipelineOutput, error)

Creates a media live connector pipeline in an Amazon Chime SDK meeting.

func (*Client) CreateMediaPipelineKinesisVideoStreamPool added in v1.9.0 

func (c *Client) CreateMediaPipelineKinesisVideoStreamPool(ctx context.Context, params *CreateMediaPipelineKinesisVideoStreamPoolInput, optFns ...func(*Options)) (*CreateMediaPipelineKinesisVideoStreamPoolOutput, error)

Creates an Kinesis video stream pool for the media pipeline.

func (*Client) CreateMediaStreamPipeline added in v1.9.0 

func (c *Client) CreateMediaStreamPipeline(ctx context.Context, params *CreateMediaStreamPipelineInput, optFns ...func(*Options)) (*CreateMediaStreamPipelineOutput, error)

Creates a streaming media pipeline.

func (*Client) DeleteMediaCapturePipeline 

func (c *Client) DeleteMediaCapturePipeline(ctx context.Context, params *DeleteMediaCapturePipelineInput, optFns ...func(*Options)) (*DeleteMediaCapturePipelineOutput, error)

Deletes the media pipeline.

func (*Client) DeleteMediaInsightsPipelineConfiguration added in v1.3.0 

func (c *Client) DeleteMediaInsightsPipelineConfiguration(ctx context.Context, params *DeleteMediaInsightsPipelineConfigurationInput, optFns ...func(*Options)) (*DeleteMediaInsightsPipelineConfigurationOutput, error)

Deletes the specified configuration settings.

func (*Client) DeleteMediaPipeline added in v1.1.0 

func (c *Client) DeleteMediaPipeline(ctx context.Context, params *DeleteMediaPipelineInput, optFns ...func(*Options)) (*DeleteMediaPipelineOutput, error)

Deletes the media pipeline.

func (*Client) DeleteMediaPipelineKinesisVideoStreamPool added in v1.9.0 

func (c *Client) DeleteMediaPipelineKinesisVideoStreamPool(ctx context.Context, params *DeleteMediaPipelineKinesisVideoStreamPoolInput, optFns ...func(*Options)) (*DeleteMediaPipelineKinesisVideoStreamPoolOutput, error)

Deletes an Kinesis video stream pool.

func (*Client) GetMediaCapturePipeline 

func (c *Client) GetMediaCapturePipeline(ctx context.Context, params *GetMediaCapturePipelineInput, optFns ...func(*Options)) (*GetMediaCapturePipelineOutput, error)

Gets an existing media pipeline.

func (*Client) GetMediaInsightsPipelineConfiguration added in v1.3.0 

func (c *Client) GetMediaInsightsPipelineConfiguration(ctx context.Context, params *GetMediaInsightsPipelineConfigurationInput, optFns ...func(*Options)) (*GetMediaInsightsPipelineConfigurationOutput, error)

Gets the configuration settings for a media insights pipeline.

func (*Client) GetMediaPipeline added in v1.1.0 

func (c *Client) GetMediaPipeline(ctx context.Context, params *GetMediaPipelineInput, optFns ...func(*Options)) (*GetMediaPipelineOutput, error)

Gets an existing media pipeline.

func (*Client) GetMediaPipelineKinesisVideoStreamPool added in v1.9.0 

func (c *Client) GetMediaPipelineKinesisVideoStreamPool(ctx context.Context, params *GetMediaPipelineKinesisVideoStreamPoolInput, optFns ...func(*Options)) (*GetMediaPipelineKinesisVideoStreamPoolOutput, error)

Gets an Kinesis video stream pool.

func (*Client) GetSpeakerSearchTask added in v1.8.0 

func (c *Client) GetSpeakerSearchTask(ctx context.Context, params *GetSpeakerSearchTaskInput, optFns ...func(*Options)) (*GetSpeakerSearchTaskOutput, error)

Retrieves the details of the specified speaker search task.

func (*Client) GetVoiceToneAnalysisTask added in v1.8.0 

func (c *Client) GetVoiceToneAnalysisTask(ctx context.Context, params *GetVoiceToneAnalysisTaskInput, optFns ...func(*Options)) (*GetVoiceToneAnalysisTaskOutput, error)

Retrieves the details of a voice tone analysis task.

func (*Client) ListMediaCapturePipelines 

func (c *Client) ListMediaCapturePipelines(ctx context.Context, params *ListMediaCapturePipelinesInput, optFns ...func(*Options)) (*ListMediaCapturePipelinesOutput, error)

Returns a list of media pipelines.

func (*Client) ListMediaInsightsPipelineConfigurations added in v1.3.0 

func (c *Client) ListMediaInsightsPipelineConfigurations(ctx context.Context, params *ListMediaInsightsPipelineConfigurationsInput, optFns ...func(*Options)) (*ListMediaInsightsPipelineConfigurationsOutput, error)

Lists the available media insights pipeline configurations.

func (*Client) ListMediaPipelineKinesisVideoStreamPools added in v1.9.0 

func (c *Client) ListMediaPipelineKinesisVideoStreamPools(ctx context.Context, params *ListMediaPipelineKinesisVideoStreamPoolsInput, optFns ...func(*Options)) (*ListMediaPipelineKinesisVideoStreamPoolsOutput, error)

Lists the video stream pools in the media pipeline.

func (*Client) ListMediaPipelines added in v1.1.0 

func (c *Client) ListMediaPipelines(ctx context.Context, params *ListMediaPipelinesInput, optFns ...func(*Options)) (*ListMediaPipelinesOutput, error)

Returns a list of media pipelines.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists the tags available for a media pipeline.

func (*Client) Options added in v1.13.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) StartSpeakerSearchTask added in v1.8.0 

func (c *Client) StartSpeakerSearchTask(ctx context.Context, params *StartSpeakerSearchTaskInput, optFns ...func(*Options)) (*StartSpeakerSearchTaskOutput, error)

Starts a speaker search task. Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms (https://aws.amazon.com/service-terms/) for the Amazon Chime SDK.

func (*Client) StartVoiceToneAnalysisTask added in v1.8.0 

func (c *Client) StartVoiceToneAnalysisTask(ctx context.Context, params *StartVoiceToneAnalysisTaskInput, optFns ...func(*Options)) (*StartVoiceToneAnalysisTaskOutput, error)

Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics (https://docs.aws.amazon.com/chime-sdk/latest/dg/voice-analytics.html) in the Amazon Chime SDK Developer Guide. Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms (https://aws.amazon.com/service-terms/) for the Amazon Chime SDK.

func (*Client) StopSpeakerSearchTask added in v1.8.0 

func (c *Client) StopSpeakerSearchTask(ctx context.Context, params *StopSpeakerSearchTaskInput, optFns ...func(*Options)) (*StopSpeakerSearchTaskOutput, error)

Stops a speaker search task.

func (*Client) StopVoiceToneAnalysisTask added in v1.8.0 

func (c *Client) StopVoiceToneAnalysisTask(ctx context.Context, params *StopVoiceToneAnalysisTaskInput, optFns ...func(*Options)) (*StopVoiceToneAnalysisTaskOutput, error)

Stops a voice tone analysis task.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

The ARN of the media pipeline that you want to tag. Consists of the pipeline's endpoint region, resource ID, and pipeline ID.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes any tags from a media pipeline.

func (*Client) UpdateMediaInsightsPipelineConfiguration added in v1.3.0 

func (c *Client) UpdateMediaInsightsPipelineConfiguration(ctx context.Context, params *UpdateMediaInsightsPipelineConfigurationInput, optFns ...func(*Options)) (*UpdateMediaInsightsPipelineConfigurationOutput, error)

Updates the media insights pipeline's configuration settings.

func (*Client) UpdateMediaInsightsPipelineStatus added in v1.3.0 

func (c *Client) UpdateMediaInsightsPipelineStatus(ctx context.Context, params *UpdateMediaInsightsPipelineStatusInput, optFns ...func(*Options)) (*UpdateMediaInsightsPipelineStatusOutput, error)

Updates the status of a media insights pipeline.

func (*Client) UpdateMediaPipelineKinesisVideoStreamPool added in v1.9.0 

func (c *Client) UpdateMediaPipelineKinesisVideoStreamPool(ctx context.Context, params *UpdateMediaPipelineKinesisVideoStreamPoolInput, optFns ...func(*Options)) (*UpdateMediaPipelineKinesisVideoStreamPoolOutput, error)

Updates an Kinesis video stream pool in a media pipeline.

type CreateMediaCapturePipelineInput 

type CreateMediaCapturePipelineInput struct {

	// The ARN of the sink type.
	//
	// This member is required.
	SinkArn *string

	// Destination type to which the media artifacts are saved. You must use an S3
	// bucket.
	//
	// This member is required.
	SinkType types.MediaPipelineSinkType

	// ARN of the source from which the media artifacts are captured.
	//
	// This member is required.
	SourceArn *string

	// Source type from which the media artifacts are captured. A Chime SDK Meeting is
	// the only supported source.
	//
	// This member is required.
	SourceType types.MediaPipelineSourceType

	// The configuration for a specified media pipeline. SourceType must be
	// ChimeSdkMeeting .
	ChimeSdkMeetingConfiguration *types.ChimeSdkMeetingConfiguration

	// The unique identifier for the client request. The token makes the API request
	// idempotent. Use a unique token for each media pipeline request.
	ClientRequestToken *string

	// The tag key-value pairs.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateMediaCapturePipelineOutput 

type CreateMediaCapturePipelineOutput struct {

	// A media pipeline object, the ID, source type, source ARN, sink type, and sink
	// ARN of a media pipeline object.
	MediaCapturePipeline *types.MediaCapturePipeline

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateMediaConcatenationPipelineInput added in v1.1.0 

type CreateMediaConcatenationPipelineInput struct {

	// An object that specifies the data sinks for the media concatenation pipeline.
	//
	// This member is required.
	Sinks []types.ConcatenationSink

	// An object that specifies the sources for the media concatenation pipeline.
	//
	// This member is required.
	Sources []types.ConcatenationSource

	// The unique identifier for the client request. The token makes the API request
	// idempotent. Use a unique token for each media concatenation pipeline request.
	ClientRequestToken *string

	// The tags associated with the media concatenation pipeline.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateMediaConcatenationPipelineOutput added in v1.1.0 

type CreateMediaConcatenationPipelineOutput struct {

	// A media concatenation pipeline object, the ID, source type, MediaPipelineARN ,
	// and sink of a media concatenation pipeline object.
	MediaConcatenationPipeline *types.MediaConcatenationPipeline

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateMediaInsightsPipelineConfigurationInput added in v1.3.0 

type CreateMediaInsightsPipelineConfigurationInput struct {

	// The elements in the request, such as a processor for Amazon Transcribe or a
	// sink for a Kinesis Data Stream.
	//
	// This member is required.
	Elements []types.MediaInsightsPipelineConfigurationElement

	// The name of the media insights pipeline configuration.
	//
	// This member is required.
	MediaInsightsPipelineConfigurationName *string

	// The ARN of the role used by the service to access Amazon Web Services
	// resources, including Transcribe and Transcribe Call Analytics , on the caller’s
	// behalf.
	//
	// This member is required.
	ResourceAccessRoleArn *string

	// The unique identifier for the media insights pipeline configuration request.
	ClientRequestToken *string

	// The configuration settings for the real-time alerts in a media insights
	// pipeline configuration.
	RealTimeAlertConfiguration *types.RealTimeAlertConfiguration

	// The tags assigned to the media insights pipeline configuration.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateMediaInsightsPipelineConfigurationOutput added in v1.3.0 

type CreateMediaInsightsPipelineConfigurationOutput struct {

	// The configuration settings for the media insights pipeline.
	MediaInsightsPipelineConfiguration *types.MediaInsightsPipelineConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateMediaInsightsPipelineInput added in v1.3.0 

type CreateMediaInsightsPipelineInput struct {

	// The ARN of the pipeline's configuration.
	//
	// This member is required.
	MediaInsightsPipelineConfigurationArn *string

	// The unique identifier for the media insights pipeline request.
	ClientRequestToken *string

	// The runtime configuration for the Kinesis video recording stream source.
	KinesisVideoStreamRecordingSourceRuntimeConfiguration *types.KinesisVideoStreamRecordingSourceRuntimeConfiguration

	// The runtime configuration for the Kinesis video stream source of the media
	// insights pipeline.
	KinesisVideoStreamSourceRuntimeConfiguration *types.KinesisVideoStreamSourceRuntimeConfiguration

	// The runtime metadata for the media insights pipeline. Consists of a key-value
	// map of strings.
	MediaInsightsRuntimeMetadata map[string]string

	// The runtime configuration for the S3 recording sink. If specified, the settings
	// in this structure override any settings in S3RecordingSinkConfiguration .
	S3RecordingSinkRuntimeConfiguration *types.S3RecordingSinkRuntimeConfiguration

	// The tags assigned to the media insights pipeline.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateMediaInsightsPipelineOutput added in v1.3.0 

type CreateMediaInsightsPipelineOutput struct {

	// The media insights pipeline object.
	//
	// This member is required.
	MediaInsightsPipeline *types.MediaInsightsPipeline

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateMediaLiveConnectorPipelineInput added in v1.1.0 

type CreateMediaLiveConnectorPipelineInput struct {

	// The media live connector pipeline's data sinks.
	//
	// This member is required.
	Sinks []types.LiveConnectorSinkConfiguration

	// The media live connector pipeline's data sources.
	//
	// This member is required.
	Sources []types.LiveConnectorSourceConfiguration

	// The token assigned to the client making the request.
	ClientRequestToken *string

	// The tags associated with the media live connector pipeline.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateMediaLiveConnectorPipelineOutput added in v1.1.0 

type CreateMediaLiveConnectorPipelineOutput struct {

	// The new media live connector pipeline.
	MediaLiveConnectorPipeline *types.MediaLiveConnectorPipeline

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateMediaPipelineKinesisVideoStreamPoolInput added in v1.9.0 

type CreateMediaPipelineKinesisVideoStreamPoolInput struct {

	// The name of the video stream pool.
	//
	// This member is required.
	PoolName *string

	// The configuration settings for the video stream.
	//
	// This member is required.
	StreamConfiguration *types.KinesisVideoStreamConfiguration

	// The token assigned to the client making the request.
	ClientRequestToken *string

	// The tags assigned to the video stream pool.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateMediaPipelineKinesisVideoStreamPoolOutput added in v1.9.0 

type CreateMediaPipelineKinesisVideoStreamPoolOutput struct {

	// The configuration for the Kinesis video stream pool.
	KinesisVideoStreamPoolConfiguration *types.KinesisVideoStreamPoolConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateMediaStreamPipelineInput added in v1.9.0 

type CreateMediaStreamPipelineInput struct {

	// The data sink for the media pipeline.
	//
	// This member is required.
	Sinks []types.MediaStreamSink

	// The data sources for the media pipeline.
	//
	// This member is required.
	Sources []types.MediaStreamSource

	// The token assigned to the client making the request.
	ClientRequestToken *string

	// The tags assigned to the media pipeline.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateMediaStreamPipelineOutput added in v1.9.0 

type CreateMediaStreamPipelineOutput struct {

	// The requested media pipeline.
	MediaStreamPipeline *types.MediaStreamPipeline

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteMediaCapturePipelineInput 

type DeleteMediaCapturePipelineInput struct {

	// The ID of the media pipeline being deleted.
	//
	// This member is required.
	MediaPipelineId *string
	// contains filtered or unexported fields
}

type DeleteMediaCapturePipelineOutput 

type DeleteMediaCapturePipelineOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteMediaInsightsPipelineConfigurationInput added in v1.3.0 

type DeleteMediaInsightsPipelineConfigurationInput struct {

	// The unique identifier of the resource to be deleted. Valid values include the
	// name and ARN of the media insights pipeline configuration.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type DeleteMediaInsightsPipelineConfigurationOutput added in v1.3.0 

type DeleteMediaInsightsPipelineConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteMediaPipelineInput added in v1.1.0 

type DeleteMediaPipelineInput struct {

	// The ID of the media pipeline to delete.
	//
	// This member is required.
	MediaPipelineId *string
	// contains filtered or unexported fields
}

type DeleteMediaPipelineKinesisVideoStreamPoolInput added in v1.9.0 

type DeleteMediaPipelineKinesisVideoStreamPoolInput struct {

	// The ID of the pool being deleted.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type DeleteMediaPipelineKinesisVideoStreamPoolOutput added in v1.9.0 

type DeleteMediaPipelineKinesisVideoStreamPoolOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteMediaPipelineOutput added in v1.1.0 

type DeleteMediaPipelineOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.6.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.6.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.6.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (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 EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.6.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.6.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetMediaCapturePipelineInput 

type GetMediaCapturePipelineInput struct {

	// The ID of the pipeline that you want to get.
	//
	// This member is required.
	MediaPipelineId *string
	// contains filtered or unexported fields
}

type GetMediaCapturePipelineOutput 

type GetMediaCapturePipelineOutput struct {

	// The media pipeline object.
	MediaCapturePipeline *types.MediaCapturePipeline

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMediaInsightsPipelineConfigurationInput added in v1.3.0 

type GetMediaInsightsPipelineConfigurationInput struct {

	// The unique identifier of the requested resource. Valid values include the name
	// and ARN of the media insights pipeline configuration.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type GetMediaInsightsPipelineConfigurationOutput added in v1.3.0 

type GetMediaInsightsPipelineConfigurationOutput struct {

	// The requested media insights pipeline configuration.
	MediaInsightsPipelineConfiguration *types.MediaInsightsPipelineConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMediaPipelineInput added in v1.1.0 

type GetMediaPipelineInput struct {

	// The ID of the pipeline that you want to get.
	//
	// This member is required.
	MediaPipelineId *string
	// contains filtered or unexported fields
}

type GetMediaPipelineKinesisVideoStreamPoolInput added in v1.9.0 

type GetMediaPipelineKinesisVideoStreamPoolInput struct {

	// The ID of the video stream pool.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type GetMediaPipelineKinesisVideoStreamPoolOutput added in v1.9.0 

type GetMediaPipelineKinesisVideoStreamPoolOutput struct {

	// The video stream pool configuration object.
	KinesisVideoStreamPoolConfiguration *types.KinesisVideoStreamPoolConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMediaPipelineOutput added in v1.1.0 

type GetMediaPipelineOutput struct {

	// The media pipeline object.
	MediaPipeline *types.MediaPipeline

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSpeakerSearchTaskInput added in v1.8.0 

type GetSpeakerSearchTaskInput struct {

	// The unique identifier of the resource to be updated. Valid values include the
	// ID and ARN of the media insights pipeline.
	//
	// This member is required.
	Identifier *string

	// The ID of the speaker search task.
	//
	// This member is required.
	SpeakerSearchTaskId *string
	// contains filtered or unexported fields
}

type GetSpeakerSearchTaskOutput added in v1.8.0 

type GetSpeakerSearchTaskOutput struct {

	// The details of the speaker search task.
	SpeakerSearchTask *types.SpeakerSearchTask

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetVoiceToneAnalysisTaskInput added in v1.8.0 

type GetVoiceToneAnalysisTaskInput struct {

	// The unique identifier of the resource to be updated. Valid values include the
	// ID and ARN of the media insights pipeline.
	//
	// This member is required.
	Identifier *string

	// The ID of the voice tone analysis task.
	//
	// This member is required.
	VoiceToneAnalysisTaskId *string
	// contains filtered or unexported fields
}

type GetVoiceToneAnalysisTaskOutput added in v1.8.0 

type GetVoiceToneAnalysisTaskOutput struct {

	// The details of the voice tone analysis task.
	VoiceToneAnalysisTask *types.VoiceToneAnalysisTask

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListMediaCapturePipelinesAPIClient 

type ListMediaCapturePipelinesAPIClient interface {
	ListMediaCapturePipelines(context.Context, *ListMediaCapturePipelinesInput, ...func(*Options)) (*ListMediaCapturePipelinesOutput, error)
}

ListMediaCapturePipelinesAPIClient is a client that implements the ListMediaCapturePipelines operation.

type ListMediaCapturePipelinesInput 

type ListMediaCapturePipelinesInput struct {

	// The maximum number of results to return in a single call. Valid Range: 1 - 99.
	MaxResults *int32

	// The token used to retrieve the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMediaCapturePipelinesOutput 

type ListMediaCapturePipelinesOutput struct {

	// The media pipeline objects in the list.
	MediaCapturePipelines []types.MediaCapturePipelineSummary

	// The token used to retrieve the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMediaCapturePipelinesPaginator 

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

ListMediaCapturePipelinesPaginator is a paginator for ListMediaCapturePipelines

func NewListMediaCapturePipelinesPaginator 

func NewListMediaCapturePipelinesPaginator(client ListMediaCapturePipelinesAPIClient, params *ListMediaCapturePipelinesInput, optFns ...func(*ListMediaCapturePipelinesPaginatorOptions)) *ListMediaCapturePipelinesPaginator

NewListMediaCapturePipelinesPaginator returns a new ListMediaCapturePipelinesPaginator

func (*ListMediaCapturePipelinesPaginator) HasMorePages 

func (p *ListMediaCapturePipelinesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMediaCapturePipelinesPaginator) NextPage 

func (p *ListMediaCapturePipelinesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMediaCapturePipelinesOutput, error)

NextPage retrieves the next ListMediaCapturePipelines page.

type ListMediaCapturePipelinesPaginatorOptions 

type ListMediaCapturePipelinesPaginatorOptions struct {
	// The maximum number of results to return in a single call. Valid Range: 1 - 99.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMediaCapturePipelinesPaginatorOptions is the paginator options for ListMediaCapturePipelines

type ListMediaInsightsPipelineConfigurationsAPIClient added in v1.3.0 

type ListMediaInsightsPipelineConfigurationsAPIClient interface {
	ListMediaInsightsPipelineConfigurations(context.Context, *ListMediaInsightsPipelineConfigurationsInput, ...func(*Options)) (*ListMediaInsightsPipelineConfigurationsOutput, error)
}

ListMediaInsightsPipelineConfigurationsAPIClient is a client that implements the ListMediaInsightsPipelineConfigurations operation.

type ListMediaInsightsPipelineConfigurationsInput added in v1.3.0 

type ListMediaInsightsPipelineConfigurationsInput struct {

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token used to return the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMediaInsightsPipelineConfigurationsOutput added in v1.3.0 

type ListMediaInsightsPipelineConfigurationsOutput struct {

	// The requested list of media insights pipeline configurations.
	MediaInsightsPipelineConfigurations []types.MediaInsightsPipelineConfigurationSummary

	// The token used to return the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMediaInsightsPipelineConfigurationsPaginator added in v1.3.0 

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

ListMediaInsightsPipelineConfigurationsPaginator is a paginator for ListMediaInsightsPipelineConfigurations

func NewListMediaInsightsPipelineConfigurationsPaginator added in v1.3.0 

func NewListMediaInsightsPipelineConfigurationsPaginator(client ListMediaInsightsPipelineConfigurationsAPIClient, params *ListMediaInsightsPipelineConfigurationsInput, optFns ...func(*ListMediaInsightsPipelineConfigurationsPaginatorOptions)) *ListMediaInsightsPipelineConfigurationsPaginator

NewListMediaInsightsPipelineConfigurationsPaginator returns a new ListMediaInsightsPipelineConfigurationsPaginator

func (*ListMediaInsightsPipelineConfigurationsPaginator) HasMorePages added in v1.3.0 

func (p *ListMediaInsightsPipelineConfigurationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMediaInsightsPipelineConfigurationsPaginator) NextPage added in v1.3.0 

func (p *ListMediaInsightsPipelineConfigurationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMediaInsightsPipelineConfigurationsOutput, error)

NextPage retrieves the next ListMediaInsightsPipelineConfigurations page.

type ListMediaInsightsPipelineConfigurationsPaginatorOptions added in v1.3.0 

type ListMediaInsightsPipelineConfigurationsPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMediaInsightsPipelineConfigurationsPaginatorOptions is the paginator options for ListMediaInsightsPipelineConfigurations

type ListMediaPipelineKinesisVideoStreamPoolsAPIClient added in v1.9.0 

type ListMediaPipelineKinesisVideoStreamPoolsAPIClient interface {
	ListMediaPipelineKinesisVideoStreamPools(context.Context, *ListMediaPipelineKinesisVideoStreamPoolsInput, ...func(*Options)) (*ListMediaPipelineKinesisVideoStreamPoolsOutput, error)
}

ListMediaPipelineKinesisVideoStreamPoolsAPIClient is a client that implements the ListMediaPipelineKinesisVideoStreamPools operation.

type ListMediaPipelineKinesisVideoStreamPoolsInput added in v1.9.0 

type ListMediaPipelineKinesisVideoStreamPoolsInput struct {

	// The maximum number of results to return in a single call.
	MaxResults *int32

	// The token used to return the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMediaPipelineKinesisVideoStreamPoolsOutput added in v1.9.0 

type ListMediaPipelineKinesisVideoStreamPoolsOutput struct {

	// The list of video stream pools.
	KinesisVideoStreamPools []types.KinesisVideoStreamPoolSummary

	// The token used to return the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMediaPipelineKinesisVideoStreamPoolsPaginator added in v1.9.0 

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

ListMediaPipelineKinesisVideoStreamPoolsPaginator is a paginator for ListMediaPipelineKinesisVideoStreamPools

func NewListMediaPipelineKinesisVideoStreamPoolsPaginator added in v1.9.0 

func NewListMediaPipelineKinesisVideoStreamPoolsPaginator(client ListMediaPipelineKinesisVideoStreamPoolsAPIClient, params *ListMediaPipelineKinesisVideoStreamPoolsInput, optFns ...func(*ListMediaPipelineKinesisVideoStreamPoolsPaginatorOptions)) *ListMediaPipelineKinesisVideoStreamPoolsPaginator

NewListMediaPipelineKinesisVideoStreamPoolsPaginator returns a new ListMediaPipelineKinesisVideoStreamPoolsPaginator

func (*ListMediaPipelineKinesisVideoStreamPoolsPaginator) HasMorePages added in v1.9.0 

func (p *ListMediaPipelineKinesisVideoStreamPoolsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMediaPipelineKinesisVideoStreamPoolsPaginator) NextPage added in v1.9.0 

func (p *ListMediaPipelineKinesisVideoStreamPoolsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMediaPipelineKinesisVideoStreamPoolsOutput, error)

NextPage retrieves the next ListMediaPipelineKinesisVideoStreamPools page.

type ListMediaPipelineKinesisVideoStreamPoolsPaginatorOptions added in v1.9.0 

type ListMediaPipelineKinesisVideoStreamPoolsPaginatorOptions struct {
	// The maximum number of results to return in a single call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMediaPipelineKinesisVideoStreamPoolsPaginatorOptions is the paginator options for ListMediaPipelineKinesisVideoStreamPools

type ListMediaPipelinesAPIClient added in v1.1.0 

type ListMediaPipelinesAPIClient interface {
	ListMediaPipelines(context.Context, *ListMediaPipelinesInput, ...func(*Options)) (*ListMediaPipelinesOutput, error)
}

ListMediaPipelinesAPIClient is a client that implements the ListMediaPipelines operation.

type ListMediaPipelinesInput added in v1.1.0 

type ListMediaPipelinesInput struct {

	// The maximum number of results to return in a single call. Valid Range: 1 - 99.
	MaxResults *int32

	// The token used to retrieve the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMediaPipelinesOutput added in v1.1.0 

type ListMediaPipelinesOutput struct {

	// The media pipeline objects in the list.
	MediaPipelines []types.MediaPipelineSummary

	// The token used to retrieve the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListMediaPipelinesPaginator added in v1.1.0 

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

ListMediaPipelinesPaginator is a paginator for ListMediaPipelines

func NewListMediaPipelinesPaginator added in v1.1.0 

func NewListMediaPipelinesPaginator(client ListMediaPipelinesAPIClient, params *ListMediaPipelinesInput, optFns ...func(*ListMediaPipelinesPaginatorOptions)) *ListMediaPipelinesPaginator

NewListMediaPipelinesPaginator returns a new ListMediaPipelinesPaginator

func (*ListMediaPipelinesPaginator) HasMorePages added in v1.1.0 

func (p *ListMediaPipelinesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMediaPipelinesPaginator) NextPage added in v1.1.0 

func (p *ListMediaPipelinesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMediaPipelinesOutput, error)

NextPage retrieves the next ListMediaPipelines page.

type ListMediaPipelinesPaginatorOptions added in v1.1.0 

type ListMediaPipelinesPaginatorOptions struct {
	// The maximum number of results to return in a single call. Valid Range: 1 - 99.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMediaPipelinesPaginatorOptions is the paginator options for ListMediaPipelines

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN of the media pipeline associated with any tags. The ARN consists of the
	// pipeline's region, resource ID, and pipeline ID.
	//
	// This member is required.
	ResourceARN *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags associated with the specified media pipeline.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

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

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

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

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom
	// endpoint, set the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

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

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. If specified in an operation call's
	// functional options with a value that is different than the constructed client's
	// Options, the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

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

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver added in v1.12.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartSpeakerSearchTaskInput added in v1.8.0 

type StartSpeakerSearchTaskInput struct {

	// The unique identifier of the resource to be updated. Valid values include the
	// ID and ARN of the media insights pipeline.
	//
	// This member is required.
	Identifier *string

	// The ARN of the voice profile domain that will store the voice profile.
	//
	// This member is required.
	VoiceProfileDomainArn *string

	// The unique identifier for the client request. Use a different token for
	// different speaker search tasks.
	ClientRequestToken *string

	// The task configuration for the Kinesis video stream source of the media
	// insights pipeline.
	KinesisVideoStreamSourceTaskConfiguration *types.KinesisVideoStreamSourceTaskConfiguration
	// contains filtered or unexported fields
}

type StartSpeakerSearchTaskOutput added in v1.8.0 

type StartSpeakerSearchTaskOutput struct {

	// The details of the speaker search task.
	SpeakerSearchTask *types.SpeakerSearchTask

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartVoiceToneAnalysisTaskInput added in v1.8.0 

type StartVoiceToneAnalysisTaskInput struct {

	// The unique identifier of the resource to be updated. Valid values include the
	// ID and ARN of the media insights pipeline.
	//
	// This member is required.
	Identifier *string

	// The language code.
	//
	// This member is required.
	LanguageCode types.VoiceAnalyticsLanguageCode

	// The unique identifier for the client request. Use a different token for
	// different voice tone analysis tasks.
	ClientRequestToken *string

	// The task configuration for the Kinesis video stream source of the media
	// insights pipeline.
	KinesisVideoStreamSourceTaskConfiguration *types.KinesisVideoStreamSourceTaskConfiguration
	// contains filtered or unexported fields
}

type StartVoiceToneAnalysisTaskOutput added in v1.8.0 

type StartVoiceToneAnalysisTaskOutput struct {

	// The details of the voice tone analysis task.
	VoiceToneAnalysisTask *types.VoiceToneAnalysisTask

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopSpeakerSearchTaskInput added in v1.8.0 

type StopSpeakerSearchTaskInput struct {

	// The unique identifier of the resource to be updated. Valid values include the
	// ID and ARN of the media insights pipeline.
	//
	// This member is required.
	Identifier *string

	// The speaker search task ID.
	//
	// This member is required.
	SpeakerSearchTaskId *string
	// contains filtered or unexported fields
}

type StopSpeakerSearchTaskOutput added in v1.8.0 

type StopSpeakerSearchTaskOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopVoiceToneAnalysisTaskInput added in v1.8.0 

type StopVoiceToneAnalysisTaskInput struct {

	// The unique identifier of the resource to be updated. Valid values include the
	// ID and ARN of the media insights pipeline.
	//
	// This member is required.
	Identifier *string

	// The ID of the voice tone analysis task.
	//
	// This member is required.
	VoiceToneAnalysisTaskId *string
	// contains filtered or unexported fields
}

type StopVoiceToneAnalysisTaskOutput added in v1.8.0 

type StopVoiceToneAnalysisTaskOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// The ARN of the media pipeline associated with any tags. The ARN consists of the
	// pipeline's endpoint region, resource ID, and pipeline ID.
	//
	// This member is required.
	ResourceARN *string

	// The tags associated with the specified media pipeline.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The ARN of the pipeline that you want to untag.
	//
	// This member is required.
	ResourceARN *string

	// The key/value pairs in the tag that you want to remove.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateMediaInsightsPipelineConfigurationInput added in v1.3.0 

type UpdateMediaInsightsPipelineConfigurationInput struct {

	// The elements in the request, such as a processor for Amazon Transcribe or a
	// sink for a Kinesis Data Stream..
	//
	// This member is required.
	Elements []types.MediaInsightsPipelineConfigurationElement

	// The unique identifier for the resource to be updated. Valid values include the
	// name and ARN of the media insights pipeline configuration.
	//
	// This member is required.
	Identifier *string

	// The ARN of the role used by the service to access Amazon Web Services resources.
	//
	// This member is required.
	ResourceAccessRoleArn *string

	// The configuration settings for real-time alerts for the media insights pipeline.
	RealTimeAlertConfiguration *types.RealTimeAlertConfiguration
	// contains filtered or unexported fields
}

type UpdateMediaInsightsPipelineConfigurationOutput added in v1.3.0 

type UpdateMediaInsightsPipelineConfigurationOutput struct {

	// The updated configuration settings.
	MediaInsightsPipelineConfiguration *types.MediaInsightsPipelineConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateMediaInsightsPipelineStatusInput added in v1.3.0 

type UpdateMediaInsightsPipelineStatusInput struct {

	// The unique identifier of the resource to be updated. Valid values include the
	// ID and ARN of the media insights pipeline.
	//
	// This member is required.
	Identifier *string

	// The requested status of the media insights pipeline.
	//
	// This member is required.
	UpdateStatus types.MediaPipelineStatusUpdate
	// contains filtered or unexported fields
}

type UpdateMediaInsightsPipelineStatusOutput added in v1.3.0 

type UpdateMediaInsightsPipelineStatusOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateMediaPipelineKinesisVideoStreamPoolInput added in v1.9.0 

type UpdateMediaPipelineKinesisVideoStreamPoolInput struct {

	// The ID of the video stream pool.
	//
	// This member is required.
	Identifier *string

	// The configuration settings for the video stream.
	StreamConfiguration *types.KinesisVideoStreamConfigurationUpdate
	// contains filtered or unexported fields
}

type UpdateMediaPipelineKinesisVideoStreamPoolOutput added in v1.9.0 

type UpdateMediaPipelineKinesisVideoStreamPoolOutput struct {

	// The video stream pool configuration object.
	KinesisVideoStreamPoolConfiguration *types.KinesisVideoStreamPoolConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.