File Coverage

blib/lib/Paws/ApiGateway/CreateApiKey.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::ApiGateway::CreateApiKey;
3 1     1   509 use Moose;
  1         3  
  1         7  
4             has CustomerId => (is => 'ro', isa => 'Str');
5             has Description => (is => 'ro', isa => 'Str');
6             has Enabled => (is => 'ro', isa => 'Bool');
7             has GenerateDistinctId => (is => 'ro', isa => 'Bool');
8             has Name => (is => 'ro', isa => 'Str');
9             has StageKeys => (is => 'ro', isa => 'ArrayRef[Paws::ApiGateway::StageKey]');
10             has Value => (is => 'ro', isa => 'Str');
11              
12 1     1   6308 use MooseX::ClassAttribute;
  1         3  
  1         8  
13              
14             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateApiKey');
15             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/apikeys');
16             class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
17             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::ApiKey');
18             class_has _result_key => (isa => 'Str', is => 'ro');
19             1;
20              
21             ### main pod documentation begin ###
22              
23             =head1 NAME
24              
25             Paws::ApiGateway::CreateApiKey - Arguments for method CreateApiKey on Paws::ApiGateway
26              
27             =head1 DESCRIPTION
28              
29             This class represents the parameters used for calling the method CreateApiKey on the
30             Amazon API Gateway service. Use the attributes of this class
31             as arguments to method CreateApiKey.
32              
33             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateApiKey.
34              
35             As an example:
36              
37             $service_obj->CreateApiKey(Att1 => $value1, Att2 => $value2, ...);
38              
39             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.
40              
41             =head1 ATTRIBUTES
42              
43              
44             =head2 CustomerId => Str
45              
46             An AWS Marketplace customer identifier , when integrating with the AWS
47             SaaS Marketplace.
48              
49              
50              
51             =head2 Description => Str
52              
53             The description of the ApiKey.
54              
55              
56              
57             =head2 Enabled => Bool
58              
59             Specifies whether the ApiKey can be used by callers.
60              
61              
62              
63             =head2 GenerateDistinctId => Bool
64              
65             Specifies whether (C<true>) or not (C<false>) the key identifier is
66             distinct from the created API key value.
67              
68              
69              
70             =head2 Name => Str
71              
72             The name of the ApiKey.
73              
74              
75              
76             =head2 StageKeys => ArrayRef[L<Paws::ApiGateway::StageKey>]
77              
78             DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API
79             key.
80              
81              
82              
83             =head2 Value => Str
84              
85             Specifies a value of the API key.
86              
87              
88              
89              
90             =head1 SEE ALSO
91              
92             This class forms part of L<Paws>, documenting arguments for method CreateApiKey in L<Paws::ApiGateway>
93              
94             =head1 BUGS and CONTRIBUTIONS
95              
96             The source code is located here: https://github.com/pplu/aws-sdk-perl
97              
98             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
99              
100             =cut
101