« blib/lib/Paws/MediaConvert/DeleteQueueResponse.pm
↑ Summary
blib/lib/Paws/MediaConvert/DescribeEndpointsResponse.pm »
| 1 | |||
| 2 | package Paws::MediaConvert::DescribeEndpoints; | ||
| 3 | use Moose; | ||
| 4 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults'); | ||
| 5 | has Mode => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'mode'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeEndpoints'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/2017-08-29/endpoints'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MediaConvert::DescribeEndpointsResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::MediaConvert::DescribeEndpoints - Arguments for method DescribeEndpoints on L<Paws::MediaConvert> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DescribeEndpoints on the | ||
| 25 | L<AWS Elemental MediaConvert|Paws::MediaConvert> service. Use the attributes of this class | ||
| 26 | as arguments to method DescribeEndpoints. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeEndpoints. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $mediaconvert = Paws->service('MediaConvert'); | ||
| 33 | my $DescribeEndpointsResponse = $mediaconvert->DescribeEndpoints( | ||
| 34 | MaxResults => 1, # OPTIONAL | ||
| 35 | Mode => 'DEFAULT', # OPTIONAL | ||
| 36 | NextToken => 'My__string', # OPTIONAL | ||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $Endpoints = $DescribeEndpointsResponse->Endpoints; | ||
| 41 | my $NextToken = $DescribeEndpointsResponse->NextToken; | ||
| 42 | |||
| 43 | # Returns a L<Paws::MediaConvert::DescribeEndpointsResponse> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/mediaconvert/DescribeEndpoints> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 MaxResults => Int | ||
| 52 | |||
| 53 | Optional. Max number of endpoints, up to twenty, that will be returned | ||
| 54 | at one time. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 Mode => Str | ||
| 59 | |||
| 60 | Optional field, defaults to DEFAULT. Specify DEFAULT for this operation | ||
| 61 | to return your endpoints if any exist, or to create an endpoint for you | ||
| 62 | and return it if one doesn't already exist. Specify GET_ONLY to return | ||
| 63 | your endpoints if any exist, or an empty list if none exist. | ||
| 64 | |||
| 65 | Valid values are: C<"DEFAULT">, C<"GET_ONLY"> | ||
| 66 | |||
| 67 | =head2 NextToken => Str | ||
| 68 | |||
| 69 | Use this string, provided with the response to a previous request, to | ||
| 70 | request the next batch of endpoints. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head1 SEE ALSO | ||
| 76 | |||
| 77 | This class forms part of L<Paws>, documenting arguments for method DescribeEndpoints in L<Paws::MediaConvert> | ||
| 78 | |||
| 79 | =head1 BUGS and CONTRIBUTIONS | ||
| 80 | |||
| 81 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 82 | |||
| 83 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 84 | |||
| 85 | =cut | ||
| 86 |