package types

import "github.com/aws/aws-sdk-go-v2/service/mediaconnect/types"

Index

Types

type AddFlowOutputs420Exception

type AddFlowOutputs420Exception struct {
	Message *string
}

Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.

func (*AddFlowOutputs420Exception) Error

func (*AddFlowOutputs420Exception) ErrorCode

func (e *AddFlowOutputs420Exception) ErrorCode() string

func (*AddFlowOutputs420Exception) ErrorFault

func (*AddFlowOutputs420Exception) ErrorMessage

func (e *AddFlowOutputs420Exception) ErrorMessage() string

type AddOutputRequest

type AddOutputRequest struct {

	// A description of the output. This description appears only on the AWS Elemental
	// MediaConnect console and will not be seen by the end user.
	Description *string

	// The type of key used for the encryption. If no keyType is provided, the service
	// will use the default setting (static-key).
	Encryption *Encryption

	// The name of the VPC interface attachment to use for this output.
	VpcInterfaceAttachment *VpcInterfaceAttachment

	// The remote ID for the Zixi-pull output stream.
	RemoteId *string

	// The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
	SmoothingLatency *int32

	// The stream ID that you want to use for this transport. This parameter applies
	// only to Zixi-based streams.
	StreamId *string

	// The port to use when content is distributed to this output.
	Port *int32

	// The protocol to use for the output.
	//
	// This member is required.
	Protocol Protocol

	// The IP address from which video will be sent to output destinations.
	Destination *string

	// The name of the output. This value must be unique within the current flow.
	Name *string

	// The maximum latency in milliseconds for Zixi-based streams.
	MaxLatency *int32

	// The range of IP addresses that should be allowed to initiate output requests to
	// this flow. These IP addresses should be in the form of a Classless Inter-Domain
	// Routing (CIDR) block; for example, 10.0.0.0/16.
	CidrAllowList []*string
}

The output that you want to add to this flow.

type Algorithm

type Algorithm string
const (
	AlgorithmAes128 Algorithm = "aes128"
	AlgorithmAes192 Algorithm = "aes192"
	AlgorithmAes256 Algorithm = "aes256"
)

Enum values for Algorithm

type BadRequestException

type BadRequestException struct {
	Message *string
}

Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.

func (*BadRequestException) Error

func (e *BadRequestException) Error() string

func (*BadRequestException) ErrorCode

func (e *BadRequestException) ErrorCode() string

func (*BadRequestException) ErrorFault

func (e *BadRequestException) ErrorFault() smithy.ErrorFault

func (*BadRequestException) ErrorMessage

func (e *BadRequestException) ErrorMessage() string

type CreateFlow420Exception

type CreateFlow420Exception struct {
	Message *string
}

Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.

func (*CreateFlow420Exception) Error

func (e *CreateFlow420Exception) Error() string

func (*CreateFlow420Exception) ErrorCode

func (e *CreateFlow420Exception) ErrorCode() string

func (*CreateFlow420Exception) ErrorFault

func (e *CreateFlow420Exception) ErrorFault() smithy.ErrorFault

func (*CreateFlow420Exception) ErrorMessage

func (e *CreateFlow420Exception) ErrorMessage() string

type Encryption

type Encryption struct {

	// The ARN of the secret that you created in AWS Secrets Manager to store the
	// encryption key. This parameter is required for static key encryption and is not
	// valid for SPEKE encryption.
	SecretArn *string

	// The type of key that is used for the encryption. If no keyType is provided, the
	// service will use the default setting (static-key).
	KeyType KeyType

	// An identifier for the content. The service sends this value to the key server to
	// identify the current endpoint. The resource ID is also known as the content ID.
	// This parameter is required for SPEKE encryption and is not valid for static key
	// encryption.
	ResourceId *string

	// The value of one of the devices that you configured with your digital rights
	// management (DRM) platform key provider. This parameter is required for SPEKE
	// encryption and is not valid for static key encryption.
	DeviceId *string

	// The AWS Region that the API Gateway proxy endpoint was created in. This
	// parameter is required for SPEKE encryption and is not valid for static key
	// encryption.
	Region *string

	// A 128-bit, 16-byte hex value represented by a 32-character string, to be used
	// with the key for encrypting content. This parameter is not valid for static key
	// encryption.
	ConstantInitializationVector *string

	// The type of algorithm that is used for the encryption (such as aes128, aes192,
	// or aes256).
	//
	// This member is required.
	Algorithm Algorithm

	// The ARN of the role that you created during setup (when you set up AWS Elemental
	// MediaConnect as a trusted entity).
	//
	// This member is required.
	RoleArn *string

	// The URL from the API Gateway proxy that you set up to talk to your key server.
	// This parameter is required for SPEKE encryption and is not valid for static key
	// encryption.
	Url *string
}

Information about the encryption of the flow.

type Entitlement

type Entitlement struct {

	// An indication of whether the entitlement is enabled.
	EntitlementStatus EntitlementStatus

	// The ARN of the entitlement.
	//
	// This member is required.
	EntitlementArn *string

	// The AWS account IDs that you want to share your content with. The receiving
	// accounts (subscribers) will be allowed to create their own flow using your
	// content as the source.
	//
	// This member is required.
	Subscribers []*string

	// The name of the entitlement.
	//
	// This member is required.
	Name *string

	// The type of encryption that will be used on the output that is associated with
	// this entitlement.
	Encryption *Encryption

	// A description of the entitlement.
	Description *string

	// Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
	DataTransferSubscriberFeePercent *int32
}

The settings for a flow entitlement.

type EntitlementStatus

type EntitlementStatus string
const (
	EntitlementStatusEnabled  EntitlementStatus = "ENABLED"
	EntitlementStatusDisabled EntitlementStatus = "DISABLED"
)

Enum values for EntitlementStatus

type FailoverConfig

type FailoverConfig struct {
	State State

	// Search window time to look for dash-7 packets
	RecoveryWindow *int32
}

The settings for source failover

type Flow

type Flow struct {

	// The settings for the source of the flow.
	//
	// This member is required.
	Source *Source

	// The name of the flow.
	//
	// This member is required.
	Name *string

	// The entitlements in this flow.
	//
	// This member is required.
	Entitlements []*Entitlement

	Sources []*Source

	// The VPC Interfaces for this flow.
	VpcInterfaces []*VpcInterface

	// The IP address from which video will be sent to output destinations.
	EgressIp *string

	// The settings for source failover
	SourceFailoverConfig *FailoverConfig

	// The outputs in this flow.
	//
	// This member is required.
	Outputs []*Output

	// A description of the flow. This value is not used or seen outside of the current
	// AWS Elemental MediaConnect account.
	Description *string

	// The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the
	// flow.
	//
	// This member is required.
	FlowArn *string

	// The Availability Zone that you want to create the flow in. These options are
	// limited to the Availability Zones within the current AWS.
	//
	// This member is required.
	AvailabilityZone *string

	// The current status of the flow.
	//
	// This member is required.
	Status Status
}

The settings for a flow, including its source, outputs, and entitlements.

type ForbiddenException

type ForbiddenException struct {
	Message *string
}

Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.

func (*ForbiddenException) Error

func (e *ForbiddenException) Error() string

func (*ForbiddenException) ErrorCode

func (e *ForbiddenException) ErrorCode() string

func (*ForbiddenException) ErrorFault

func (e *ForbiddenException) ErrorFault() smithy.ErrorFault

func (*ForbiddenException) ErrorMessage

func (e *ForbiddenException) ErrorMessage() string

type GrantEntitlementRequest

type GrantEntitlementRequest struct {

	// The name of the entitlement. This value must be unique within the current flow.
	Name *string

	// The type of encryption that will be used on the output that is associated with
	// this entitlement.
	Encryption *Encryption

	// Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
	DataTransferSubscriberFeePercent *int32

	// A description of the entitlement. This description appears only on the AWS
	// Elemental MediaConnect console and will not be seen by the subscriber or end
	// user.
	Description *string

	// An indication of whether the new entitlement should be enabled or disabled as
	// soon as it is created. If you don’t specify the entitlementStatus field in your
	// request, MediaConnect sets it to ENABLED.
	EntitlementStatus EntitlementStatus

	// The AWS account IDs that you want to share your content with. The receiving
	// accounts (subscribers) will be allowed to create their own flows using your
	// content as the source.
	//
	// This member is required.
	Subscribers []*string
}

The entitlements that you want to grant on a flow.

type GrantFlowEntitlements420Exception

type GrantFlowEntitlements420Exception struct {
	Message *string
}

Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.

func (*GrantFlowEntitlements420Exception) Error

func (*GrantFlowEntitlements420Exception) ErrorCode

func (*GrantFlowEntitlements420Exception) ErrorFault

func (*GrantFlowEntitlements420Exception) ErrorMessage

func (e *GrantFlowEntitlements420Exception) ErrorMessage() string

type InternalServerErrorException

type InternalServerErrorException struct {
	Message *string
}

Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.

func (*InternalServerErrorException) Error

func (*InternalServerErrorException) ErrorCode

func (e *InternalServerErrorException) ErrorCode() string

func (*InternalServerErrorException) ErrorFault

func (*InternalServerErrorException) ErrorMessage

func (e *InternalServerErrorException) ErrorMessage() string

type KeyType

type KeyType string
const (
	KeyTypeSpeke      KeyType = "speke"
	KeyTypeStatic_key KeyType = "static-key"
)

Enum values for KeyType

type ListedEntitlement

type ListedEntitlement struct {

	// The name of the entitlement.
	//
	// This member is required.
	EntitlementName *string

	// The ARN of the entitlement.
	//
	// This member is required.
	EntitlementArn *string

	// Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
	DataTransferSubscriberFeePercent *int32
}

An entitlement that has been granted to you from other AWS accounts.

type ListedFlow

type ListedFlow struct {

	// The Availability Zone that the flow was created in.
	//
	// This member is required.
	AvailabilityZone *string

	// A description of the flow.
	//
	// This member is required.
	Description *string

	// The ARN of the flow.
	//
	// This member is required.
	FlowArn *string

	// The name of the flow.
	//
	// This member is required.
	Name *string

	// The current status of the flow.
	//
	// This member is required.
	Status Status

	// The type of source. This value is either owned (originated somewhere other than
	// an AWS Elemental MediaConnect flow owned by another AWS account) or entitled
	// (originated at an AWS Elemental MediaConnect flow owned by another AWS account).
	//
	// This member is required.
	SourceType SourceType
}

Provides a summary of a flow, including its ARN, Availability Zone, and source type.

type Messages

type Messages struct {

	// A list of errors that might have been generated from processes on this flow.
	//
	// This member is required.
	Errors []*string
}

Messages that provide the state of the flow.

type NotFoundException

type NotFoundException struct {
	Message *string
}

Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.

func (*NotFoundException) Error

func (e *NotFoundException) Error() string

func (*NotFoundException) ErrorCode

func (e *NotFoundException) ErrorCode() string

func (*NotFoundException) ErrorFault

func (e *NotFoundException) ErrorFault() smithy.ErrorFault

func (*NotFoundException) ErrorMessage

func (e *NotFoundException) ErrorMessage() string

type Output

type Output struct {

	// The address where you want to send the output.
	Destination *string

	// The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant
	// only for outputs that were added by creating a MediaLive input.
	MediaLiveInputArn *string

	// Attributes related to the transport stream that are used in the output.
	Transport *Transport

	// The ARN of the output.
	//
	// This member is required.
	OutputArn *string

	// The type of key used for the encryption. If no keyType is provided, the service
	// will use the default setting (static-key).
	Encryption *Encryption

	// The name of the VPC interface attachment to use for this output.
	VpcInterfaceAttachment *VpcInterfaceAttachment

	// A description of the output.
	Description *string

	// Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
	DataTransferSubscriberFeePercent *int32

	// The name of the output. This value must be unique within the current flow.
	//
	// This member is required.
	Name *string

	// The port to use when content is distributed to this output.
	Port *int32

	// The ARN of the entitlement on the originator''s flow. This value is relevant
	// only on entitled flows.
	EntitlementArn *string
}

The settings for an output.

type Protocol

type Protocol string
const (
	ProtocolZixi_push Protocol = "zixi-push"
	ProtocolRtp_fec   Protocol = "rtp-fec"
	ProtocolRtp       Protocol = "rtp"
	ProtocolZixi_pull Protocol = "zixi-pull"
	ProtocolRist      Protocol = "rist"
)

Enum values for Protocol

type ServiceUnavailableException

type ServiceUnavailableException struct {
	Message *string
}

Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.

func (*ServiceUnavailableException) Error

func (*ServiceUnavailableException) ErrorCode

func (e *ServiceUnavailableException) ErrorCode() string

func (*ServiceUnavailableException) ErrorFault

func (*ServiceUnavailableException) ErrorMessage

func (e *ServiceUnavailableException) ErrorMessage() string

type SetSourceRequest

type SetSourceRequest struct {

	// The name of the VPC interface to use for this source.
	VpcInterfaceName *string

	// The port that the flow will be listening on for incoming content.
	IngestPort *int32

	// The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
	MaxBitrate *int32

	// The ARN of the entitlement that allows you to subscribe to this flow. The
	// entitlement is set by the flow originator, and the ARN is generated as part of
	// the originator's flow.
	EntitlementArn *string

	// The maximum latency in milliseconds. This parameter applies only to RIST-based
	// and Zixi-based streams.
	MaxLatency *int32

	// The range of IP addresses that should be allowed to contribute content to your
	// source. These IP addresses should be in the form of a Classless Inter-Domain
	// Routing (CIDR) block; for example, 10.0.0.0/16.
	WhitelistCidr *string

	// The name of the source.
	Name *string

	// The stream ID that you want to use for this transport. This parameter applies
	// only to Zixi-based streams.
	StreamId *string

	// The type of encryption that is used on the content ingested from this source.
	Decryption *Encryption

	// The protocol that is used by the source.
	Protocol Protocol

	// A description for the source. This value is not used or seen outside of the
	// current AWS Elemental MediaConnect account.
	Description *string
}

The settings for the source of the flow.

type Source

type Source struct {

	// The ARN of the source.
	//
	// This member is required.
	SourceArn *string

	// The name of the source.
	//
	// This member is required.
	Name *string

	// Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
	DataTransferSubscriberFeePercent *int32

	// The range of IP addresses that should be allowed to contribute content to your
	// source. These IP addresses should be in the form of a Classless Inter-Domain
	// Routing (CIDR) block; for example, 10.0.0.0/16.
	WhitelistCidr *string

	// A description for the source. This value is not used or seen outside of the
	// current AWS Elemental MediaConnect account.
	Description *string

	// The name of the VPC Interface this Source is configured with.
	VpcInterfaceName *string

	// Attributes related to the transport stream that are used in the source.
	Transport *Transport

	// The type of encryption that is used on the content ingested from this source.
	Decryption *Encryption

	// The ARN of the entitlement that allows you to subscribe to content that comes
	// from another AWS account. The entitlement is set by the content originator and
	// the ARN is generated as part of the originator's flow.
	EntitlementArn *string

	// The port that the flow will be listening on for incoming content.
	IngestPort *int32

	// The IP address that the flow will be listening on for incoming content.
	IngestIp *string
}

The settings for the source of the flow.

type SourceType

type SourceType string
const (
	SourceTypeOwned    SourceType = "OWNED"
	SourceTypeEntitled SourceType = "ENTITLED"
)

Enum values for SourceType

type State

type State string
const (
	StateEnabled  State = "ENABLED"
	StateDisabled State = "DISABLED"
)

Enum values for State

type Status

type Status string
const (
	StatusStandby  Status = "STANDBY"
	StatusActive   Status = "ACTIVE"
	StatusUpdating Status = "UPDATING"
	StatusDeleting Status = "DELETING"
	StatusStarting Status = "STARTING"
	StatusStopping Status = "STOPPING"
	StatusError    Status = "ERROR"
)

Enum values for Status

type TooManyRequestsException

type TooManyRequestsException struct {
	Message *string
}

Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.

func (*TooManyRequestsException) Error

func (e *TooManyRequestsException) Error() string

func (*TooManyRequestsException) ErrorCode

func (e *TooManyRequestsException) ErrorCode() string

func (*TooManyRequestsException) ErrorFault

func (e *TooManyRequestsException) ErrorFault() smithy.ErrorFault

func (*TooManyRequestsException) ErrorMessage

func (e *TooManyRequestsException) ErrorMessage() string

type Transport

type Transport struct {

	// The remote ID for the Zixi-pull stream.
	RemoteId *string

	// The range of IP addresses that should be allowed to initiate output requests to
	// this flow. These IP addresses should be in the form of a Classless Inter-Domain
	// Routing (CIDR) block; for example, 10.0.0.0/16.
	CidrAllowList []*string

	// The maximum latency in milliseconds. This parameter applies only to RIST-based
	// and Zixi-based streams.
	MaxLatency *int32

	// The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
	SmoothingLatency *int32

	// The stream ID that you want to use for this transport. This parameter applies
	// only to Zixi-based streams.
	StreamId *string

	// The protocol that is used by the source or output.
	//
	// This member is required.
	Protocol Protocol

	// The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
	MaxBitrate *int32
}

Attributes related to the transport stream that are used in a source or output.

type UpdateEncryption

type UpdateEncryption struct {

	// The AWS Region that the API Gateway proxy endpoint was created in. This
	// parameter is required for SPEKE encryption and is not valid for static key
	// encryption.
	Region *string

	// The ARN of the role that you created during setup (when you set up AWS Elemental
	// MediaConnect as a trusted entity).
	RoleArn *string

	// The URL from the API Gateway proxy that you set up to talk to your key server.
	// This parameter is required for SPEKE encryption and is not valid for static key
	// encryption.
	Url *string

	// The type of algorithm that is used for the encryption (such as aes128, aes192,
	// or aes256).
	Algorithm Algorithm

	// The type of key that is used for the encryption. If no keyType is provided, the
	// service will use the default setting (static-key).
	KeyType KeyType

	// The value of one of the devices that you configured with your digital rights
	// management (DRM) platform key provider. This parameter is required for SPEKE
	// encryption and is not valid for static key encryption.
	DeviceId *string

	// A 128-bit, 16-byte hex value represented by a 32-character string, to be used
	// with the key for encrypting content. This parameter is not valid for static key
	// encryption.
	ConstantInitializationVector *string

	// An identifier for the content. The service sends this value to the key server to
	// identify the current endpoint. The resource ID is also known as the content ID.
	// This parameter is required for SPEKE encryption and is not valid for static key
	// encryption.
	ResourceId *string

	// The ARN of the secret that you created in AWS Secrets Manager to store the
	// encryption key. This parameter is required for static key encryption and is not
	// valid for SPEKE encryption.
	SecretArn *string
}

Information about the encryption of the flow.

type UpdateFailoverConfig

type UpdateFailoverConfig struct {
	State State

	// Recovery window time to look for dash-7 packets
	RecoveryWindow *int32
}

The settings for source failover

type VpcInterface

type VpcInterface struct {

	// Immutable and has to be a unique against other VpcInterfaces in this Flow
	//
	// This member is required.
	Name *string

	// IDs of the network interfaces created in customer's account by MediaConnect.
	//
	// This member is required.
	NetworkInterfaceIds []*string

	// Security Group IDs to be used on ENI.
	//
	// This member is required.
	SecurityGroupIds []*string

	// Subnet must be in the AZ of the Flow
	//
	// This member is required.
	SubnetId *string

	// Role Arn MediaConnect can assumes to create ENIs in customer's account
	//
	// This member is required.
	RoleArn *string
}

The settings for a VPC Source.

type VpcInterfaceAttachment

type VpcInterfaceAttachment struct {

	// The name of the VPC interface to use for this output.
	VpcInterfaceName *string
}

The settings for attaching a VPC interface to an output.

type VpcInterfaceRequest

type VpcInterfaceRequest struct {

	// Subnet must be in the AZ of the Flow
	//
	// This member is required.
	SubnetId *string

	// Security Group IDs to be used on ENI.
	//
	// This member is required.
	SecurityGroupIds []*string

	// Role Arn MediaConnect can assumes to create ENIs in customer's account
	//
	// This member is required.
	RoleArn *string

	// The name of the VPC Interface. This value must be unique within the current
	// flow.
	//
	// This member is required.
	Name *string
}

Desired VPC Interface for a Flow

Source Files

enums.go errors.go types.go

Version
v0.26.0
Published
Oct 1, 2020
Platform
js/wasm
Imports
2 packages
Last checked
3 hours ago

Tools for package owners.