chimesdkmediapipelines

package
v1.44.15 Latest Latest
Warning

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

Go to latest
Published: May 16, 2022 License: Apache-2.0 Imports: 10 Imported by: 4

Documentation

Overview

Package chimesdkmediapipelines provides the client and types for making API requests to 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 and capture audio, video, events, and data messages from Amazon Chime SDK meetings. For more information about media pipleines, see Amzon Chime SDK media pipelines (https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Media_Pipelines.html).

See https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15 for more information on this service.

See chimesdkmediapipelines package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/chimesdkmediapipelines/

Using the Client

To contact Amazon Chime SDK Media Pipelines with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Chime SDK Media Pipelines client ChimeSDKMediaPipelines for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/chimesdkmediapipelines/#New

Index

Constants

View Source
const (
	// ArtifactsStateEnabled is a ArtifactsState enum value
	ArtifactsStateEnabled = "Enabled"

	// ArtifactsStateDisabled is a ArtifactsState enum value
	ArtifactsStateDisabled = "Disabled"
)
View Source
const (
	// AudioMuxTypeAudioOnly is a AudioMuxType enum value
	AudioMuxTypeAudioOnly = "AudioOnly"

	// AudioMuxTypeAudioWithActiveSpeakerVideo is a AudioMuxType enum value
	AudioMuxTypeAudioWithActiveSpeakerVideo = "AudioWithActiveSpeakerVideo"
)
View Source
const (
	// ErrorCodeBadRequest is a ErrorCode enum value
	ErrorCodeBadRequest = "BadRequest"

	// ErrorCodeForbidden is a ErrorCode enum value
	ErrorCodeForbidden = "Forbidden"

	// ErrorCodeNotFound is a ErrorCode enum value
	ErrorCodeNotFound = "NotFound"

	// ErrorCodeResourceLimitExceeded is a ErrorCode enum value
	ErrorCodeResourceLimitExceeded = "ResourceLimitExceeded"

	// ErrorCodeServiceFailure is a ErrorCode enum value
	ErrorCodeServiceFailure = "ServiceFailure"

	// ErrorCodeServiceUnavailable is a ErrorCode enum value
	ErrorCodeServiceUnavailable = "ServiceUnavailable"

	// ErrorCodeThrottling is a ErrorCode enum value
	ErrorCodeThrottling = "Throttling"
)
View Source
const (
	// MediaPipelineStatusInitializing is a MediaPipelineStatus enum value
	MediaPipelineStatusInitializing = "Initializing"

	// MediaPipelineStatusInProgress is a MediaPipelineStatus enum value
	MediaPipelineStatusInProgress = "InProgress"

	// MediaPipelineStatusFailed is a MediaPipelineStatus enum value
	MediaPipelineStatusFailed = "Failed"

	// MediaPipelineStatusStopping is a MediaPipelineStatus enum value
	MediaPipelineStatusStopping = "Stopping"

	// MediaPipelineStatusStopped is a MediaPipelineStatus enum value
	MediaPipelineStatusStopped = "Stopped"
)
View Source
const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// The input parameters don't match the service's restrictions.
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeForbiddenException for service response error code
	// "ForbiddenException".
	//
	// The client is permanently forbidden from making the request.
	ErrCodeForbiddenException = "ForbiddenException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// One or more of the resources in the request does not exist in the system.
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeResourceLimitExceededException for service response error code
	// "ResourceLimitExceededException".
	//
	// The request exceeds the resource limit.
	ErrCodeResourceLimitExceededException = "ResourceLimitExceededException"

	// ErrCodeServiceFailureException for service response error code
	// "ServiceFailureException".
	//
	// The service encountered an unexpected error.
	ErrCodeServiceFailureException = "ServiceFailureException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The service is currently unavailable.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeThrottledClientException for service response error code
	// "ThrottledClientException".
	//
	// The client exceeded its request rate limit.
	ErrCodeThrottledClientException = "ThrottledClientException"

	// ErrCodeUnauthorizedClientException for service response error code
	// "UnauthorizedClientException".
	//
	// The client is not currently authorized to make the request.
	ErrCodeUnauthorizedClientException = "UnauthorizedClientException"
)
View Source
const (
	ServiceName = "Chime SDK Media Pipelines" // Name of service.
	EndpointsID = "media-pipelines-chime"     // ID to lookup a service endpoint with.
	ServiceID   = "Chime SDK Media Pipelines" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// ContentMuxTypeContentOnly is a ContentMuxType enum value
	ContentMuxTypeContentOnly = "ContentOnly"
)
View Source
const (
	// MediaPipelineSinkTypeS3bucket is a MediaPipelineSinkType enum value
	MediaPipelineSinkTypeS3bucket = "S3Bucket"
)
View Source
const (
	// MediaPipelineSourceTypeChimeSdkMeeting is a MediaPipelineSourceType enum value
	MediaPipelineSourceTypeChimeSdkMeeting = "ChimeSdkMeeting"
)
View Source
const (
	// VideoMuxTypeVideoOnly is a VideoMuxType enum value
	VideoMuxTypeVideoOnly = "VideoOnly"
)

Variables

This section is empty.

Functions

func ArtifactsState_Values

func ArtifactsState_Values() []string

ArtifactsState_Values returns all elements of the ArtifactsState enum

func AudioMuxType_Values

func AudioMuxType_Values() []string

AudioMuxType_Values returns all elements of the AudioMuxType enum

func ContentMuxType_Values

func ContentMuxType_Values() []string

ContentMuxType_Values returns all elements of the ContentMuxType enum

func ErrorCode_Values

func ErrorCode_Values() []string

ErrorCode_Values returns all elements of the ErrorCode enum

func MediaPipelineSinkType_Values

func MediaPipelineSinkType_Values() []string

MediaPipelineSinkType_Values returns all elements of the MediaPipelineSinkType enum

func MediaPipelineSourceType_Values

func MediaPipelineSourceType_Values() []string

MediaPipelineSourceType_Values returns all elements of the MediaPipelineSourceType enum

func MediaPipelineStatus_Values

func MediaPipelineStatus_Values() []string

MediaPipelineStatus_Values returns all elements of the MediaPipelineStatus enum

func VideoMuxType_Values

func VideoMuxType_Values() []string

VideoMuxType_Values returns all elements of the VideoMuxType enum

Types

type ArtifactsConfiguration

type ArtifactsConfiguration struct {

	// The configuration for the audio artifacts.
	//
	// Audio is a required field
	Audio *AudioArtifactsConfiguration `type:"structure" required:"true"`

	// The configuration for the content artifacts.
	//
	// Content is a required field
	Content *ContentArtifactsConfiguration `type:"structure" required:"true"`

	// The configuration for the video artifacts.
	//
	// Video is a required field
	Video *VideoArtifactsConfiguration `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The configuration for the artifacts.

func (ArtifactsConfiguration) GoString

func (s ArtifactsConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ArtifactsConfiguration) SetAudio

SetAudio sets the Audio field's value.

func (*ArtifactsConfiguration) SetContent

SetContent sets the Content field's value.

func (*ArtifactsConfiguration) SetVideo

SetVideo sets the Video field's value.

func (ArtifactsConfiguration) String

func (s ArtifactsConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ArtifactsConfiguration) Validate

func (s *ArtifactsConfiguration) Validate() error

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

type AudioArtifactsConfiguration

type AudioArtifactsConfiguration struct {

	// The MUX type of the audio artifact configuration object.
	//
	// MuxType is a required field
	MuxType *string `type:"string" required:"true" enum:"AudioMuxType"`
	// contains filtered or unexported fields
}

The audio artifact configuration object.

func (AudioArtifactsConfiguration) GoString

func (s AudioArtifactsConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AudioArtifactsConfiguration) SetMuxType

SetMuxType sets the MuxType field's value.

func (AudioArtifactsConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AudioArtifactsConfiguration) Validate

func (s *AudioArtifactsConfiguration) Validate() error

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

type BadRequestException

type BadRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

	Message_ *string `locationName:"Message" type:"string"`

	// The request id associated with the call responsible for the exception.
	RequestId *string `type:"string"`
	// contains filtered or unexported fields
}

The input parameters don't match the service's restrictions.

func (*BadRequestException) Code

func (s *BadRequestException) Code() string

Code returns the exception type name.

func (*BadRequestException) Error

func (s *BadRequestException) Error() string

func (BadRequestException) GoString

func (s BadRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BadRequestException) Message

func (s *BadRequestException) Message() string

Message returns the exception's message.

func (*BadRequestException) OrigErr

func (s *BadRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadRequestException) RequestID

func (s *BadRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequestException) StatusCode

func (s *BadRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BadRequestException) String

func (s BadRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChimeSDKMediaPipelines

type ChimeSDKMediaPipelines struct {
	*client.Client
}

ChimeSDKMediaPipelines provides the API operation methods for making requests to Amazon Chime SDK Media Pipelines. See this package's package overview docs for details on the service.

ChimeSDKMediaPipelines methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

New creates a new instance of the ChimeSDKMediaPipelines client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a ChimeSDKMediaPipelines client from just a session.
svc := chimesdkmediapipelines.New(mySession)

// Create a ChimeSDKMediaPipelines client with additional configuration
svc := chimesdkmediapipelines.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*ChimeSDKMediaPipelines) CreateMediaCapturePipeline

CreateMediaCapturePipeline API operation for Amazon Chime SDK Media Pipelines.

Creates a media capture pipeline.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Media Pipelines's API operation CreateMediaCapturePipeline for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ResourceLimitExceededException The request exceeds the resource limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/CreateMediaCapturePipeline

func (*ChimeSDKMediaPipelines) CreateMediaCapturePipelineRequest

func (c *ChimeSDKMediaPipelines) CreateMediaCapturePipelineRequest(input *CreateMediaCapturePipelineInput) (req *request.Request, output *CreateMediaCapturePipelineOutput)

CreateMediaCapturePipelineRequest generates a "aws/request.Request" representing the client's request for the CreateMediaCapturePipeline operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateMediaCapturePipeline for more information on using the CreateMediaCapturePipeline API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateMediaCapturePipelineRequest method.
req, resp := client.CreateMediaCapturePipelineRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/CreateMediaCapturePipeline

func (*ChimeSDKMediaPipelines) CreateMediaCapturePipelineWithContext

func (c *ChimeSDKMediaPipelines) CreateMediaCapturePipelineWithContext(ctx aws.Context, input *CreateMediaCapturePipelineInput, opts ...request.Option) (*CreateMediaCapturePipelineOutput, error)

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

See CreateMediaCapturePipeline for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKMediaPipelines) DeleteMediaCapturePipeline

DeleteMediaCapturePipeline API operation for Amazon Chime SDK Media Pipelines.

Deletes the media capture pipeline.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Media Pipelines's API operation DeleteMediaCapturePipeline for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • NotFoundException One or more of the resources in the request does not exist in the system.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/DeleteMediaCapturePipeline

func (*ChimeSDKMediaPipelines) DeleteMediaCapturePipelineRequest

func (c *ChimeSDKMediaPipelines) DeleteMediaCapturePipelineRequest(input *DeleteMediaCapturePipelineInput) (req *request.Request, output *DeleteMediaCapturePipelineOutput)

DeleteMediaCapturePipelineRequest generates a "aws/request.Request" representing the client's request for the DeleteMediaCapturePipeline operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteMediaCapturePipeline for more information on using the DeleteMediaCapturePipeline API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteMediaCapturePipelineRequest method.
req, resp := client.DeleteMediaCapturePipelineRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/DeleteMediaCapturePipeline

func (*ChimeSDKMediaPipelines) DeleteMediaCapturePipelineWithContext

func (c *ChimeSDKMediaPipelines) DeleteMediaCapturePipelineWithContext(ctx aws.Context, input *DeleteMediaCapturePipelineInput, opts ...request.Option) (*DeleteMediaCapturePipelineOutput, error)

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

See DeleteMediaCapturePipeline for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKMediaPipelines) GetMediaCapturePipeline

GetMediaCapturePipeline API operation for Amazon Chime SDK Media Pipelines.

Gets an existing media capture pipeline.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Media Pipelines's API operation GetMediaCapturePipeline for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • NotFoundException One or more of the resources in the request does not exist in the system.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/GetMediaCapturePipeline

func (*ChimeSDKMediaPipelines) GetMediaCapturePipelineRequest

func (c *ChimeSDKMediaPipelines) GetMediaCapturePipelineRequest(input *GetMediaCapturePipelineInput) (req *request.Request, output *GetMediaCapturePipelineOutput)

GetMediaCapturePipelineRequest generates a "aws/request.Request" representing the client's request for the GetMediaCapturePipeline operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetMediaCapturePipeline for more information on using the GetMediaCapturePipeline API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetMediaCapturePipelineRequest method.
req, resp := client.GetMediaCapturePipelineRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/GetMediaCapturePipeline

func (*ChimeSDKMediaPipelines) GetMediaCapturePipelineWithContext

func (c *ChimeSDKMediaPipelines) GetMediaCapturePipelineWithContext(ctx aws.Context, input *GetMediaCapturePipelineInput, opts ...request.Option) (*GetMediaCapturePipelineOutput, error)

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

See GetMediaCapturePipeline for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKMediaPipelines) ListMediaCapturePipelines

ListMediaCapturePipelines API operation for Amazon Chime SDK Media Pipelines.

Returns a list of media capture pipelines.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Media Pipelines's API operation ListMediaCapturePipelines for usage and error information.

Returned Error Types:

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ResourceLimitExceededException The request exceeds the resource limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ListMediaCapturePipelines

func (*ChimeSDKMediaPipelines) ListMediaCapturePipelinesPages

func (c *ChimeSDKMediaPipelines) ListMediaCapturePipelinesPages(input *ListMediaCapturePipelinesInput, fn func(*ListMediaCapturePipelinesOutput, bool) bool) error

ListMediaCapturePipelinesPages iterates over the pages of a ListMediaCapturePipelines operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListMediaCapturePipelines method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListMediaCapturePipelines operation.
pageNum := 0
err := client.ListMediaCapturePipelinesPages(params,
    func(page *chimesdkmediapipelines.ListMediaCapturePipelinesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ChimeSDKMediaPipelines) ListMediaCapturePipelinesPagesWithContext

func (c *ChimeSDKMediaPipelines) ListMediaCapturePipelinesPagesWithContext(ctx aws.Context, input *ListMediaCapturePipelinesInput, fn func(*ListMediaCapturePipelinesOutput, bool) bool, opts ...request.Option) error

ListMediaCapturePipelinesPagesWithContext same as ListMediaCapturePipelinesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKMediaPipelines) ListMediaCapturePipelinesRequest

func (c *ChimeSDKMediaPipelines) ListMediaCapturePipelinesRequest(input *ListMediaCapturePipelinesInput) (req *request.Request, output *ListMediaCapturePipelinesOutput)

ListMediaCapturePipelinesRequest generates a "aws/request.Request" representing the client's request for the ListMediaCapturePipelines operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListMediaCapturePipelines for more information on using the ListMediaCapturePipelines API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListMediaCapturePipelinesRequest method.
req, resp := client.ListMediaCapturePipelinesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ListMediaCapturePipelines

func (*ChimeSDKMediaPipelines) ListMediaCapturePipelinesWithContext

func (c *ChimeSDKMediaPipelines) ListMediaCapturePipelinesWithContext(ctx aws.Context, input *ListMediaCapturePipelinesInput, opts ...request.Option) (*ListMediaCapturePipelinesOutput, error)

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

See ListMediaCapturePipelines for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKMediaPipelines) ListTagsForResource

ListTagsForResource API operation for Amazon Chime SDK Media Pipelines.

Lists the tags applied to an Amazon Chime SDK media capture pipeline.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Media Pipelines's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • NotFoundException One or more of the resources in the request does not exist in the system.

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ListTagsForResource

func (*ChimeSDKMediaPipelines) ListTagsForResourceRequest

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

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ListTagsForResource

func (*ChimeSDKMediaPipelines) ListTagsForResourceWithContext

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

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

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKMediaPipelines) TagResource

TagResource API operation for Amazon Chime SDK Media Pipelines.

Applies the specified tags to the specified Amazon Chime SDK media capture pipeline.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Media Pipelines's API operation TagResource for usage and error information.

Returned Error Types:

  • NotFoundException One or more of the resources in the request does not exist in the system.

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/TagResource

func (*ChimeSDKMediaPipelines) TagResourceRequest

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

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/TagResource

func (*ChimeSDKMediaPipelines) TagResourceWithContext

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

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

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ChimeSDKMediaPipelines) UntagResource

UntagResource API operation for Amazon Chime SDK Media Pipelines.

Removes the specified tags from the specified Amazon Chime SDK media capture pipeline.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Chime SDK Media Pipelines's API operation UntagResource for usage and error information.

Returned Error Types:

  • NotFoundException One or more of the resources in the request does not exist in the system.

  • BadRequestException The input parameters don't match the service's restrictions.

  • ForbiddenException The client is permanently forbidden from making the request.

  • UnauthorizedClientException The client is not currently authorized to make the request.

  • ThrottledClientException The client exceeded its request rate limit.

  • ServiceUnavailableException The service is currently unavailable.

  • ServiceFailureException The service encountered an unexpected error.

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/UntagResource

func (*ChimeSDKMediaPipelines) UntagResourceRequest

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

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/UntagResource

func (*ChimeSDKMediaPipelines) UntagResourceWithContext

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

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

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ChimeSdkMeetingConfiguration

type ChimeSdkMeetingConfiguration struct {

	// The configuration for the artifacts in an Amazon Chime SDK meeting.
	ArtifactsConfiguration *ArtifactsConfiguration `type:"structure"`

	// The source configuration for a specified media capture pipline.
	SourceConfiguration *SourceConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

The configuration object of the Amazon Chime SDK meeting for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.

func (ChimeSdkMeetingConfiguration) GoString

func (s ChimeSdkMeetingConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChimeSdkMeetingConfiguration) SetArtifactsConfiguration

SetArtifactsConfiguration sets the ArtifactsConfiguration field's value.

func (*ChimeSdkMeetingConfiguration) SetSourceConfiguration

SetSourceConfiguration sets the SourceConfiguration field's value.

func (ChimeSdkMeetingConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChimeSdkMeetingConfiguration) Validate

func (s *ChimeSdkMeetingConfiguration) Validate() error

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

type ContentArtifactsConfiguration

type ContentArtifactsConfiguration struct {

	// The MUX type of the artifact configuration.
	MuxType *string `type:"string" enum:"ContentMuxType"`

	// Indicates whether the content artifact is enabled or disabled.
	//
	// State is a required field
	State *string `type:"string" required:"true" enum:"ArtifactsState"`
	// contains filtered or unexported fields
}

The content artifact object.

func (ContentArtifactsConfiguration) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContentArtifactsConfiguration) SetMuxType

SetMuxType sets the MuxType field's value.

func (*ContentArtifactsConfiguration) SetState

SetState sets the State field's value.

func (ContentArtifactsConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContentArtifactsConfiguration) Validate

func (s *ContentArtifactsConfiguration) Validate() error

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

type CreateMediaCapturePipelineInput

type CreateMediaCapturePipelineInput struct {

	// The configuration for a specified media capture pipeline. SourceType must
	// be ChimeSdkMeeting.
	ChimeSdkMeetingConfiguration *ChimeSdkMeetingConfiguration `type:"structure"`

	// The token assigned to the client making the pipeline request.
	//
	// ClientRequestToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateMediaCapturePipelineInput's
	// String and GoString methods.
	ClientRequestToken *string `min:"2" type:"string" idempotencyToken:"true" sensitive:"true"`

	// The ARN of the sink type.
	//
	// SinkArn is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateMediaCapturePipelineInput's
	// String and GoString methods.
	//
	// SinkArn is a required field
	SinkArn *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// Destination type to which the media artifacts are saved. You must use an
	// S3 bucket.
	//
	// SinkType is a required field
	SinkType *string `type:"string" required:"true" enum:"MediaPipelineSinkType"`

	// ARN of the source from which the media artifacts are captured.
	//
	// SourceArn is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateMediaCapturePipelineInput's
	// String and GoString methods.
	//
	// SourceArn is a required field
	SourceArn *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// Source type from which the media artifacts are captured. A Chime SDK Meeting
	// is the only supported source.
	//
	// SourceType is a required field
	SourceType *string `type:"string" required:"true" enum:"MediaPipelineSourceType"`

	// The list of tags.
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (CreateMediaCapturePipelineInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMediaCapturePipelineInput) SetChimeSdkMeetingConfiguration

SetChimeSdkMeetingConfiguration sets the ChimeSdkMeetingConfiguration field's value.

func (*CreateMediaCapturePipelineInput) SetClientRequestToken

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateMediaCapturePipelineInput) SetSinkArn

SetSinkArn sets the SinkArn field's value.

func (*CreateMediaCapturePipelineInput) SetSinkType

SetSinkType sets the SinkType field's value.

func (*CreateMediaCapturePipelineInput) SetSourceArn

SetSourceArn sets the SourceArn field's value.

func (*CreateMediaCapturePipelineInput) SetSourceType

SetSourceType sets the SourceType field's value.

func (*CreateMediaCapturePipelineInput) SetTags

SetTags sets the Tags field's value.

func (CreateMediaCapturePipelineInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMediaCapturePipelineInput) Validate

func (s *CreateMediaCapturePipelineInput) Validate() error

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

type CreateMediaCapturePipelineOutput

type CreateMediaCapturePipelineOutput struct {

	// A media capture pipeline object, the ID, source type, source ARN, sink type,
	// and sink ARN of a media capture pipeline object.
	MediaCapturePipeline *MediaCapturePipeline `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateMediaCapturePipelineOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMediaCapturePipelineOutput) SetMediaCapturePipeline

SetMediaCapturePipeline sets the MediaCapturePipeline field's value.

func (CreateMediaCapturePipelineOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteMediaCapturePipelineInput

type DeleteMediaCapturePipelineInput struct {

	// The ID of the media capture pipeline being deleted.
	//
	// MediaPipelineId is a required field
	MediaPipelineId *string `location:"uri" locationName:"mediaPipelineId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMediaCapturePipelineInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteMediaCapturePipelineInput) SetMediaPipelineId

SetMediaPipelineId sets the MediaPipelineId field's value.

func (DeleteMediaCapturePipelineInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteMediaCapturePipelineInput) Validate

func (s *DeleteMediaCapturePipelineInput) Validate() error

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

type DeleteMediaCapturePipelineOutput

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

func (DeleteMediaCapturePipelineOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteMediaCapturePipelineOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ForbiddenException

type ForbiddenException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

	Message_ *string `locationName:"Message" type:"string"`

	// The request id associated with the call responsible for the exception.
	RequestId *string `type:"string"`
	// contains filtered or unexported fields
}

The client is permanently forbidden from making the request.

func (*ForbiddenException) Code

func (s *ForbiddenException) Code() string

Code returns the exception type name.

func (*ForbiddenException) Error

func (s *ForbiddenException) Error() string

func (ForbiddenException) GoString

func (s ForbiddenException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ForbiddenException) Message

func (s *ForbiddenException) Message() string

Message returns the exception's message.

func (*ForbiddenException) OrigErr

func (s *ForbiddenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ForbiddenException) RequestID

func (s *ForbiddenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ForbiddenException) StatusCode

func (s *ForbiddenException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ForbiddenException) String

func (s ForbiddenException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetMediaCapturePipelineInput

type GetMediaCapturePipelineInput struct {

	// The ID of the pipeline that you want to get.
	//
	// MediaPipelineId is a required field
	MediaPipelineId *string `location:"uri" locationName:"mediaPipelineId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetMediaCapturePipelineInput) GoString

func (s GetMediaCapturePipelineInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMediaCapturePipelineInput) SetMediaPipelineId

SetMediaPipelineId sets the MediaPipelineId field's value.

func (GetMediaCapturePipelineInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMediaCapturePipelineInput) Validate

func (s *GetMediaCapturePipelineInput) Validate() error

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

type GetMediaCapturePipelineOutput

type GetMediaCapturePipelineOutput struct {

	// The media capture pipeline object.
	MediaCapturePipeline *MediaCapturePipeline `type:"structure"`
	// contains filtered or unexported fields
}

func (GetMediaCapturePipelineOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMediaCapturePipelineOutput) SetMediaCapturePipeline

SetMediaCapturePipeline sets the MediaCapturePipeline field's value.

func (GetMediaCapturePipelineOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListMediaCapturePipelinesInput

type ListMediaCapturePipelinesInput struct {

	// The maximum number of results to return in a single call. Valid Range: 1
	// - 99.
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// The token used to retrieve the next page of results.
	NextToken *string `location:"querystring" locationName:"next-token" type:"string"`
	// contains filtered or unexported fields
}

func (ListMediaCapturePipelinesInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMediaCapturePipelinesInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListMediaCapturePipelinesInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListMediaCapturePipelinesInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMediaCapturePipelinesInput) Validate

func (s *ListMediaCapturePipelinesInput) Validate() error

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

type ListMediaCapturePipelinesOutput

type ListMediaCapturePipelinesOutput struct {

	// The media capture pipeline objects in the list.
	MediaCapturePipelines []*MediaCapturePipelineSummary `type:"list"`

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

func (ListMediaCapturePipelinesOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMediaCapturePipelinesOutput) SetMediaCapturePipelines

SetMediaCapturePipelines sets the MediaCapturePipelines field's value.

func (*ListMediaCapturePipelinesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListMediaCapturePipelinesOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The resource ARN.
	//
	// ResourceARN is a required field
	ResourceARN *string `location:"querystring" locationName:"arn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceARN

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The tag key-value pairs.
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MediaCapturePipeline

type MediaCapturePipeline struct {

	// The configuration for a specified media capture pipeline. SourceType must
	// be ChimeSdkMeeting.
	ChimeSdkMeetingConfiguration *ChimeSdkMeetingConfiguration `type:"structure"`

	// The time at which the capture pipeline was created, in ISO 8601 format.
	CreatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The ARN of a media capture pipeline.
	MediaPipelineArn *string `min:"1" type:"string"`

	// The ID of a media capture pipeline.
	MediaPipelineId *string `min:"36" type:"string"`

	// ARN of the destination to which the media artifacts are saved.
	//
	// SinkArn is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by MediaCapturePipeline's
	// String and GoString methods.
	SinkArn *string `min:"1" type:"string" sensitive:"true"`

	// Destination type to which the media artifacts are saved. You must use an
	// S3 Bucket.
	SinkType *string `type:"string" enum:"MediaPipelineSinkType"`

	// ARN of the source from which the media artifacts are saved.
	//
	// SourceArn is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by MediaCapturePipeline's
	// String and GoString methods.
	SourceArn *string `min:"1" type:"string" sensitive:"true"`

	// Source type from which media artifacts are saved. You must use ChimeMeeting.
	SourceType *string `type:"string" enum:"MediaPipelineSourceType"`

	// The status of the media capture pipeline.
	Status *string `type:"string" enum:"MediaPipelineStatus"`

	// The time at which the capture pipeline was updated, in ISO 8601 format.
	UpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

A media capture pipeline object consisting of an ID, source type, source ARN, a sink type, a sink ARN, and a configuration object.

func (MediaCapturePipeline) GoString

func (s MediaCapturePipeline) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MediaCapturePipeline) SetChimeSdkMeetingConfiguration

func (s *MediaCapturePipeline) SetChimeSdkMeetingConfiguration(v *ChimeSdkMeetingConfiguration) *MediaCapturePipeline

SetChimeSdkMeetingConfiguration sets the ChimeSdkMeetingConfiguration field's value.

func (*MediaCapturePipeline) SetCreatedTimestamp

func (s *MediaCapturePipeline) SetCreatedTimestamp(v time.Time) *MediaCapturePipeline

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*MediaCapturePipeline) SetMediaPipelineArn

func (s *MediaCapturePipeline) SetMediaPipelineArn(v string) *MediaCapturePipeline

SetMediaPipelineArn sets the MediaPipelineArn field's value.

func (*MediaCapturePipeline) SetMediaPipelineId

func (s *MediaCapturePipeline) SetMediaPipelineId(v string) *MediaCapturePipeline

SetMediaPipelineId sets the MediaPipelineId field's value.

func (*MediaCapturePipeline) SetSinkArn

SetSinkArn sets the SinkArn field's value.

func (*MediaCapturePipeline) SetSinkType

SetSinkType sets the SinkType field's value.

func (*MediaCapturePipeline) SetSourceArn

func (s *MediaCapturePipeline) SetSourceArn(v string) *MediaCapturePipeline

SetSourceArn sets the SourceArn field's value.

func (*MediaCapturePipeline) SetSourceType

func (s *MediaCapturePipeline) SetSourceType(v string) *MediaCapturePipeline

SetSourceType sets the SourceType field's value.

func (*MediaCapturePipeline) SetStatus

SetStatus sets the Status field's value.

func (*MediaCapturePipeline) SetUpdatedTimestamp

func (s *MediaCapturePipeline) SetUpdatedTimestamp(v time.Time) *MediaCapturePipeline

SetUpdatedTimestamp sets the UpdatedTimestamp field's value.

func (MediaCapturePipeline) String

func (s MediaCapturePipeline) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MediaCapturePipelineSummary

type MediaCapturePipelineSummary struct {

	// The ARN of a media capture pipeline.
	MediaPipelineArn *string `min:"1" type:"string"`

	// The ID of a media capture pipeline.
	MediaPipelineId *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

A summary of a media capture pipeline.

func (MediaCapturePipelineSummary) GoString

func (s MediaCapturePipelineSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MediaCapturePipelineSummary) SetMediaPipelineArn

SetMediaPipelineArn sets the MediaPipelineArn field's value.

func (*MediaCapturePipelineSummary) SetMediaPipelineId

SetMediaPipelineId sets the MediaPipelineId field's value.

func (MediaCapturePipelineSummary) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NotFoundException

type NotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

	Message_ *string `locationName:"Message" type:"string"`

	// The request id associated with the call responsible for the exception.
	RequestId *string `type:"string"`
	// contains filtered or unexported fields
}

One or more of the resources in the request does not exist in the system.

func (*NotFoundException) Code

func (s *NotFoundException) Code() string

Code returns the exception type name.

func (*NotFoundException) Error

func (s *NotFoundException) Error() string

func (NotFoundException) GoString

func (s NotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotFoundException) Message

func (s *NotFoundException) Message() string

Message returns the exception's message.

func (*NotFoundException) OrigErr

func (s *NotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotFoundException) RequestID

func (s *NotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotFoundException) StatusCode

func (s *NotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NotFoundException) String

func (s NotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceLimitExceededException

type ResourceLimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

	Message_ *string `locationName:"Message" type:"string"`

	// The request id associated with the call responsible for the exception.
	RequestId *string `type:"string"`
	// contains filtered or unexported fields
}

The request exceeds the resource limit.

func (*ResourceLimitExceededException) Code

Code returns the exception type name.

func (*ResourceLimitExceededException) Error

func (ResourceLimitExceededException) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceLimitExceededException) Message

Message returns the exception's message.

func (*ResourceLimitExceededException) OrigErr

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceLimitExceededException) RequestID

func (s *ResourceLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceLimitExceededException) StatusCode

func (s *ResourceLimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceLimitExceededException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SelectedVideoStreams

type SelectedVideoStreams struct {

	// The attendee IDs of the streams selected for a media capture pipeline.
	AttendeeIds []*string `min:"1" type:"list"`

	// The external user IDs of the streams selected for a media capture pipeline.
	ExternalUserIds []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

The video streams to capture for a specified media capture pipeline. The total number of video streams can't exceed 25.

func (SelectedVideoStreams) GoString

func (s SelectedVideoStreams) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SelectedVideoStreams) SetAttendeeIds

func (s *SelectedVideoStreams) SetAttendeeIds(v []*string) *SelectedVideoStreams

SetAttendeeIds sets the AttendeeIds field's value.

func (*SelectedVideoStreams) SetExternalUserIds

func (s *SelectedVideoStreams) SetExternalUserIds(v []*string) *SelectedVideoStreams

SetExternalUserIds sets the ExternalUserIds field's value.

func (SelectedVideoStreams) String

func (s SelectedVideoStreams) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SelectedVideoStreams) Validate

func (s *SelectedVideoStreams) Validate() error

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

type ServiceFailureException

type ServiceFailureException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

	Message_ *string `locationName:"Message" type:"string"`

	// The request id associated with the call responsible for the exception.
	RequestId *string `type:"string"`
	// contains filtered or unexported fields
}

The service encountered an unexpected error.

func (*ServiceFailureException) Code

func (s *ServiceFailureException) Code() string

Code returns the exception type name.

func (*ServiceFailureException) Error

func (s *ServiceFailureException) Error() string

func (ServiceFailureException) GoString

func (s ServiceFailureException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceFailureException) Message

func (s *ServiceFailureException) Message() string

Message returns the exception's message.

func (*ServiceFailureException) OrigErr

func (s *ServiceFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceFailureException) RequestID

func (s *ServiceFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceFailureException) StatusCode

func (s *ServiceFailureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceFailureException) String

func (s ServiceFailureException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceUnavailableException

type ServiceUnavailableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

	Message_ *string `locationName:"Message" type:"string"`

	// The request id associated with the call responsible for the exception.
	RequestId *string `type:"string"`
	// contains filtered or unexported fields
}

The service is currently unavailable.

func (*ServiceUnavailableException) Code

Code returns the exception type name.

func (*ServiceUnavailableException) Error

func (ServiceUnavailableException) GoString

func (s ServiceUnavailableException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceUnavailableException) Message

func (s *ServiceUnavailableException) Message() string

Message returns the exception's message.

func (*ServiceUnavailableException) OrigErr

func (s *ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableException) RequestID

func (s *ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableException) StatusCode

func (s *ServiceUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceUnavailableException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SourceConfiguration

type SourceConfiguration struct {

	// The selected video streams to capture for a specified media capture pipeline.
	// The number of video streams can't exceed 25.
	SelectedVideoStreams *SelectedVideoStreams `type:"structure"`
	// contains filtered or unexported fields
}

Source configuration for a specified media capture pipeline.

func (SourceConfiguration) GoString

func (s SourceConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SourceConfiguration) SetSelectedVideoStreams

func (s *SourceConfiguration) SetSelectedVideoStreams(v *SelectedVideoStreams) *SourceConfiguration

SetSelectedVideoStreams sets the SelectedVideoStreams field's value.

func (SourceConfiguration) String

func (s SourceConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SourceConfiguration) Validate

func (s *SourceConfiguration) Validate() error

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

type Tag

type Tag struct {

	// The key of the tag.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The value of the tag.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes a tag applied to a resource.

func (Tag) GoString

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate

func (s *Tag) Validate() error

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

type TagResourceInput

type TagResourceInput struct {

	// The resource ARN.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// The tag key-value pairs.
	//
	// Tags is a required field
	Tags []*Tag `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceARN

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

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput

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

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottledClientException

type ThrottledClientException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

	Message_ *string `locationName:"Message" type:"string"`

	// The request id associated with the call responsible for the exception.
	RequestId *string `type:"string"`
	// contains filtered or unexported fields
}

The client exceeded its request rate limit.

func (*ThrottledClientException) Code

func (s *ThrottledClientException) Code() string

Code returns the exception type name.

func (*ThrottledClientException) Error

func (s *ThrottledClientException) Error() string

func (ThrottledClientException) GoString

func (s ThrottledClientException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottledClientException) Message

func (s *ThrottledClientException) Message() string

Message returns the exception's message.

func (*ThrottledClientException) OrigErr

func (s *ThrottledClientException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottledClientException) RequestID

func (s *ThrottledClientException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottledClientException) StatusCode

func (s *ThrottledClientException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottledClientException) String

func (s ThrottledClientException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnauthorizedClientException

type UnauthorizedClientException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"`

	Message_ *string `locationName:"Message" type:"string"`

	// The request id associated with the call responsible for the exception.
	RequestId *string `type:"string"`
	// contains filtered or unexported fields
}

The client is not currently authorized to make the request.

func (*UnauthorizedClientException) Code

Code returns the exception type name.

func (*UnauthorizedClientException) Error

func (UnauthorizedClientException) GoString

func (s UnauthorizedClientException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnauthorizedClientException) Message

func (s *UnauthorizedClientException) Message() string

Message returns the exception's message.

func (*UnauthorizedClientException) OrigErr

func (s *UnauthorizedClientException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnauthorizedClientException) RequestID

func (s *UnauthorizedClientException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnauthorizedClientException) StatusCode

func (s *UnauthorizedClientException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnauthorizedClientException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput

type UntagResourceInput struct {

	// The resource ARN.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// The tag keys.
	//
	// TagKeys is a required field
	TagKeys []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceARN

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

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys

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

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput

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

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VideoArtifactsConfiguration

type VideoArtifactsConfiguration struct {

	// The MUX type of the video artifact configuration object.
	MuxType *string `type:"string" enum:"VideoMuxType"`

	// Indicates whether the video artifact is enabled or disabled.
	//
	// State is a required field
	State *string `type:"string" required:"true" enum:"ArtifactsState"`
	// contains filtered or unexported fields
}

The video artifact configuration object.

func (VideoArtifactsConfiguration) GoString

func (s VideoArtifactsConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VideoArtifactsConfiguration) SetMuxType

SetMuxType sets the MuxType field's value.

func (*VideoArtifactsConfiguration) SetState

SetState sets the State field's value.

func (VideoArtifactsConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VideoArtifactsConfiguration) Validate

func (s *VideoArtifactsConfiguration) Validate() error

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

Directories

Path Synopsis
Package chimesdkmediapipelinesiface provides an interface to enable mocking the Amazon Chime SDK Media Pipelines service client for testing your code.
Package chimesdkmediapipelinesiface provides an interface to enable mocking the Amazon Chime SDK Media Pipelines service client for testing your code.

Jump to

Keyboard shortcuts

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