mediaconnect

package
v0.14.0 Latest Latest
Warning

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

 Go to latest Published: Oct 8, 2019 License: Apache-2.0 Imports: 7 Imported by: 10

Documentation

Overview

Package mediaconnect provides the client and types for making API requests to AWS MediaConnect.

API for AWS Elemental MediaConnect

See https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14 for more information on this service.

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

Using the Client

To use AWS MediaConnect 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 AWS MediaConnect client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/mediaconnect/#New

Index

Constants

View Source 
const (
	ServiceName = "AWS MediaConnect" // Service's name
	ServiceID   = "MediaConnect"     // Service's identifier
	EndpointsID = "mediaconnect"     // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeAddFlowOutputs420Exception for service response error code
	// "AddFlowOutputs420Exception".
	//
	// Exception raised by AWS Elemental MediaConnect. See the error message and
	// documentation for the operation for more information on the cause of this
	// exception.
	ErrCodeAddFlowOutputs420Exception = "AddFlowOutputs420Exception"

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// Exception raised by AWS Elemental MediaConnect. See the error message and
	// documentation for the operation for more information on the cause of this
	// exception.
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeCreateFlow420Exception for service response error code
	// "CreateFlow420Exception".
	//
	// Exception raised by AWS Elemental MediaConnect. See the error message and
	// documentation for the operation for more information on the cause of this
	// exception.
	ErrCodeCreateFlow420Exception = "CreateFlow420Exception"

	// ErrCodeForbiddenException for service response error code
	// "ForbiddenException".
	//
	// Exception raised by AWS Elemental MediaConnect. See the error message and
	// documentation for the operation for more information on the cause of this
	// exception.
	ErrCodeForbiddenException = "ForbiddenException"

	// ErrCodeGrantFlowEntitlements420Exception for service response error code
	// "GrantFlowEntitlements420Exception".
	//
	// Exception raised by AWS Elemental MediaConnect. See the error message and
	// documentation for the operation for more information on the cause of this
	// exception.
	ErrCodeGrantFlowEntitlements420Exception = "GrantFlowEntitlements420Exception"

	// ErrCodeInternalServerErrorException for service response error code
	// "InternalServerErrorException".
	//
	// Exception raised by AWS Elemental MediaConnect. See the error message and
	// documentation for the operation for more information on the cause of this
	// exception.
	ErrCodeInternalServerErrorException = "InternalServerErrorException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// Exception raised by AWS Elemental MediaConnect. See the error message and
	// documentation for the operation for more information on the cause of this
	// exception.
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// Exception raised by AWS Elemental MediaConnect. See the error message and
	// documentation for the operation for more information on the cause of this
	// exception.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	//
	// Exception raised by AWS Elemental MediaConnect. See the error message and
	// documentation for the operation for more information on the cause of this
	// exception.
	ErrCodeTooManyRequestsException = "TooManyRequestsException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AddFlowOutputsInput 

type AddFlowOutputsInput struct {

	// FlowArn is a required field
	FlowArn *string `location:"uri" locationName:"flowArn" type:"string" required:"true"`

	// A list of outputs that you want to add.
	//
	// Outputs is a required field
	Outputs []AddOutputRequest `locationName:"outputs" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Adds outputs to an existing flow. You can create up to 20 outputs per flow.

func (AddFlowOutputsInput) MarshalFields 

func (s AddFlowOutputsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AddFlowOutputsInput) String 

func (s AddFlowOutputsInput) String() string

String returns the string representation

func (*AddFlowOutputsInput) Validate 

func (s *AddFlowOutputsInput) Validate() error

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

type AddFlowOutputsOutput 

type AddFlowOutputsOutput struct {

	// The ARN of the flow that these outputs were added to.
	FlowArn *string `locationName:"flowArn" type:"string"`

	// The details of the newly added outputs.
	Outputs []Output `locationName:"outputs" type:"list"`
	// contains filtered or unexported fields
}

The result of a successful AddOutput request. The response includes the details of the newly added outputs.

func (AddFlowOutputsOutput) MarshalFields 

func (s AddFlowOutputsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AddFlowOutputsOutput) String 

func (s AddFlowOutputsOutput) String() string

String returns the string representation

type AddFlowOutputsRequest 

type AddFlowOutputsRequest struct {
	*aws.Request
	Input *AddFlowOutputsInput
	Copy  func(*AddFlowOutputsInput) AddFlowOutputsRequest
}

AddFlowOutputsRequest is the request type for the AddFlowOutputs API operation.

func (AddFlowOutputsRequest) Send 

func (r AddFlowOutputsRequest) Send(ctx context.Context) (*AddFlowOutputsResponse, error)

Send marshals and sends the AddFlowOutputs API request.

type AddFlowOutputsResponse added in v0.9.0 

type AddFlowOutputsResponse struct {
	*AddFlowOutputsOutput
	// contains filtered or unexported fields
}

AddFlowOutputsResponse is the response type for the AddFlowOutputs API operation.

func (*AddFlowOutputsResponse) SDKResponseMetdata added in v0.9.0 

func (r *AddFlowOutputsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AddFlowOutputs request.

type AddOutputRequest 

type AddOutputRequest struct {

	// 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 `locationName:"cidrAllowList" type:"list"`

	// 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 `locationName:"description" type:"string"`

	// The IP address from which video will be sent to output destinations.
	Destination *string `locationName:"destination" type:"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 `locationName:"encryption" type:"structure"`

	// The maximum latency in milliseconds for Zixi-based streams.
	MaxLatency *int64 `locationName:"maxLatency" type:"integer"`

	// The name of the output. This value must be unique within the current flow.
	Name *string `locationName:"name" type:"string"`

	// The port to use when content is distributed to this output.
	Port *int64 `locationName:"port" type:"integer"`

	// The protocol to use for the output.
	//
	// Protocol is a required field
	Protocol Protocol `locationName:"protocol" type:"string" required:"true" enum:"true"`

	// The remote ID for the Zixi-pull output stream.
	RemoteId *string `locationName:"remoteId" type:"string"`

	// The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
	SmoothingLatency *int64 `locationName:"smoothingLatency" type:"integer"`

	// The stream ID that you want to use for this transport. This parameter applies
	// only to Zixi-based streams.
	StreamId *string `locationName:"streamId" type:"string"`
	// contains filtered or unexported fields
}

The output that you want to add to this flow.

func (AddOutputRequest) MarshalFields 

func (s AddOutputRequest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AddOutputRequest) String 

func (s AddOutputRequest) String() string

String returns the string representation

func (*AddOutputRequest) Validate 

func (s *AddOutputRequest) Validate() error

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

type Algorithm 

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

Enum values for Algorithm

func (Algorithm) MarshalValue 

func (enum Algorithm) MarshalValue() (string, error)

func (Algorithm) MarshalValueBuf 

func (enum Algorithm) MarshalValueBuf(b []byte) ([]byte, error)

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to AWS MediaConnect. See this package's package overview docs for details on the service.

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

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := mediaconnect.New(myConfig)

func (*Client) AddFlowOutputsRequest added in v0.9.0 

func (c *Client) AddFlowOutputsRequest(input *AddFlowOutputsInput) AddFlowOutputsRequest

AddFlowOutputsRequest returns a request value for making API operation for AWS MediaConnect.

Adds outputs to an existing flow. You can create up to 20 outputs per flow. 

// Example sending a request using AddFlowOutputsRequest.
req := client.AddFlowOutputsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/AddFlowOutputs

func (*Client) CreateFlowRequest added in v0.9.0 

func (c *Client) CreateFlowRequest(input *CreateFlowInput) CreateFlowRequest

CreateFlowRequest returns a request value for making API operation for AWS MediaConnect.

Creates a new flow. The request must include one source. The request optionally can include outputs (up to 20) and entitlements (up to 50). 

// Example sending a request using CreateFlowRequest.
req := client.CreateFlowRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/CreateFlow

func (*Client) DeleteFlowRequest added in v0.9.0 

func (c *Client) DeleteFlowRequest(input *DeleteFlowInput) DeleteFlowRequest

DeleteFlowRequest returns a request value for making API operation for AWS MediaConnect.

Deletes a flow. Before you can delete a flow, you must stop the flow. 

// Example sending a request using DeleteFlowRequest.
req := client.DeleteFlowRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/DeleteFlow

func (*Client) DescribeFlowRequest added in v0.9.0 

func (c *Client) DescribeFlowRequest(input *DescribeFlowInput) DescribeFlowRequest

DescribeFlowRequest returns a request value for making API operation for AWS MediaConnect.

Displays the details of a flow. The response includes the flow ARN, name, and Availability Zone, as well as details about the source, outputs, and entitlements. 

// Example sending a request using DescribeFlowRequest.
req := client.DescribeFlowRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/DescribeFlow

func (*Client) GrantFlowEntitlementsRequest added in v0.9.0 

func (c *Client) GrantFlowEntitlementsRequest(input *GrantFlowEntitlementsInput) GrantFlowEntitlementsRequest

GrantFlowEntitlementsRequest returns a request value for making API operation for AWS MediaConnect.

Grants entitlements to an existing flow. 

// Example sending a request using GrantFlowEntitlementsRequest.
req := client.GrantFlowEntitlementsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/GrantFlowEntitlements

func (*Client) ListEntitlementsRequest added in v0.9.0 

func (c *Client) ListEntitlementsRequest(input *ListEntitlementsInput) ListEntitlementsRequest

ListEntitlementsRequest returns a request value for making API operation for AWS MediaConnect.

Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page. 

// Example sending a request using ListEntitlementsRequest.
req := client.ListEntitlementsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/ListEntitlements

func (*Client) ListFlowsRequest added in v0.9.0 

func (c *Client) ListFlowsRequest(input *ListFlowsInput) ListFlowsRequest

ListFlowsRequest returns a request value for making API operation for AWS MediaConnect.

Displays a list of flows that are associated with this account. This request returns a paginated result. 

// Example sending a request using ListFlowsRequest.
req := client.ListFlowsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/ListFlows

func (*Client) ListTagsForResourceRequest added in v0.9.0 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for AWS MediaConnect.

List all tags on an AWS Elemental MediaConnect resource 

// Example sending a request using ListTagsForResourceRequest.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/ListTagsForResource

func (*Client) RemoveFlowOutputRequest added in v0.9.0 

func (c *Client) RemoveFlowOutputRequest(input *RemoveFlowOutputInput) RemoveFlowOutputRequest

RemoveFlowOutputRequest returns a request value for making API operation for AWS MediaConnect.

Removes an output from an existing flow. This request can be made only on an output that does not have an entitlement associated with it. If the output has an entitlement, you must revoke the entitlement instead. When an entitlement is revoked from a flow, the service automatically removes the associated output. 

// Example sending a request using RemoveFlowOutputRequest.
req := client.RemoveFlowOutputRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/RemoveFlowOutput

func (*Client) RevokeFlowEntitlementRequest added in v0.9.0 

func (c *Client) RevokeFlowEntitlementRequest(input *RevokeFlowEntitlementInput) RevokeFlowEntitlementRequest

RevokeFlowEntitlementRequest returns a request value for making API operation for AWS MediaConnect.

Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed. 

// Example sending a request using RevokeFlowEntitlementRequest.
req := client.RevokeFlowEntitlementRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/RevokeFlowEntitlement

func (*Client) StartFlowRequest added in v0.9.0 

func (c *Client) StartFlowRequest(input *StartFlowInput) StartFlowRequest

StartFlowRequest returns a request value for making API operation for AWS MediaConnect.

Starts a flow. 

// Example sending a request using StartFlowRequest.
req := client.StartFlowRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/StartFlow

func (*Client) StopFlowRequest added in v0.9.0 

func (c *Client) StopFlowRequest(input *StopFlowInput) StopFlowRequest

StopFlowRequest returns a request value for making API operation for AWS MediaConnect.

Stops a flow. 

// Example sending a request using StopFlowRequest.
req := client.StopFlowRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/StopFlow

func (*Client) TagResourceRequest added in v0.9.0 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for AWS MediaConnect.

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. 

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/TagResource

func (*Client) UntagResourceRequest added in v0.9.0 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for AWS MediaConnect.

Deletes specified tags from a resource. 

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/UntagResource

func (*Client) UpdateFlowEntitlementRequest added in v0.9.0 

func (c *Client) UpdateFlowEntitlementRequest(input *UpdateFlowEntitlementInput) UpdateFlowEntitlementRequest

UpdateFlowEntitlementRequest returns a request value for making API operation for AWS MediaConnect.

You can change an entitlement's description, subscribers, and encryption. If you change the subscribers, the service will remove the outputs that are are used by the subscribers that are removed. 

// Example sending a request using UpdateFlowEntitlementRequest.
req := client.UpdateFlowEntitlementRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/UpdateFlowEntitlement

func (*Client) UpdateFlowOutputRequest added in v0.9.0 

func (c *Client) UpdateFlowOutputRequest(input *UpdateFlowOutputInput) UpdateFlowOutputRequest

UpdateFlowOutputRequest returns a request value for making API operation for AWS MediaConnect.

Updates an existing flow output. 

// Example sending a request using UpdateFlowOutputRequest.
req := client.UpdateFlowOutputRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/UpdateFlowOutput

func (*Client) UpdateFlowSourceRequest added in v0.9.0 

func (c *Client) UpdateFlowSourceRequest(input *UpdateFlowSourceInput) UpdateFlowSourceRequest

UpdateFlowSourceRequest returns a request value for making API operation for AWS MediaConnect.

Updates the source of a flow. 

// Example sending a request using UpdateFlowSourceRequest.
req := client.UpdateFlowSourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/UpdateFlowSource

type CreateFlowInput 

type CreateFlowInput struct {

	// The Availability Zone that you want to create the flow in. These options
	// are limited to the Availability Zones within the current AWS Region.
	AvailabilityZone *string `locationName:"availabilityZone" type:"string"`

	// The entitlements that you want to grant on a flow.
	Entitlements []GrantEntitlementRequest `locationName:"entitlements" type:"list"`

	// The name of the flow.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The outputs that you want to add to this flow.
	Outputs []AddOutputRequest `locationName:"outputs" type:"list"`

	// The settings for the source of the flow.
	//
	// Source is a required field
	Source *SetSourceRequest `locationName:"source" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Creates a new flow. The request must include one source. The request optionally can include outputs (up to 20) and one entitlement.

func (CreateFlowInput) MarshalFields 

func (s CreateFlowInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateFlowInput) String 

func (s CreateFlowInput) String() string

String returns the string representation

func (*CreateFlowInput) Validate 

func (s *CreateFlowInput) Validate() error

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

type CreateFlowOutput 

type CreateFlowOutput struct {

	// The settings for a flow, including its source, outputs, and entitlements.
	Flow *Flow `locationName:"flow" type:"structure"`
	// contains filtered or unexported fields
}

The result of a successful CreateFlow request.

func (CreateFlowOutput) MarshalFields 

func (s CreateFlowOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateFlowOutput) String 

func (s CreateFlowOutput) String() string

String returns the string representation

type CreateFlowRequest 

type CreateFlowRequest struct {
	*aws.Request
	Input *CreateFlowInput
	Copy  func(*CreateFlowInput) CreateFlowRequest
}

CreateFlowRequest is the request type for the CreateFlow API operation.

func (CreateFlowRequest) Send 

func (r CreateFlowRequest) Send(ctx context.Context) (*CreateFlowResponse, error)

Send marshals and sends the CreateFlow API request.

type CreateFlowResponse added in v0.9.0 

type CreateFlowResponse struct {
	*CreateFlowOutput
	// contains filtered or unexported fields
}

CreateFlowResponse is the response type for the CreateFlow API operation.

func (*CreateFlowResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateFlowResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateFlow request.

type DeleteFlowInput 

type DeleteFlowInput struct {

	// FlowArn is a required field
	FlowArn *string `location:"uri" locationName:"flowArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFlowInput) MarshalFields 

func (s DeleteFlowInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteFlowInput) String 

func (s DeleteFlowInput) String() string

String returns the string representation

func (*DeleteFlowInput) Validate 

func (s *DeleteFlowInput) Validate() error

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

type DeleteFlowOutput 

type DeleteFlowOutput struct {

	// The ARN of the flow that was deleted.
	FlowArn *string `locationName:"flowArn" type:"string"`

	// The status of the flow when the DeleteFlow process begins.
	Status Status `locationName:"status" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

The result of a successful DeleteFlow request.

func (DeleteFlowOutput) MarshalFields 

func (s DeleteFlowOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteFlowOutput) String 

func (s DeleteFlowOutput) String() string

String returns the string representation

type DeleteFlowRequest 

type DeleteFlowRequest struct {
	*aws.Request
	Input *DeleteFlowInput
	Copy  func(*DeleteFlowInput) DeleteFlowRequest
}

DeleteFlowRequest is the request type for the DeleteFlow API operation.

func (DeleteFlowRequest) Send 

func (r DeleteFlowRequest) Send(ctx context.Context) (*DeleteFlowResponse, error)

Send marshals and sends the DeleteFlow API request.

type DeleteFlowResponse added in v0.9.0 

type DeleteFlowResponse struct {
	*DeleteFlowOutput
	// contains filtered or unexported fields
}

DeleteFlowResponse is the response type for the DeleteFlow API operation.

func (*DeleteFlowResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteFlowResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteFlow request.

type DescribeFlowInput 

type DescribeFlowInput struct {

	// FlowArn is a required field
	FlowArn *string `location:"uri" locationName:"flowArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeFlowInput) MarshalFields 

func (s DescribeFlowInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeFlowInput) String 

func (s DescribeFlowInput) String() string

String returns the string representation

func (*DescribeFlowInput) Validate 

func (s *DescribeFlowInput) Validate() error

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

type DescribeFlowOutput 

type DescribeFlowOutput struct {

	// The settings for a flow, including its source, outputs, and entitlements.
	Flow *Flow `locationName:"flow" type:"structure"`

	// Messages that provide the state of the flow.
	Messages *Messages `locationName:"messages" type:"structure"`
	// contains filtered or unexported fields
}

The result of a successful DescribeFlow request.

func (DescribeFlowOutput) MarshalFields 

func (s DescribeFlowOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeFlowOutput) String 

func (s DescribeFlowOutput) String() string

String returns the string representation

type DescribeFlowRequest 

type DescribeFlowRequest struct {
	*aws.Request
	Input *DescribeFlowInput
	Copy  func(*DescribeFlowInput) DescribeFlowRequest
}

DescribeFlowRequest is the request type for the DescribeFlow API operation.

func (DescribeFlowRequest) Send 

func (r DescribeFlowRequest) Send(ctx context.Context) (*DescribeFlowResponse, error)

Send marshals and sends the DescribeFlow API request.

type DescribeFlowResponse added in v0.9.0 

type DescribeFlowResponse struct {
	*DescribeFlowOutput
	// contains filtered or unexported fields
}

DescribeFlowResponse is the response type for the DescribeFlow API operation.

func (*DescribeFlowResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeFlowResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeFlow request.

type Encryption 

type Encryption struct {

	// The type of algorithm that is used for the encryption (such as aes128, aes192,
	// or aes256).
	//
	// Algorithm is a required field
	Algorithm Algorithm `locationName:"algorithm" type:"string" required:"true" enum:"true"`

	// 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 `locationName:"constantInitializationVector" type:"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 `locationName:"deviceId" type:"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 `locationName:"keyType" type:"string" enum:"true"`

	// 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 `locationName:"region" type:"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 `locationName:"resourceId" type:"string"`

	// The ARN of the role that you created during setup (when you set up AWS Elemental
	// MediaConnect as a trusted entity).
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// 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 `locationName:"secretArn" type:"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 `locationName:"url" type:"string"`
	// contains filtered or unexported fields
}

Information about the encryption of the flow.

func (Encryption) MarshalFields 

func (s Encryption) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Encryption) String 

func (s Encryption) String() string

String returns the string representation

func (*Encryption) Validate 

func (s *Encryption) Validate() error

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

type Entitlement 

type Entitlement struct {

	// Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
	DataTransferSubscriberFeePercent *int64 `locationName:"dataTransferSubscriberFeePercent" type:"integer"`

	// A description of the entitlement.
	Description *string `locationName:"description" type:"string"`

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

	// The ARN of the entitlement.
	//
	// EntitlementArn is a required field
	EntitlementArn *string `locationName:"entitlementArn" type:"string" required:"true"`

	// The name of the entitlement.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// 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.
	//
	// Subscribers is a required field
	Subscribers []string `locationName:"subscribers" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The settings for a flow entitlement.

func (Entitlement) MarshalFields 

func (s Entitlement) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Entitlement) String 

func (s Entitlement) String() string

String returns the string representation

type Flow 

type Flow struct {

	// The Availability Zone that you want to create the flow in. These options
	// are limited to the Availability Zones within the current AWS.
	//
	// AvailabilityZone is a required field
	AvailabilityZone *string `locationName:"availabilityZone" type:"string" required:"true"`

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

	// The IP address from which video will be sent to output destinations.
	EgressIp *string `locationName:"egressIp" type:"string"`

	// The entitlements in this flow.
	//
	// Entitlements is a required field
	Entitlements []Entitlement `locationName:"entitlements" type:"list" required:"true"`

	// The Amazon Resource Name (ARN), a unique identifier for any AWS resource,
	// of the flow.
	//
	// FlowArn is a required field
	FlowArn *string `locationName:"flowArn" type:"string" required:"true"`

	// The name of the flow.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The outputs in this flow.
	//
	// Outputs is a required field
	Outputs []Output `locationName:"outputs" type:"list" required:"true"`

	// The settings for the source of the flow.
	//
	// Source is a required field
	Source *Source `locationName:"source" type:"structure" required:"true"`

	// The current status of the flow.
	//
	// Status is a required field
	Status Status `locationName:"status" type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

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

func (Flow) MarshalFields 

func (s Flow) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Flow) String 

func (s Flow) String() string

String returns the string representation

type GrantEntitlementRequest 

type GrantEntitlementRequest struct {

	// Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
	DataTransferSubscriberFeePercent *int64 `locationName:"dataTransferSubscriberFeePercent" type:"integer"`

	// 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 `locationName:"description" type:"string"`

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

	// The name of the entitlement. This value must be unique within the current
	// flow.
	Name *string `locationName:"name" type:"string"`

	// 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.
	//
	// Subscribers is a required field
	Subscribers []string `locationName:"subscribers" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The entitlements that you want to grant on a flow.

func (GrantEntitlementRequest) MarshalFields 

func (s GrantEntitlementRequest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GrantEntitlementRequest) String 

func (s GrantEntitlementRequest) String() string

String returns the string representation

func (*GrantEntitlementRequest) Validate 

func (s *GrantEntitlementRequest) Validate() error

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

type GrantFlowEntitlementsInput 

type GrantFlowEntitlementsInput struct {

	// The list of entitlements that you want to grant.
	//
	// Entitlements is a required field
	Entitlements []GrantEntitlementRequest `locationName:"entitlements" type:"list" required:"true"`

	// FlowArn is a required field
	FlowArn *string `location:"uri" locationName:"flowArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Grants an entitlement on a flow.

func (GrantFlowEntitlementsInput) MarshalFields 

func (s GrantFlowEntitlementsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GrantFlowEntitlementsInput) String 

func (s GrantFlowEntitlementsInput) String() string

String returns the string representation

func (*GrantFlowEntitlementsInput) Validate 

func (s *GrantFlowEntitlementsInput) Validate() error

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

type GrantFlowEntitlementsOutput 

type GrantFlowEntitlementsOutput struct {

	// The entitlements that were just granted.
	Entitlements []Entitlement `locationName:"entitlements" type:"list"`

	// The ARN of the flow that these entitlements were granted to.
	FlowArn *string `locationName:"flowArn" type:"string"`
	// contains filtered or unexported fields
}

The entitlements that were just granted.

func (GrantFlowEntitlementsOutput) MarshalFields 

func (s GrantFlowEntitlementsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GrantFlowEntitlementsOutput) String 

func (s GrantFlowEntitlementsOutput) String() string

String returns the string representation

type GrantFlowEntitlementsRequest 

type GrantFlowEntitlementsRequest struct {
	*aws.Request
	Input *GrantFlowEntitlementsInput
	Copy  func(*GrantFlowEntitlementsInput) GrantFlowEntitlementsRequest
}

GrantFlowEntitlementsRequest is the request type for the GrantFlowEntitlements API operation.

func (GrantFlowEntitlementsRequest) Send 

func (r GrantFlowEntitlementsRequest) Send(ctx context.Context) (*GrantFlowEntitlementsResponse, error)

Send marshals and sends the GrantFlowEntitlements API request.

type GrantFlowEntitlementsResponse added in v0.9.0 

type GrantFlowEntitlementsResponse struct {
	*GrantFlowEntitlementsOutput
	// contains filtered or unexported fields
}

GrantFlowEntitlementsResponse is the response type for the GrantFlowEntitlements API operation.

func (*GrantFlowEntitlementsResponse) SDKResponseMetdata added in v0.9.0 

func (r *GrantFlowEntitlementsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GrantFlowEntitlements request.

type KeyType 

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

Enum values for KeyType

func (KeyType) MarshalValue 

func (enum KeyType) MarshalValue() (string, error)

func (KeyType) MarshalValueBuf 

func (enum KeyType) MarshalValueBuf(b []byte) ([]byte, error)

type ListEntitlementsInput 

type ListEntitlementsInput struct {
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListEntitlementsInput) MarshalFields 

func (s ListEntitlementsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListEntitlementsInput) String 

func (s ListEntitlementsInput) String() string

String returns the string representation

func (*ListEntitlementsInput) Validate 

func (s *ListEntitlementsInput) Validate() error

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

type ListEntitlementsOutput 

type ListEntitlementsOutput struct {

	// A list of entitlements that have been granted to you from other AWS accounts.
	Entitlements []ListedEntitlement `locationName:"entitlements" type:"list"`

	// The token that identifies which batch of results that you want to see. For
	// example, you submit a ListEntitlements request with MaxResults set at 5.
	// The service returns the first batch of results (up to 5) and a NextToken
	// value. To see the next batch of results, you can submit the ListEntitlements
	// request a second time and specify the NextToken value.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The result of a successful ListEntitlements request. The response includes the ARN of each entitlement, the name of the associated flow, and the NextToken to use in a subsequent ListEntitlements request.

func (ListEntitlementsOutput) MarshalFields 

func (s ListEntitlementsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListEntitlementsOutput) String 

func (s ListEntitlementsOutput) String() string

String returns the string representation

type ListEntitlementsPaginator added in v0.9.0 

type ListEntitlementsPaginator struct {
	aws.Pager
}

ListEntitlementsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListEntitlementsPaginator added in v0.9.0 

func NewListEntitlementsPaginator(req ListEntitlementsRequest) ListEntitlementsPaginator

NewListEntitlementsRequestPaginator returns a paginator for ListEntitlements. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.ListEntitlementsRequest(input)
p := mediaconnect.NewListEntitlementsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListEntitlementsPaginator) CurrentPage added in v0.9.0 

func (p *ListEntitlementsPaginator) CurrentPage() *ListEntitlementsOutput

type ListEntitlementsRequest 

type ListEntitlementsRequest struct {
	*aws.Request
	Input *ListEntitlementsInput
	Copy  func(*ListEntitlementsInput) ListEntitlementsRequest
}

ListEntitlementsRequest is the request type for the ListEntitlements API operation.

func (ListEntitlementsRequest) Send 

func (r ListEntitlementsRequest) Send(ctx context.Context) (*ListEntitlementsResponse, error)

Send marshals and sends the ListEntitlements API request.

type ListEntitlementsResponse added in v0.9.0 

type ListEntitlementsResponse struct {
	*ListEntitlementsOutput
	// contains filtered or unexported fields
}

ListEntitlementsResponse is the response type for the ListEntitlements API operation.

func (*ListEntitlementsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListEntitlementsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListEntitlements request.

type ListFlowsInput 

type ListFlowsInput struct {
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListFlowsInput) MarshalFields 

func (s ListFlowsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListFlowsInput) String 

func (s ListFlowsInput) String() string

String returns the string representation

func (*ListFlowsInput) Validate 

func (s *ListFlowsInput) Validate() error

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

type ListFlowsOutput 

type ListFlowsOutput struct {

	// A list of flow summaries.
	Flows []ListedFlow `locationName:"flows" type:"list"`

	// The token that identifies which batch of results that you want to see. For
	// example, you submit a ListFlows request with MaxResults set at 5. The service
	// returns the first batch of results (up to 5) and a NextToken value. To see
	// the next batch of results, you can submit the ListFlows request a second
	// time and specify the NextToken value.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The result of a successful ListFlows request. The response includes flow summaries and the NextToken to use in a subsequent ListFlows request.

func (ListFlowsOutput) MarshalFields 

func (s ListFlowsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListFlowsOutput) String 

func (s ListFlowsOutput) String() string

String returns the string representation

type ListFlowsPaginator added in v0.9.0 

type ListFlowsPaginator struct {
	aws.Pager
}

ListFlowsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListFlowsPaginator added in v0.9.0 

func NewListFlowsPaginator(req ListFlowsRequest) ListFlowsPaginator

NewListFlowsRequestPaginator returns a paginator for ListFlows. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.ListFlowsRequest(input)
p := mediaconnect.NewListFlowsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListFlowsPaginator) CurrentPage added in v0.9.0 

func (p *ListFlowsPaginator) CurrentPage() *ListFlowsOutput

type ListFlowsRequest 

type ListFlowsRequest struct {
	*aws.Request
	Input *ListFlowsInput
	Copy  func(*ListFlowsInput) ListFlowsRequest
}

ListFlowsRequest is the request type for the ListFlows API operation.

func (ListFlowsRequest) Send 

func (r ListFlowsRequest) Send(ctx context.Context) (*ListFlowsResponse, error)

Send marshals and sends the ListFlows API request.

type ListFlowsResponse added in v0.9.0 

type ListFlowsResponse struct {
	*ListFlowsOutput
	// contains filtered or unexported fields
}

ListFlowsResponse is the response type for the ListFlows API operation.

func (*ListFlowsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListFlowsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListFlows request.

type ListTagsForResourceInput added in v0.8.0 

type ListTagsForResourceInput struct {

	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) MarshalFields added in v0.8.0 

func (s ListTagsForResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceInput) String added in v0.8.0 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v0.8.0 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v0.8.0 

type ListTagsForResourceOutput struct {

	// A map from tag keys to values. Tag keys can have a maximum character length
	// of 128 characters, and tag values can have a maximum length of 256 characters.
	Tags map[string]string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

The tags for the resource.

func (ListTagsForResourceOutput) MarshalFields added in v0.8.0 

func (s ListTagsForResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceOutput) String added in v0.8.0 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest added in v0.8.0 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send added in v0.8.0 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.9.0 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type ListedEntitlement 

type ListedEntitlement struct {

	// Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
	DataTransferSubscriberFeePercent *int64 `locationName:"dataTransferSubscriberFeePercent" type:"integer"`

	// The ARN of the entitlement.
	//
	// EntitlementArn is a required field
	EntitlementArn *string `locationName:"entitlementArn" type:"string" required:"true"`

	// The name of the entitlement.
	//
	// EntitlementName is a required field
	EntitlementName *string `locationName:"entitlementName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (ListedEntitlement) MarshalFields 

func (s ListedEntitlement) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListedEntitlement) String 

func (s ListedEntitlement) String() string

String returns the string representation

type ListedFlow 

type ListedFlow struct {

	// The Availability Zone that the flow was created in.
	//
	// AvailabilityZone is a required field
	AvailabilityZone *string `locationName:"availabilityZone" type:"string" required:"true"`

	// A description of the flow.
	//
	// Description is a required field
	Description *string `locationName:"description" type:"string" required:"true"`

	// The ARN of the flow.
	//
	// FlowArn is a required field
	FlowArn *string `locationName:"flowArn" type:"string" required:"true"`

	// The name of the flow.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// 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).
	//
	// SourceType is a required field
	SourceType SourceType `locationName:"sourceType" type:"string" required:"true" enum:"true"`

	// The current status of the flow.
	//
	// Status is a required field
	Status Status `locationName:"status" type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

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

func (ListedFlow) MarshalFields 

func (s ListedFlow) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListedFlow) String 

func (s ListedFlow) String() string

String returns the string representation

type Messages 

type Messages struct {

	// A list of errors that might have been generated from processes on this flow.
	//
	// Errors is a required field
	Errors []string `locationName:"errors" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Messages that provide the state of the flow.

func (Messages) MarshalFields 

func (s Messages) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Messages) String 

func (s Messages) String() string

String returns the string representation

type Output 

type Output struct {

	// Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
	DataTransferSubscriberFeePercent *int64 `locationName:"dataTransferSubscriberFeePercent" type:"integer"`

	// A description of the output.
	Description *string `locationName:"description" type:"string"`

	// The address where you want to send the output.
	Destination *string `locationName:"destination" type:"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 `locationName:"encryption" type:"structure"`

	// The ARN of the entitlement on the originator”s flow. This value is relevant
	// only on entitled flows.
	EntitlementArn *string `locationName:"entitlementArn" type:"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 `locationName:"mediaLiveInputArn" type:"string"`

	// The name of the output. This value must be unique within the current flow.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The ARN of the output.
	//
	// OutputArn is a required field
	OutputArn *string `locationName:"outputArn" type:"string" required:"true"`

	// The port to use when content is distributed to this output.
	Port *int64 `locationName:"port" type:"integer"`

	// Attributes related to the transport stream that are used in the output.
	Transport *Transport `locationName:"transport" type:"structure"`
	// contains filtered or unexported fields
}

The settings for an output.

func (Output) MarshalFields 

func (s Output) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Output) String 

func (s Output) String() string

String returns the string representation

type Protocol 

type Protocol string
const (
	ProtocolZixiPush Protocol = "zixi-push"
	ProtocolRtpFec   Protocol = "rtp-fec"
	ProtocolRtp      Protocol = "rtp"
	ProtocolZixiPull Protocol = "zixi-pull"
	ProtocolRist     Protocol = "rist"
)

Enum values for Protocol

func (Protocol) MarshalValue 

func (enum Protocol) MarshalValue() (string, error)

func (Protocol) MarshalValueBuf 

func (enum Protocol) MarshalValueBuf(b []byte) ([]byte, error)

type RemoveFlowOutputInput 

type RemoveFlowOutputInput struct {

	// FlowArn is a required field
	FlowArn *string `location:"uri" locationName:"flowArn" type:"string" required:"true"`

	// OutputArn is a required field
	OutputArn *string `location:"uri" locationName:"outputArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RemoveFlowOutputInput) MarshalFields 

func (s RemoveFlowOutputInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RemoveFlowOutputInput) String 

func (s RemoveFlowOutputInput) String() string

String returns the string representation

func (*RemoveFlowOutputInput) Validate 

func (s *RemoveFlowOutputInput) Validate() error

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

type RemoveFlowOutputOutput 

type RemoveFlowOutputOutput struct {

	// The ARN of the flow that is associated with the output you removed.
	FlowArn *string `locationName:"flowArn" type:"string"`

	// The ARN of the output that was removed.
	OutputArn *string `locationName:"outputArn" type:"string"`
	// contains filtered or unexported fields
}

The result of a successful RemoveFlowOutput request including the flow ARN and the output ARN that was removed.

func (RemoveFlowOutputOutput) MarshalFields 

func (s RemoveFlowOutputOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RemoveFlowOutputOutput) String 

func (s RemoveFlowOutputOutput) String() string

String returns the string representation

type RemoveFlowOutputRequest 

type RemoveFlowOutputRequest struct {
	*aws.Request
	Input *RemoveFlowOutputInput
	Copy  func(*RemoveFlowOutputInput) RemoveFlowOutputRequest
}

RemoveFlowOutputRequest is the request type for the RemoveFlowOutput API operation.

func (RemoveFlowOutputRequest) Send 

func (r RemoveFlowOutputRequest) Send(ctx context.Context) (*RemoveFlowOutputResponse, error)

Send marshals and sends the RemoveFlowOutput API request.

type RemoveFlowOutputResponse added in v0.9.0 

type RemoveFlowOutputResponse struct {
	*RemoveFlowOutputOutput
	// contains filtered or unexported fields
}

RemoveFlowOutputResponse is the response type for the RemoveFlowOutput API operation.

func (*RemoveFlowOutputResponse) SDKResponseMetdata added in v0.9.0 

func (r *RemoveFlowOutputResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RemoveFlowOutput request.

type RevokeFlowEntitlementInput 

type RevokeFlowEntitlementInput struct {

	// EntitlementArn is a required field
	EntitlementArn *string `location:"uri" locationName:"entitlementArn" type:"string" required:"true"`

	// FlowArn is a required field
	FlowArn *string `location:"uri" locationName:"flowArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RevokeFlowEntitlementInput) MarshalFields 

func (s RevokeFlowEntitlementInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RevokeFlowEntitlementInput) String 

func (s RevokeFlowEntitlementInput) String() string

String returns the string representation

func (*RevokeFlowEntitlementInput) Validate 

func (s *RevokeFlowEntitlementInput) Validate() error

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

type RevokeFlowEntitlementOutput 

type RevokeFlowEntitlementOutput struct {

	// The ARN of the entitlement that was revoked.
	EntitlementArn *string `locationName:"entitlementArn" type:"string"`

	// The ARN of the flow that the entitlement was revoked from.
	FlowArn *string `locationName:"flowArn" type:"string"`
	// contains filtered or unexported fields
}

The result of a successful RevokeFlowEntitlement request. The response includes the ARN of the flow that was updated and the ARN of the entitlement that was revoked.

func (RevokeFlowEntitlementOutput) MarshalFields 

func (s RevokeFlowEntitlementOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RevokeFlowEntitlementOutput) String 

func (s RevokeFlowEntitlementOutput) String() string

String returns the string representation

type RevokeFlowEntitlementRequest 

type RevokeFlowEntitlementRequest struct {
	*aws.Request
	Input *RevokeFlowEntitlementInput
	Copy  func(*RevokeFlowEntitlementInput) RevokeFlowEntitlementRequest
}

RevokeFlowEntitlementRequest is the request type for the RevokeFlowEntitlement API operation.

func (RevokeFlowEntitlementRequest) Send 

func (r RevokeFlowEntitlementRequest) Send(ctx context.Context) (*RevokeFlowEntitlementResponse, error)

Send marshals and sends the RevokeFlowEntitlement API request.

type RevokeFlowEntitlementResponse added in v0.9.0 

type RevokeFlowEntitlementResponse struct {
	*RevokeFlowEntitlementOutput
	// contains filtered or unexported fields
}

RevokeFlowEntitlementResponse is the response type for the RevokeFlowEntitlement API operation.

func (*RevokeFlowEntitlementResponse) SDKResponseMetdata added in v0.9.0 

func (r *RevokeFlowEntitlementResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RevokeFlowEntitlement request.

type SetSourceRequest 

type SetSourceRequest struct {

	// The type of encryption that is used on the content ingested from this source.
	Decryption *Encryption `locationName:"decryption" type:"structure"`

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

	// 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 `locationName:"entitlementArn" type:"string"`

	// The port that the flow will be listening on for incoming content.
	IngestPort *int64 `locationName:"ingestPort" type:"integer"`

	// The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
	MaxBitrate *int64 `locationName:"maxBitrate" type:"integer"`

	// The maximum latency in milliseconds. This parameter applies only to RIST-based
	// and Zixi-based streams.
	MaxLatency *int64 `locationName:"maxLatency" type:"integer"`

	// The name of the source.
	Name *string `locationName:"name" type:"string"`

	// The protocol that is used by the source.
	Protocol Protocol `locationName:"protocol" type:"string" enum:"true"`

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

	// 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 `locationName:"whitelistCidr" type:"string"`
	// contains filtered or unexported fields
}

The settings for the source of the flow.

func (SetSourceRequest) MarshalFields 

func (s SetSourceRequest) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SetSourceRequest) String 

func (s SetSourceRequest) String() string

String returns the string representation

func (*SetSourceRequest) Validate 

func (s *SetSourceRequest) Validate() error

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

type Source 

type Source struct {

	// Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
	DataTransferSubscriberFeePercent *int64 `locationName:"dataTransferSubscriberFeePercent" type:"integer"`

	// The type of encryption that is used on the content ingested from this source.
	Decryption *Encryption `locationName:"decryption" type:"structure"`

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

	// 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 `locationName:"entitlementArn" type:"string"`

	// The IP address that the flow will be listening on for incoming content.
	IngestIp *string `locationName:"ingestIp" type:"string"`

	// The port that the flow will be listening on for incoming content.
	IngestPort *int64 `locationName:"ingestPort" type:"integer"`

	// The name of the source.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The ARN of the source.
	//
	// SourceArn is a required field
	SourceArn *string `locationName:"sourceArn" type:"string" required:"true"`

	// Attributes related to the transport stream that are used in the source.
	Transport *Transport `locationName:"transport" type:"structure"`

	// 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 `locationName:"whitelistCidr" type:"string"`
	// contains filtered or unexported fields
}

The settings for the source of the flow.

func (Source) MarshalFields 

func (s Source) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Source) String 

func (s Source) String() string

String returns the string representation

type SourceType 

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

Enum values for SourceType

func (SourceType) MarshalValue 

func (enum SourceType) MarshalValue() (string, error)

func (SourceType) MarshalValueBuf 

func (enum SourceType) MarshalValueBuf(b []byte) ([]byte, error)

type StartFlowInput 

type StartFlowInput struct {

	// FlowArn is a required field
	FlowArn *string `location:"uri" locationName:"flowArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartFlowInput) MarshalFields 

func (s StartFlowInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StartFlowInput) String 

func (s StartFlowInput) String() string

String returns the string representation

func (*StartFlowInput) Validate 

func (s *StartFlowInput) Validate() error

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

type StartFlowOutput 

type StartFlowOutput struct {

	// The ARN of the flow that you started.
	FlowArn *string `locationName:"flowArn" type:"string"`

	// The status of the flow when the StartFlow process begins.
	Status Status `locationName:"status" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

The result of a successful StartFlow request.

func (StartFlowOutput) MarshalFields 

func (s StartFlowOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StartFlowOutput) String 

func (s StartFlowOutput) String() string

String returns the string representation

type StartFlowRequest 

type StartFlowRequest struct {
	*aws.Request
	Input *StartFlowInput
	Copy  func(*StartFlowInput) StartFlowRequest
}

StartFlowRequest is the request type for the StartFlow API operation.

func (StartFlowRequest) Send 

func (r StartFlowRequest) Send(ctx context.Context) (*StartFlowResponse, error)

Send marshals and sends the StartFlow API request.

type StartFlowResponse added in v0.9.0 

type StartFlowResponse struct {
	*StartFlowOutput
	// contains filtered or unexported fields
}

StartFlowResponse is the response type for the StartFlow API operation.

func (*StartFlowResponse) SDKResponseMetdata added in v0.9.0 

func (r *StartFlowResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartFlow request.

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

func (Status) MarshalValue 

func (enum Status) MarshalValue() (string, error)

func (Status) MarshalValueBuf 

func (enum Status) MarshalValueBuf(b []byte) ([]byte, error)

type StopFlowInput 

type StopFlowInput struct {

	// FlowArn is a required field
	FlowArn *string `location:"uri" locationName:"flowArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopFlowInput) MarshalFields 

func (s StopFlowInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StopFlowInput) String 

func (s StopFlowInput) String() string

String returns the string representation

func (*StopFlowInput) Validate 

func (s *StopFlowInput) Validate() error

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

type StopFlowOutput 

type StopFlowOutput struct {

	// The ARN of the flow that you stopped.
	FlowArn *string `locationName:"flowArn" type:"string"`

	// The status of the flow when the StopFlow process begins.
	Status Status `locationName:"status" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

The result of a successful StopFlow request.

func (StopFlowOutput) MarshalFields 

func (s StopFlowOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StopFlowOutput) String 

func (s StopFlowOutput) String() string

String returns the string representation

type StopFlowRequest 

type StopFlowRequest struct {
	*aws.Request
	Input *StopFlowInput
	Copy  func(*StopFlowInput) StopFlowRequest
}

StopFlowRequest is the request type for the StopFlow API operation.

func (StopFlowRequest) Send 

func (r StopFlowRequest) Send(ctx context.Context) (*StopFlowResponse, error)

Send marshals and sends the StopFlow API request.

type StopFlowResponse added in v0.9.0 

type StopFlowResponse struct {
	*StopFlowOutput
	// contains filtered or unexported fields
}

StopFlowResponse is the response type for the StopFlow API operation.

func (*StopFlowResponse) SDKResponseMetdata added in v0.9.0 

func (r *StopFlowResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StopFlow request.

type TagResourceInput added in v0.8.0 

type TagResourceInput struct {

	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// A map from tag keys to values. Tag keys can have a maximum character length
	// of 128 characters, and tag values can have a maximum length of 256 characters.
	//
	// Tags is a required field
	Tags map[string]string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

The tags to add to the resource. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

func (TagResourceInput) MarshalFields added in v0.8.0 

func (s TagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceInput) String added in v0.8.0 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v0.8.0 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v0.8.0 

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

func (TagResourceOutput) MarshalFields added in v0.8.0 

func (s TagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceOutput) String added in v0.8.0 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest added in v0.8.0 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send added in v0.8.0 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse added in v0.9.0 

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

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type Transport 

type Transport struct {

	// 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 `locationName:"cidrAllowList" type:"list"`

	// The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
	MaxBitrate *int64 `locationName:"maxBitrate" type:"integer"`

	// The maximum latency in milliseconds. This parameter applies only to RIST-based
	// and Zixi-based streams.
	MaxLatency *int64 `locationName:"maxLatency" type:"integer"`

	// The protocol that is used by the source or output.
	//
	// Protocol is a required field
	Protocol Protocol `locationName:"protocol" type:"string" required:"true" enum:"true"`

	// The remote ID for the Zixi-pull stream.
	RemoteId *string `locationName:"remoteId" type:"string"`

	// The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
	SmoothingLatency *int64 `locationName:"smoothingLatency" type:"integer"`

	// The stream ID that you want to use for this transport. This parameter applies
	// only to Zixi-based streams.
	StreamId *string `locationName:"streamId" type:"string"`
	// contains filtered or unexported fields
}

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

func (Transport) MarshalFields 

func (s Transport) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Transport) String 

func (s Transport) String() string

String returns the string representation

type UntagResourceInput added in v0.8.0 

type UntagResourceInput struct {

	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// TagKeys is a required field
	TagKeys []string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) MarshalFields added in v0.8.0 

func (s UntagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceInput) String added in v0.8.0 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v0.8.0 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v0.8.0 

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

func (UntagResourceOutput) MarshalFields added in v0.8.0 

func (s UntagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceOutput) String added in v0.8.0 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest added in v0.8.0 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send added in v0.8.0 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse added in v0.9.0 

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

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

type UpdateEncryption 

type UpdateEncryption struct {

	// The type of algorithm that is used for the encryption (such as aes128, aes192,
	// or aes256).
	Algorithm Algorithm `locationName:"algorithm" type:"string" enum:"true"`

	// 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 `locationName:"constantInitializationVector" type:"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 `locationName:"deviceId" type:"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 `locationName:"keyType" type:"string" enum:"true"`

	// 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 `locationName:"region" type:"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 `locationName:"resourceId" type:"string"`

	// The ARN of the role that you created during setup (when you set up AWS Elemental
	// MediaConnect as a trusted entity).
	RoleArn *string `locationName:"roleArn" type:"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 `locationName:"secretArn" type:"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 `locationName:"url" type:"string"`
	// contains filtered or unexported fields
}

Information about the encryption of the flow.

func (UpdateEncryption) MarshalFields 

func (s UpdateEncryption) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateEncryption) String 

func (s UpdateEncryption) String() string

String returns the string representation

type UpdateFlowEntitlementInput 

type UpdateFlowEntitlementInput struct {

	// 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 `locationName:"description" type:"string"`

	// The type of encryption that will be used on the output associated with this
	// entitlement.
	Encryption *UpdateEncryption `locationName:"encryption" type:"structure"`

	// EntitlementArn is a required field
	EntitlementArn *string `location:"uri" locationName:"entitlementArn" type:"string" required:"true"`

	// FlowArn is a required field
	FlowArn *string `location:"uri" locationName:"flowArn" type:"string" required:"true"`

	// 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.
	Subscribers []string `locationName:"subscribers" type:"list"`
	// contains filtered or unexported fields
}

The updates that you want to make to a specific entitlement.

func (UpdateFlowEntitlementInput) MarshalFields 

func (s UpdateFlowEntitlementInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateFlowEntitlementInput) String 

func (s UpdateFlowEntitlementInput) String() string

String returns the string representation

func (*UpdateFlowEntitlementInput) Validate 

func (s *UpdateFlowEntitlementInput) Validate() error

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

type UpdateFlowEntitlementOutput 

type UpdateFlowEntitlementOutput struct {

	// The settings for a flow entitlement.
	Entitlement *Entitlement `locationName:"entitlement" type:"structure"`

	// The ARN of the flow that this entitlement was granted on.
	FlowArn *string `locationName:"flowArn" type:"string"`
	// contains filtered or unexported fields
}

The result of a successful UpdateFlowEntitlement request. The response includes the ARN of the flow that was updated and the updated entitlement configuration.

func (UpdateFlowEntitlementOutput) MarshalFields 

func (s UpdateFlowEntitlementOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateFlowEntitlementOutput) String 

func (s UpdateFlowEntitlementOutput) String() string

String returns the string representation

type UpdateFlowEntitlementRequest 

type UpdateFlowEntitlementRequest struct {
	*aws.Request
	Input *UpdateFlowEntitlementInput
	Copy  func(*UpdateFlowEntitlementInput) UpdateFlowEntitlementRequest
}

UpdateFlowEntitlementRequest is the request type for the UpdateFlowEntitlement API operation.

func (UpdateFlowEntitlementRequest) Send 

func (r UpdateFlowEntitlementRequest) Send(ctx context.Context) (*UpdateFlowEntitlementResponse, error)

Send marshals and sends the UpdateFlowEntitlement API request.

type UpdateFlowEntitlementResponse added in v0.9.0 

type UpdateFlowEntitlementResponse struct {
	*UpdateFlowEntitlementOutput
	// contains filtered or unexported fields
}

UpdateFlowEntitlementResponse is the response type for the UpdateFlowEntitlement API operation.

func (*UpdateFlowEntitlementResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateFlowEntitlementResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateFlowEntitlement request.

type UpdateFlowOutputInput 

type UpdateFlowOutputInput struct {

	// 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 `locationName:"cidrAllowList" type:"list"`

	// 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 `locationName:"description" type:"string"`

	// The IP address where you want to send the output.
	Destination *string `locationName:"destination" type:"string"`

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

	// FlowArn is a required field
	FlowArn *string `location:"uri" locationName:"flowArn" type:"string" required:"true"`

	// The maximum latency in milliseconds for Zixi-based streams.
	MaxLatency *int64 `locationName:"maxLatency" type:"integer"`

	// OutputArn is a required field
	OutputArn *string `location:"uri" locationName:"outputArn" type:"string" required:"true"`

	// The port to use when content is distributed to this output.
	Port *int64 `locationName:"port" type:"integer"`

	// The protocol to use for the output.
	Protocol Protocol `locationName:"protocol" type:"string" enum:"true"`

	// The remote ID for the Zixi-pull stream.
	RemoteId *string `locationName:"remoteId" type:"string"`

	// The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
	SmoothingLatency *int64 `locationName:"smoothingLatency" type:"integer"`

	// The stream ID that you want to use for this transport. This parameter applies
	// only to Zixi-based streams.
	StreamId *string `locationName:"streamId" type:"string"`
	// contains filtered or unexported fields
}

The updates that you want to make to an existing output of an existing flow.

func (UpdateFlowOutputInput) MarshalFields 

func (s UpdateFlowOutputInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateFlowOutputInput) String 

func (s UpdateFlowOutputInput) String() string

String returns the string representation

func (*UpdateFlowOutputInput) Validate 

func (s *UpdateFlowOutputInput) Validate() error

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

type UpdateFlowOutputOutput 

type UpdateFlowOutputOutput struct {

	// The ARN of the flow that is associated with the updated output.
	FlowArn *string `locationName:"flowArn" type:"string"`

	// The settings for an output.
	Output *Output `locationName:"output" type:"structure"`
	// contains filtered or unexported fields
}

The result of a successful UpdateFlowOutput request including the flow ARN and the updated output.

func (UpdateFlowOutputOutput) MarshalFields 

func (s UpdateFlowOutputOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateFlowOutputOutput) String 

func (s UpdateFlowOutputOutput) String() string

String returns the string representation

type UpdateFlowOutputRequest 

type UpdateFlowOutputRequest struct {
	*aws.Request
	Input *UpdateFlowOutputInput
	Copy  func(*UpdateFlowOutputInput) UpdateFlowOutputRequest
}

UpdateFlowOutputRequest is the request type for the UpdateFlowOutput API operation.

func (UpdateFlowOutputRequest) Send 

func (r UpdateFlowOutputRequest) Send(ctx context.Context) (*UpdateFlowOutputResponse, error)

Send marshals and sends the UpdateFlowOutput API request.

type UpdateFlowOutputResponse added in v0.9.0 

type UpdateFlowOutputResponse struct {
	*UpdateFlowOutputOutput
	// contains filtered or unexported fields
}

UpdateFlowOutputResponse is the response type for the UpdateFlowOutput API operation.

func (*UpdateFlowOutputResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateFlowOutputResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateFlowOutput request.

type UpdateFlowSourceInput 

type UpdateFlowSourceInput struct {

	// The type of encryption used on the content ingested from this source.
	Decryption *UpdateEncryption `locationName:"decryption" type:"structure"`

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

	// 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 `locationName:"entitlementArn" type:"string"`

	// FlowArn is a required field
	FlowArn *string `location:"uri" locationName:"flowArn" type:"string" required:"true"`

	// The port that the flow will be listening on for incoming content.
	IngestPort *int64 `locationName:"ingestPort" type:"integer"`

	// The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
	MaxBitrate *int64 `locationName:"maxBitrate" type:"integer"`

	// The maximum latency in milliseconds. This parameter applies only to RIST-based
	// and Zixi-based streams.
	MaxLatency *int64 `locationName:"maxLatency" type:"integer"`

	// The protocol that is used by the source.
	Protocol Protocol `locationName:"protocol" type:"string" enum:"true"`

	// SourceArn is a required field
	SourceArn *string `location:"uri" locationName:"sourceArn" type:"string" required:"true"`

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

	// 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 `locationName:"whitelistCidr" type:"string"`
	// contains filtered or unexported fields
}

The settings for the updated source of the flow.

func (UpdateFlowSourceInput) MarshalFields 

func (s UpdateFlowSourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateFlowSourceInput) String 

func (s UpdateFlowSourceInput) String() string

String returns the string representation

func (*UpdateFlowSourceInput) Validate 

func (s *UpdateFlowSourceInput) Validate() error

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

type UpdateFlowSourceOutput 

type UpdateFlowSourceOutput struct {

	// The ARN of the flow that you want to update.
	FlowArn *string `locationName:"flowArn" type:"string"`

	// The settings for the source of the flow.
	Source *Source `locationName:"source" type:"structure"`
	// contains filtered or unexported fields
}

The result of a successful UpdateFlowSource request. The response includes the ARN of the flow that was updated and the updated source configuration.

func (UpdateFlowSourceOutput) MarshalFields 

func (s UpdateFlowSourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateFlowSourceOutput) String 

func (s UpdateFlowSourceOutput) String() string

String returns the string representation

type UpdateFlowSourceRequest 

type UpdateFlowSourceRequest struct {
	*aws.Request
	Input *UpdateFlowSourceInput
	Copy  func(*UpdateFlowSourceInput) UpdateFlowSourceRequest
}

UpdateFlowSourceRequest is the request type for the UpdateFlowSource API operation.

func (UpdateFlowSourceRequest) Send 

func (r UpdateFlowSourceRequest) Send(ctx context.Context) (*UpdateFlowSourceResponse, error)

Send marshals and sends the UpdateFlowSource API request.

type UpdateFlowSourceResponse added in v0.9.0 

type UpdateFlowSourceResponse struct {
	*UpdateFlowSourceOutput
	// contains filtered or unexported fields
}

UpdateFlowSourceResponse is the response type for the UpdateFlowSource API operation.

func (*UpdateFlowSourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateFlowSourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateFlowSource request.

Source Files

View all Source files

Directories

Path Synopsis
Package mediaconnectiface provides an interface to enable mocking the AWS MediaConnect service client for testing your code.
 Package mediaconnectiface provides an interface to enable mocking the AWS MediaConnect service client for testing your code.

Jump to

Keyboard shortcuts

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