« blib/lib/Paws/ConnectParticipant/SendMessageResponse.pm
↑ Summary
blib/lib/Paws/ConnectParticipant/StartAttachmentUploadResponse.pm »
| 1 | |||
| 2 | package Paws::ConnectParticipant::StartAttachmentUpload; | ||
| 3 | use Moose; | ||
| 4 | has AttachmentName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has AttachmentSizeInBytes => (is => 'ro', isa => 'Int', required => 1); | ||
| 6 | has ClientToken => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has ConnectionToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'X-Amz-Bearer', required => 1); | ||
| 8 | has ContentType => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartAttachmentUpload'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/participant/start-attachment-upload'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ConnectParticipant::StartAttachmentUploadResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::ConnectParticipant::StartAttachmentUpload - Arguments for method StartAttachmentUpload on L<Paws::ConnectParticipant> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method StartAttachmentUpload on the | ||
| 27 | L<Amazon Connect Participant Service|Paws::ConnectParticipant> service. Use the attributes of this class | ||
| 28 | as arguments to method StartAttachmentUpload. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartAttachmentUpload. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $participant.connect = Paws->service('ConnectParticipant'); | ||
| 35 | my $StartAttachmentUploadResponse = | ||
| 36 | $participant . connect->StartAttachmentUpload( | ||
| 37 | AttachmentName => 'MyAttachmentName', | ||
| 38 | AttachmentSizeInBytes => 1, | ||
| 39 | ClientToken => 'MyNonEmptyClientToken', | ||
| 40 | ConnectionToken => 'MyParticipantToken', | ||
| 41 | ContentType => 'MyContentType', | ||
| 42 | |||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $AttachmentId = $StartAttachmentUploadResponse->AttachmentId; | ||
| 47 | my $UploadMetadata = $StartAttachmentUploadResponse->UploadMetadata; | ||
| 48 | |||
| 49 | # Returns a L<Paws::ConnectParticipant::StartAttachmentUploadResponse> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/participant.connect/StartAttachmentUpload> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> AttachmentName => Str | ||
| 58 | |||
| 59 | A case-sensitive name of the attachment being uploaded. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> AttachmentSizeInBytes => Int | ||
| 64 | |||
| 65 | The size of the attachment in bytes. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> ClientToken => Str | ||
| 70 | |||
| 71 | A unique case sensitive identifier to support idempotency of request. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> ConnectionToken => Str | ||
| 76 | |||
| 77 | The authentication token associated with the participant's connection. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 B<REQUIRED> ContentType => Str | ||
| 82 | |||
| 83 | Describes the MIME file type of the attachment. For a list of supported | ||
| 84 | file types, see Feature specifications | ||
| 85 | (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits) | ||
| 86 | in the I<Amazon Connect Administrator Guide>. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head1 SEE ALSO | ||
| 92 | |||
| 93 | This class forms part of L<Paws>, documenting arguments for method StartAttachmentUpload in L<Paws::ConnectParticipant> | ||
| 94 | |||
| 95 | =head1 BUGS and CONTRIBUTIONS | ||
| 96 | |||
| 97 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 98 | |||
| 99 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 100 | |||
| 101 | =cut | ||
| 102 |