| 1 | |||
| 2 | package Paws::KinesisVideoMedia::GetMedia; | ||
| 3 | use Moose; | ||
| 4 | has StartSelector => (is => 'ro', isa => 'Paws::KinesisVideoMedia::StartSelector', required => 1); | ||
| 5 | has StreamARN => (is => 'ro', isa => 'Str'); | ||
| 6 | has StreamName => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetMedia'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/getMedia'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KinesisVideoMedia::GetMediaOutput'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::KinesisVideoMedia::GetMedia - Arguments for method GetMedia on L<Paws::KinesisVideoMedia> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method GetMedia on the | ||
| 25 | L<Amazon Kinesis Video Streams Media|Paws::KinesisVideoMedia> service. Use the attributes of this class | ||
| 26 | as arguments to method GetMedia. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetMedia. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $kinesisvideo = Paws->service('KinesisVideoMedia'); | ||
| 33 | my $GetMediaOutput = $kinesisvideo->GetMedia( | ||
| 34 | StartSelector => { | ||
| 35 | StartSelectorType => 'FRAGMENT_NUMBER' | ||
| 36 | , # values: FRAGMENT_NUMBER, SERVER_TIMESTAMP, PRODUCER_TIMESTAMP, NOW, EARLIEST, CONTINUATION_TOKEN | ||
| 37 | AfterFragmentNumber => | ||
| 38 | 'MyFragmentNumberString', # min: 1, max: 128; OPTIONAL | ||
| 39 | ContinuationToken => 'MyContinuationToken', # min: 1, max: 128; OPTIONAL | ||
| 40 | StartTimestamp => '1970-01-01T01:00:00', # OPTIONAL | ||
| 41 | }, | ||
| 42 | StreamARN => 'MyResourceARN', # OPTIONAL | ||
| 43 | StreamName => 'MyStreamName', # OPTIONAL | ||
| 44 | ); | ||
| 45 | |||
| 46 | # Results: | ||
| 47 | my $ContentType = $GetMediaOutput->ContentType; | ||
| 48 | my $Payload = $GetMediaOutput->Payload; | ||
| 49 | |||
| 50 | # Returns a L<Paws::KinesisVideoMedia::GetMediaOutput> object. | ||
| 51 | |||
| 52 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 53 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo/GetMedia> | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> StartSelector => L<Paws::KinesisVideoMedia::StartSelector> | ||
| 59 | |||
| 60 | Identifies the starting chunk to get from the specified stream. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 StreamARN => Str | ||
| 65 | |||
| 66 | The ARN of the stream from where you want to get the media content. If | ||
| 67 | you don't specify the C<streamARN>, you must specify the C<streamName>. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 StreamName => Str | ||
| 72 | |||
| 73 | The Kinesis video stream name from where you want to get the media | ||
| 74 | content. If you don't specify the C<streamName>, you must specify the | ||
| 75 | C<streamARN>. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head1 SEE ALSO | ||
| 81 | |||
| 82 | This class forms part of L<Paws>, documenting arguments for method GetMedia in L<Paws::KinesisVideoMedia> | ||
| 83 | |||
| 84 | =head1 BUGS and CONTRIBUTIONS | ||
| 85 | |||
| 86 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 87 | |||
| 88 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 89 | |||
| 90 | =cut | ||
| 91 |