The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Paws::MediaConnect - Perl Interface to AWS AWS MediaConnect

SYNOPSIS

  use Paws;

  my $obj = Paws->service('MediaConnect');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

API for AWS Elemental MediaConnect

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14

METHODS

AddFlowMediaStreams

FlowArn => Str
MediaStreams => ArrayRef[Paws::MediaConnect::AddMediaStreamRequest]

Each argument is described in detail in: Paws::MediaConnect::AddFlowMediaStreams

Returns: a Paws::MediaConnect::AddFlowMediaStreamsResponse instance

Adds media streams to an existing flow. After you add a media stream to a flow, you can associate it with a source and/or an output that uses the ST 2110 JPEG XS or CDI protocol.

AddFlowOutputs

FlowArn => Str
Outputs => ArrayRef[Paws::MediaConnect::AddOutputRequest]

Each argument is described in detail in: Paws::MediaConnect::AddFlowOutputs

Returns: a Paws::MediaConnect::AddFlowOutputsResponse instance

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

AddFlowSources

FlowArn => Str
Sources => ArrayRef[Paws::MediaConnect::SetSourceRequest]

Each argument is described in detail in: Paws::MediaConnect::AddFlowSources

Returns: a Paws::MediaConnect::AddFlowSourcesResponse instance

Adds Sources to flow

AddFlowVpcInterfaces

FlowArn => Str
VpcInterfaces => ArrayRef[Paws::MediaConnect::VpcInterfaceRequest]

Each argument is described in detail in: Paws::MediaConnect::AddFlowVpcInterfaces

Returns: a Paws::MediaConnect::AddFlowVpcInterfacesResponse instance

Adds VPC interfaces to flow

CreateFlow

Name => Str
[AvailabilityZone => Str]
[Entitlements => ArrayRef[Paws::MediaConnect::GrantEntitlementRequest]]
[MediaStreams => ArrayRef[Paws::MediaConnect::AddMediaStreamRequest]]
[Outputs => ArrayRef[Paws::MediaConnect::AddOutputRequest]]
[Source => Paws::MediaConnect::SetSourceRequest]
[SourceFailoverConfig => Paws::MediaConnect::FailoverConfig]
[Sources => ArrayRef[Paws::MediaConnect::SetSourceRequest]]
[VpcInterfaces => ArrayRef[Paws::MediaConnect::VpcInterfaceRequest]]

Each argument is described in detail in: Paws::MediaConnect::CreateFlow

Returns: a Paws::MediaConnect::CreateFlowResponse instance

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

DeleteFlow

FlowArn => Str

Each argument is described in detail in: Paws::MediaConnect::DeleteFlow

Returns: a Paws::MediaConnect::DeleteFlowResponse instance

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

DescribeFlow

FlowArn => Str

Each argument is described in detail in: Paws::MediaConnect::DescribeFlow

Returns: a Paws::MediaConnect::DescribeFlowResponse instance

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.

DescribeOffering

OfferingArn => Str

Each argument is described in detail in: Paws::MediaConnect::DescribeOffering

Returns: a Paws::MediaConnect::DescribeOfferingResponse instance

Displays the details of an offering. The response includes the offering description, duration, outbound bandwidth, price, and Amazon Resource Name (ARN).

DescribeReservation

ReservationArn => Str

Each argument is described in detail in: Paws::MediaConnect::DescribeReservation

Returns: a Paws::MediaConnect::DescribeReservationResponse instance

Displays the details of a reservation. The response includes the reservation name, state, start date and time, and the details of the offering that make up the rest of the reservation (such as price, duration, and outbound bandwidth).

GrantFlowEntitlements

Entitlements => ArrayRef[Paws::MediaConnect::GrantEntitlementRequest]
FlowArn => Str

Each argument is described in detail in: Paws::MediaConnect::GrantFlowEntitlements

Returns: a Paws::MediaConnect::GrantFlowEntitlementsResponse instance

Grants entitlements to an existing flow.

ListEntitlements

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::MediaConnect::ListEntitlements

Returns: a Paws::MediaConnect::ListEntitlementsResponse instance

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

ListFlows

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::MediaConnect::ListFlows

Returns: a Paws::MediaConnect::ListFlowsResponse instance

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

ListOfferings

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::MediaConnect::ListOfferings

Returns: a Paws::MediaConnect::ListOfferingsResponse instance

Displays a list of all offerings that are available to this account in the current AWS Region. If you have an active reservation (which means you've purchased an offering that has already started and hasn't expired yet), your account isn't eligible for other offerings.

ListReservations

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::MediaConnect::ListReservations

Returns: a Paws::MediaConnect::ListReservationsResponse instance

Displays a list of all reservations that have been purchased by this account in the current AWS Region. This list includes all reservations in all states (such as active and expired).

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::MediaConnect::ListTagsForResource

Returns: a Paws::MediaConnect::ListTagsForResourceResponse instance

List all tags on an AWS Elemental MediaConnect resource

PurchaseOffering

OfferingArn => Str
ReservationName => Str
Start => Str

Each argument is described in detail in: Paws::MediaConnect::PurchaseOffering

Returns: a Paws::MediaConnect::PurchaseOfferingResponse instance

Submits a request to purchase an offering. If you already have an active reservation, you can't purchase another offering.

RemoveFlowMediaStream

FlowArn => Str
MediaStreamName => Str

Each argument is described in detail in: Paws::MediaConnect::RemoveFlowMediaStream

Returns: a Paws::MediaConnect::RemoveFlowMediaStreamResponse instance

Removes a media stream from a flow. This action is only available if the media stream is not associated with a source or output.

RemoveFlowOutput

FlowArn => Str
OutputArn => Str

Each argument is described in detail in: Paws::MediaConnect::RemoveFlowOutput

Returns: a Paws::MediaConnect::RemoveFlowOutputResponse instance

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.

RemoveFlowSource

FlowArn => Str
SourceArn => Str

Each argument is described in detail in: Paws::MediaConnect::RemoveFlowSource

Returns: a Paws::MediaConnect::RemoveFlowSourceResponse instance

Removes a source from an existing flow. This request can be made only if there is more than one source on the flow.

RemoveFlowVpcInterface

FlowArn => Str
VpcInterfaceName => Str

Each argument is described in detail in: Paws::MediaConnect::RemoveFlowVpcInterface

Returns: a Paws::MediaConnect::RemoveFlowVpcInterfaceResponse instance

Removes a VPC Interface from an existing flow. This request can be made only on a VPC interface that does not have a Source or Output associated with it. If the VPC interface is referenced by a Source or Output, you must first delete or update the Source or Output to no longer reference the VPC interface.

RevokeFlowEntitlement

EntitlementArn => Str
FlowArn => Str

Each argument is described in detail in: Paws::MediaConnect::RevokeFlowEntitlement

Returns: a Paws::MediaConnect::RevokeFlowEntitlementResponse instance

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

StartFlow

FlowArn => Str

Each argument is described in detail in: Paws::MediaConnect::StartFlow

Returns: a Paws::MediaConnect::StartFlowResponse instance

Starts a flow.

StopFlow

FlowArn => Str

Each argument is described in detail in: Paws::MediaConnect::StopFlow

Returns: a Paws::MediaConnect::StopFlowResponse instance

Stops a flow.

TagResource

ResourceArn => Str
Tags => Paws::MediaConnect::__mapOf__string

Each argument is described in detail in: Paws::MediaConnect::TagResource

Returns: nothing

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.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::MediaConnect::UntagResource

Returns: nothing

Deletes specified tags from a resource.

UpdateFlow

FlowArn => Str
[SourceFailoverConfig => Paws::MediaConnect::UpdateFailoverConfig]

Each argument is described in detail in: Paws::MediaConnect::UpdateFlow

Returns: a Paws::MediaConnect::UpdateFlowResponse instance

Updates flow

UpdateFlowEntitlement

EntitlementArn => Str
FlowArn => Str
[Description => Str]
[Encryption => Paws::MediaConnect::UpdateEncryption]
[EntitlementStatus => Str]
[Subscribers => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::MediaConnect::UpdateFlowEntitlement

Returns: a Paws::MediaConnect::UpdateFlowEntitlementResponse instance

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.

UpdateFlowMediaStream

FlowArn => Str
MediaStreamName => Str
[Attributes => Paws::MediaConnect::MediaStreamAttributesRequest]
[ClockRate => Int]
[Description => Str]
[MediaStreamType => Str]
[VideoFormat => Str]

Each argument is described in detail in: Paws::MediaConnect::UpdateFlowMediaStream

Returns: a Paws::MediaConnect::UpdateFlowMediaStreamResponse instance

Updates an existing media stream.

UpdateFlowOutput

FlowArn => Str
OutputArn => Str
[CidrAllowList => ArrayRef[Str|Undef]]
[Description => Str]
[Destination => Str]
[Encryption => Paws::MediaConnect::UpdateEncryption]
[MaxLatency => Int]
[MediaStreamOutputConfigurations => ArrayRef[Paws::MediaConnect::MediaStreamOutputConfigurationRequest]]
[MinLatency => Int]
[Port => Int]
[Protocol => Str]
[RemoteId => Str]
[SmoothingLatency => Int]
[StreamId => Str]
[VpcInterfaceAttachment => Paws::MediaConnect::VpcInterfaceAttachment]

Each argument is described in detail in: Paws::MediaConnect::UpdateFlowOutput

Returns: a Paws::MediaConnect::UpdateFlowOutputResponse instance

Updates an existing flow output.

UpdateFlowSource

FlowArn => Str
SourceArn => Str
[Decryption => Paws::MediaConnect::UpdateEncryption]
[Description => Str]
[EntitlementArn => Str]
[IngestPort => Int]
[MaxBitrate => Int]
[MaxLatency => Int]
[MaxSyncBuffer => Int]
[MediaStreamSourceConfigurations => ArrayRef[Paws::MediaConnect::MediaStreamSourceConfigurationRequest]]
[MinLatency => Int]
[Protocol => Str]
[StreamId => Str]
[VpcInterfaceName => Str]
[WhitelistCidr => Str]

Each argument is described in detail in: Paws::MediaConnect::UpdateFlowSource

Returns: a Paws::MediaConnect::UpdateFlowSourceResponse instance

Updates the source of a flow.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllEntitlements(sub { },[MaxResults => Int, NextToken => Str])

ListAllEntitlements([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Entitlements, passing the object as the first parameter, and the string 'Entitlements' as the second parameter 

If not, it will return a a Paws::MediaConnect::ListEntitlementsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllFlows(sub { },[MaxResults => Int, NextToken => Str])

ListAllFlows([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Flows, passing the object as the first parameter, and the string 'Flows' as the second parameter 

If not, it will return a a Paws::MediaConnect::ListFlowsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllOfferings(sub { },[MaxResults => Int, NextToken => Str])

ListAllOfferings([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Offerings, passing the object as the first parameter, and the string 'Offerings' as the second parameter 

If not, it will return a a Paws::MediaConnect::ListOfferingsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllReservations(sub { },[MaxResults => Int, NextToken => Str])

ListAllReservations([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Reservations, passing the object as the first parameter, and the string 'Reservations' as the second parameter 

If not, it will return a a Paws::MediaConnect::ListReservationsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues