« blib/lib/Paws/KinesisVideoArchivedMedia/HLSTimestampRange.pm
↑ Summary
blib/lib/Paws/KinesisVideoArchivedMedia/ListFragmentsOutput.pm »
| 1 | |||
| 2 | package Paws::KinesisVideoArchivedMedia::ListFragments; | ||
| 3 | use Moose; | ||
| 4 | has FragmentSelector => (is => 'ro', isa => 'Paws::KinesisVideoArchivedMedia::FragmentSelector'); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 7 | has StreamARN => (is => 'ro', isa => 'Str'); | ||
| 8 | has StreamName => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListFragments'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/listFragments'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KinesisVideoArchivedMedia::ListFragmentsOutput'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::KinesisVideoArchivedMedia::ListFragments - Arguments for method ListFragments on L<Paws::KinesisVideoArchivedMedia> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ListFragments on the | ||
| 27 | L<Amazon Kinesis Video Streams Archived Media|Paws::KinesisVideoArchivedMedia> service. Use the attributes of this class | ||
| 28 | as arguments to method ListFragments. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListFragments. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $kinesisvideo = Paws->service('KinesisVideoArchivedMedia'); | ||
| 35 | my $ListFragmentsOutput = $kinesisvideo->ListFragments( | ||
| 36 | FragmentSelector => { | ||
| 37 | FragmentSelectorType => | ||
| 38 | 'PRODUCER_TIMESTAMP', # values: PRODUCER_TIMESTAMP, SERVER_TIMESTAMP | ||
| 39 | TimestampRange => { | ||
| 40 | EndTimestamp => '1970-01-01T01:00:00', | ||
| 41 | StartTimestamp => '1970-01-01T01:00:00', | ||
| 42 | |||
| 43 | }, | ||
| 44 | |||
| 45 | }, # OPTIONAL | ||
| 46 | MaxResults => 1, # OPTIONAL | ||
| 47 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 48 | StreamARN => 'MyResourceARN', # OPTIONAL | ||
| 49 | StreamName => 'MyStreamName', # OPTIONAL | ||
| 50 | ); | ||
| 51 | |||
| 52 | # Results: | ||
| 53 | my $Fragments = $ListFragmentsOutput->Fragments; | ||
| 54 | my $NextToken = $ListFragmentsOutput->NextToken; | ||
| 55 | |||
| 56 | # Returns a L<Paws::KinesisVideoArchivedMedia::ListFragmentsOutput> object. | ||
| 57 | |||
| 58 | 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. | ||
| 59 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo/ListFragments> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 FragmentSelector => L<Paws::KinesisVideoArchivedMedia::FragmentSelector> | ||
| 65 | |||
| 66 | Describes the timestamp range and timestamp origin for the range of | ||
| 67 | fragments to return. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 MaxResults => Int | ||
| 72 | |||
| 73 | The total number of fragments to return. If the total number of | ||
| 74 | fragments available is more than the value specified in C<max-results>, | ||
| 75 | then a ListFragmentsOutput$NextToken is provided in the output that you | ||
| 76 | can use to resume pagination. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 NextToken => Str | ||
| 81 | |||
| 82 | A token to specify where to start paginating. This is the | ||
| 83 | ListFragmentsOutput$NextToken from a previously truncated response. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 StreamARN => Str | ||
| 88 | |||
| 89 | The Amazon Resource Name (ARN) of the stream from which to retrieve a | ||
| 90 | fragment list. Specify either this parameter or the C<StreamName> | ||
| 91 | parameter. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 StreamName => Str | ||
| 96 | |||
| 97 | The name of the stream from which to retrieve a fragment list. Specify | ||
| 98 | either this parameter or the C<StreamARN> parameter. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head1 SEE ALSO | ||
| 104 | |||
| 105 | This class forms part of L<Paws>, documenting arguments for method ListFragments in L<Paws::KinesisVideoArchivedMedia> | ||
| 106 | |||
| 107 | =head1 BUGS and CONTRIBUTIONS | ||
| 108 | |||
| 109 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 110 | |||
| 111 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 112 | |||
| 113 | =cut | ||
| 114 |