« blib/lib/Paws/KinesisVideoArchivedMedia/FragmentSelector.pm
↑ Summary
blib/lib/Paws/KinesisVideoArchivedMedia/GetClipOutput.pm »
| 1 | |||
| 2 | package Paws::KinesisVideoArchivedMedia::GetClip; | ||
| 3 | use Moose; | ||
| 4 | has ClipFragmentSelector => (is => 'ro', isa => 'Paws::KinesisVideoArchivedMedia::ClipFragmentSelector', 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 => 'GetClip'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/getClip'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KinesisVideoArchivedMedia::GetClipOutput'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::KinesisVideoArchivedMedia::GetClip - Arguments for method GetClip on L<Paws::KinesisVideoArchivedMedia> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method GetClip on the | ||
| 25 | L<Amazon Kinesis Video Streams Archived Media|Paws::KinesisVideoArchivedMedia> service. Use the attributes of this class | ||
| 26 | as arguments to method GetClip. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetClip. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $kinesisvideo = Paws->service('KinesisVideoArchivedMedia'); | ||
| 33 | my $GetClipOutput = $kinesisvideo->GetClip( | ||
| 34 | ClipFragmentSelector => { | ||
| 35 | FragmentSelectorType => | ||
| 36 | 'PRODUCER_TIMESTAMP', # values: PRODUCER_TIMESTAMP, SERVER_TIMESTAMP | ||
| 37 | TimestampRange => { | ||
| 38 | EndTimestamp => '1970-01-01T01:00:00', | ||
| 39 | StartTimestamp => '1970-01-01T01:00:00', | ||
| 40 | |||
| 41 | }, | ||
| 42 | |||
| 43 | }, | ||
| 44 | StreamARN => 'MyResourceARN', # OPTIONAL | ||
| 45 | StreamName => 'MyStreamName', # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $ContentType = $GetClipOutput->ContentType; | ||
| 50 | my $Payload = $GetClipOutput->Payload; | ||
| 51 | |||
| 52 | # Returns a L<Paws::KinesisVideoArchivedMedia::GetClipOutput> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo/GetClip> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> ClipFragmentSelector => L<Paws::KinesisVideoArchivedMedia::ClipFragmentSelector> | ||
| 61 | |||
| 62 | The time range of the requested clip and the source of the timestamps. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 StreamARN => Str | ||
| 67 | |||
| 68 | The Amazon Resource Name (ARN) of the stream for which to retrieve the | ||
| 69 | media clip. | ||
| 70 | |||
| 71 | You must specify either the StreamName or the StreamARN. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 StreamName => Str | ||
| 76 | |||
| 77 | The name of the stream for which to retrieve the media clip. | ||
| 78 | |||
| 79 | You must specify either the StreamName or the StreamARN. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head1 SEE ALSO | ||
| 85 | |||
| 86 | This class forms part of L<Paws>, documenting arguments for method GetClip in L<Paws::KinesisVideoArchivedMedia> | ||
| 87 | |||
| 88 | =head1 BUGS and CONTRIBUTIONS | ||
| 89 | |||
| 90 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 91 | |||
| 92 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 93 | |||
| 94 | =cut | ||
| 95 |