« blib/lib/Paws/Connect/ListQueuesResponse.pm
↑ Summary
blib/lib/Paws/Connect/ListQuickConnectsResponse.pm »
| 1 | |||
| 2 | package Paws::Connect::ListQuickConnects; | ||
| 3 | use Moose; | ||
| 4 | has InstanceId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'InstanceId', required => 1); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 7 | has QuickConnectTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['ParamInQuery'], query_name => 'QuickConnectTypes'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListQuickConnects'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/quick-connects/{InstanceId}'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Connect::ListQuickConnectsResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Connect::ListQuickConnects - Arguments for method ListQuickConnects on L<Paws::Connect> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method ListQuickConnects on the | ||
| 26 | L<Amazon Connect Service|Paws::Connect> service. Use the attributes of this class | ||
| 27 | as arguments to method ListQuickConnects. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListQuickConnects. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $connect = Paws->service('Connect'); | ||
| 34 | my $ListQuickConnectsResponse = $connect->ListQuickConnects( | ||
| 35 | InstanceId => 'MyInstanceId', | ||
| 36 | MaxResults => 1, # OPTIONAL | ||
| 37 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 38 | QuickConnectTypes => [ | ||
| 39 | 'USER', ... # values: USER, QUEUE, PHONE_NUMBER | ||
| 40 | ], # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $NextToken = $ListQuickConnectsResponse->NextToken; | ||
| 45 | my $QuickConnectSummaryList = | ||
| 46 | $ListQuickConnectsResponse->QuickConnectSummaryList; | ||
| 47 | |||
| 48 | # Returns a L<Paws::Connect::ListQuickConnectsResponse> object. | ||
| 49 | |||
| 50 | 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. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/connect/ListQuickConnects> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> InstanceId => Str | ||
| 57 | |||
| 58 | The identifier of the Amazon Connect instance. You can find the | ||
| 59 | instanceId in the ARN of the instance. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 MaxResults => Int | ||
| 64 | |||
| 65 | The maximum number of results to return per page. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 NextToken => Str | ||
| 70 | |||
| 71 | The token for the next set of results. Use the value returned in the | ||
| 72 | previous response in the next request to retrieve the next set of | ||
| 73 | results. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 QuickConnectTypes => ArrayRef[Str|Undef] | ||
| 78 | |||
| 79 | The type of quick connect. In the Amazon Connect console, when you | ||
| 80 | create a quick connect, you are prompted to assign one of the following | ||
| 81 | types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE). | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head1 SEE ALSO | ||
| 87 | |||
| 88 | This class forms part of L<Paws>, documenting arguments for method ListQuickConnects in L<Paws::Connect> | ||
| 89 | |||
| 90 | =head1 BUGS and CONTRIBUTIONS | ||
| 91 | |||
| 92 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 93 | |||
| 94 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 95 | |||
| 96 | =cut | ||
| 97 |