« blib/lib/Paws/Connect/CreateIntegrationAssociationResponse.pm
↑ Summary
blib/lib/Paws/Connect/CreateQueueResponse.pm »
| 1 | |||
| 2 | package Paws::Connect::CreateQueue; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str'); | ||
| 5 | has HoursOfOperationId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has InstanceId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'InstanceId', required => 1); | ||
| 7 | has MaxContacts => (is => 'ro', isa => 'Int'); | ||
| 8 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has OutboundCallerConfig => (is => 'ro', isa => 'Paws::Connect::OutboundCallerConfig'); | ||
| 10 | has QuickConnectIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 11 | has Tags => (is => 'ro', isa => 'Paws::Connect::TagMap'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateQueue'); | ||
| 16 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/queues/{InstanceId}'); | ||
| 17 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Connect::CreateQueueResponse'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::Connect::CreateQueue - Arguments for method CreateQueue on L<Paws::Connect> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method CreateQueue on the | ||
| 30 | L<Amazon Connect Service|Paws::Connect> service. Use the attributes of this class | ||
| 31 | as arguments to method CreateQueue. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateQueue. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $connect = Paws->service('Connect'); | ||
| 38 | my $CreateQueueResponse = $connect->CreateQueue( | ||
| 39 | HoursOfOperationId => 'MyHoursOfOperationId', | ||
| 40 | InstanceId => 'MyInstanceId', | ||
| 41 | Name => 'MyCommonNameLength127', | ||
| 42 | Description => 'MyQueueDescription', # OPTIONAL | ||
| 43 | MaxContacts => 1, # OPTIONAL | ||
| 44 | OutboundCallerConfig => { | ||
| 45 | OutboundCallerIdName => | ||
| 46 | 'MyOutboundCallerIdName', # min: 1, max: 255; OPTIONAL | ||
| 47 | OutboundCallerIdNumberId => 'MyPhoneNumberId', # OPTIONAL | ||
| 48 | OutboundFlowId => 'MyContactFlowId', # max: 500; OPTIONAL | ||
| 49 | }, # OPTIONAL | ||
| 50 | QuickConnectIds => [ 'MyQuickConnectId', ... ], # OPTIONAL | ||
| 51 | Tags => { | ||
| 52 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 53 | }, # OPTIONAL | ||
| 54 | ); | ||
| 55 | |||
| 56 | # Results: | ||
| 57 | my $QueueArn = $CreateQueueResponse->QueueArn; | ||
| 58 | my $QueueId = $CreateQueueResponse->QueueId; | ||
| 59 | |||
| 60 | # Returns a L<Paws::Connect::CreateQueueResponse> object. | ||
| 61 | |||
| 62 | 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. | ||
| 63 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/connect/CreateQueue> | ||
| 64 | |||
| 65 | =head1 ATTRIBUTES | ||
| 66 | |||
| 67 | |||
| 68 | =head2 Description => Str | ||
| 69 | |||
| 70 | The description of the queue. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> HoursOfOperationId => Str | ||
| 75 | |||
| 76 | The identifier for the hours of operation. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> InstanceId => Str | ||
| 81 | |||
| 82 | The identifier of the Amazon Connect instance. You can find the | ||
| 83 | instanceId in the ARN of the instance. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 MaxContacts => Int | ||
| 88 | |||
| 89 | The maximum number of contacts that can be in the queue before it is | ||
| 90 | considered full. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 B<REQUIRED> Name => Str | ||
| 95 | |||
| 96 | The name of the queue. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 OutboundCallerConfig => L<Paws::Connect::OutboundCallerConfig> | ||
| 101 | |||
| 102 | The outbound caller ID name, number, and outbound whisper flow. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 QuickConnectIds => ArrayRef[Str|Undef] | ||
| 107 | |||
| 108 | The quick connects available to agents who are working the queue. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 Tags => L<Paws::Connect::TagMap> | ||
| 113 | |||
| 114 | One or more tags. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head1 SEE ALSO | ||
| 120 | |||
| 121 | This class forms part of L<Paws>, documenting arguments for method CreateQueue in L<Paws::Connect> | ||
| 122 | |||
| 123 | =head1 BUGS and CONTRIBUTIONS | ||
| 124 | |||
| 125 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 126 | |||
| 127 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 128 | |||
| 129 | =cut | ||
| 130 |