« blib/lib/Paws/WorkDocs/CreateLabelsResponse.pm
↑ Summary
blib/lib/Paws/WorkDocs/CreateNotificationSubscriptionResponse.pm »
| 1 | |||
| 2 | package Paws::WorkDocs::CreateNotificationSubscription; | ||
| 3 | use Moose; | ||
| 4 | has Endpoint => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has OrganizationId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'OrganizationId', required => 1); | ||
| 6 | has Protocol => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has SubscriptionType => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateNotificationSubscription'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/api/v1/organizations/{OrganizationId}/subscriptions'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WorkDocs::CreateNotificationSubscriptionResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::WorkDocs::CreateNotificationSubscription - Arguments for method CreateNotificationSubscription on L<Paws::WorkDocs> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateNotificationSubscription on the | ||
| 26 | L<Amazon WorkDocs|Paws::WorkDocs> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateNotificationSubscription. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateNotificationSubscription. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $workdocs = Paws->service('WorkDocs'); | ||
| 34 | my $CreateNotificationSubscriptionResponse = | ||
| 35 | $workdocs->CreateNotificationSubscription( | ||
| 36 | Endpoint => 'MySubscriptionEndPointType', | ||
| 37 | OrganizationId => 'MyIdType', | ||
| 38 | Protocol => 'HTTPS', | ||
| 39 | SubscriptionType => 'ALL', | ||
| 40 | |||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $Subscription = $CreateNotificationSubscriptionResponse->Subscription; | ||
| 45 | |||
| 46 | # Returns a L<Paws::WorkDocs::CreateNotificationSubscriptionResponse> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/workdocs/CreateNotificationSubscription> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> Endpoint => Str | ||
| 55 | |||
| 56 | The endpoint to receive the notifications. If the protocol is HTTPS, | ||
| 57 | the endpoint is a URL that begins with C<https>. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> OrganizationId => Str | ||
| 62 | |||
| 63 | The ID of the organization. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> Protocol => Str | ||
| 68 | |||
| 69 | The protocol to use. The supported value is https, which delivers | ||
| 70 | JSON-encoded messages using HTTPS POST. | ||
| 71 | |||
| 72 | Valid values are: C<"HTTPS"> | ||
| 73 | |||
| 74 | =head2 B<REQUIRED> SubscriptionType => Str | ||
| 75 | |||
| 76 | The notification type. | ||
| 77 | |||
| 78 | Valid values are: C<"ALL"> | ||
| 79 | |||
| 80 | |||
| 81 | =head1 SEE ALSO | ||
| 82 | |||
| 83 | This class forms part of L<Paws>, documenting arguments for method CreateNotificationSubscription in L<Paws::WorkDocs> | ||
| 84 | |||
| 85 | =head1 BUGS and CONTRIBUTIONS | ||
| 86 | |||
| 87 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 88 | |||
| 89 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 90 | |||
| 91 | =cut | ||
| 92 |