« blib/lib/Paws/KinesisVideo/DescribeStreamOutput.pm
↑ Summary
blib/lib/Paws/KinesisVideo/GetDataEndpointOutput.pm »
| 1 | |||
| 2 | package Paws::KinesisVideo::GetDataEndpoint; | ||
| 3 | use Moose; | ||
| 4 | has APIName => (is => 'ro', isa => 'Str', 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 => 'GetDataEndpoint'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/getDataEndpoint'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KinesisVideo::GetDataEndpointOutput'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::KinesisVideo::GetDataEndpoint - Arguments for method GetDataEndpoint on L<Paws::KinesisVideo> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method GetDataEndpoint on the | ||
| 25 | L<Amazon Kinesis Video Streams|Paws::KinesisVideo> service. Use the attributes of this class | ||
| 26 | as arguments to method GetDataEndpoint. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetDataEndpoint. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $kinesisvideo = Paws->service('KinesisVideo'); | ||
| 33 | my $GetDataEndpointOutput = $kinesisvideo->GetDataEndpoint( | ||
| 34 | APIName => 'PUT_MEDIA', | ||
| 35 | StreamARN => 'MyResourceARN', # OPTIONAL | ||
| 36 | StreamName => 'MyStreamName', # OPTIONAL | ||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $DataEndpoint = $GetDataEndpointOutput->DataEndpoint; | ||
| 41 | |||
| 42 | # Returns a L<Paws::KinesisVideo::GetDataEndpointOutput> object. | ||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo/GetDataEndpoint> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> APIName => Str | ||
| 51 | |||
| 52 | The name of the API action for which to get an endpoint. | ||
| 53 | |||
| 54 | Valid values are: C<"PUT_MEDIA">, C<"GET_MEDIA">, C<"LIST_FRAGMENTS">, C<"GET_MEDIA_FOR_FRAGMENT_LIST">, C<"GET_HLS_STREAMING_SESSION_URL">, C<"GET_DASH_STREAMING_SESSION_URL">, C<"GET_CLIP"> | ||
| 55 | |||
| 56 | =head2 StreamARN => Str | ||
| 57 | |||
| 58 | The Amazon Resource Name (ARN) of the stream that you want to get the | ||
| 59 | endpoint for. You must specify either this parameter or a C<StreamName> | ||
| 60 | in the request. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 StreamName => Str | ||
| 65 | |||
| 66 | The name of the stream that you want to get the endpoint for. You must | ||
| 67 | specify either this parameter or a C<StreamARN> in the request. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head1 SEE ALSO | ||
| 73 | |||
| 74 | This class forms part of L<Paws>, documenting arguments for method GetDataEndpoint in L<Paws::KinesisVideo> | ||
| 75 | |||
| 76 | =head1 BUGS and CONTRIBUTIONS | ||
| 77 | |||
| 78 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 79 | |||
| 80 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 81 | |||
| 82 | =cut | ||
| 83 |