« blib/lib/Paws/ApiGateway/ClientCertificates.pm
↑ Summary
blib/lib/Paws/ApiGateway/CreateAuthorizer.pm »
| 1 | |||
| 2 | package Paws::ApiGateway::CreateApiKey; | ||
| 3 | use Moose; | ||
| 4 | has CustomerId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'customerId'); | ||
| 5 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 6 | has Enabled => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'enabled'); | ||
| 7 | has GenerateDistinctId => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'generateDistinctId'); | ||
| 8 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name'); | ||
| 9 | has StageKeys => (is => 'ro', isa => 'ArrayRef[Paws::ApiGateway::StageKey]', traits => ['NameInRequest'], request_name => 'stageKeys'); | ||
| 10 | has Tags => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 11 | has Value => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'value'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateApiKey'); | ||
| 16 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/apikeys'); | ||
| 17 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::ApiKey'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::ApiGateway::CreateApiKey - Arguments for method CreateApiKey on L<Paws::ApiGateway> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method CreateApiKey on the | ||
| 30 | L<Amazon API Gateway|Paws::ApiGateway> 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 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $apigateway = Paws->service('ApiGateway'); | ||
| 38 | my $ApiKey = $apigateway->CreateApiKey( | ||
| 39 | CustomerId => 'MyString', # OPTIONAL | ||
| 40 | Description => 'MyString', # OPTIONAL | ||
| 41 | Enabled => 1, # OPTIONAL | ||
| 42 | GenerateDistinctId => 1, # OPTIONAL | ||
| 43 | Name => 'MyString', # OPTIONAL | ||
| 44 | StageKeys => [ | ||
| 45 | { | ||
| 46 | RestApiId => 'MyString', | ||
| 47 | StageName => 'MyString', | ||
| 48 | }, | ||
| 49 | ... | ||
| 50 | ], # OPTIONAL | ||
| 51 | Tags => { 'MyString' => 'MyString', }, # OPTIONAL | ||
| 52 | Value => 'MyString', # OPTIONAL | ||
| 53 | ); | ||
| 54 | |||
| 55 | # Results: | ||
| 56 | my $CreatedDate = $ApiKey->CreatedDate; | ||
| 57 | my $CustomerId = $ApiKey->CustomerId; | ||
| 58 | my $Description = $ApiKey->Description; | ||
| 59 | my $Enabled = $ApiKey->Enabled; | ||
| 60 | my $Id = $ApiKey->Id; | ||
| 61 | my $LastUpdatedDate = $ApiKey->LastUpdatedDate; | ||
| 62 | my $Name = $ApiKey->Name; | ||
| 63 | my $StageKeys = $ApiKey->StageKeys; | ||
| 64 | my $Tags = $ApiKey->Tags; | ||
| 65 | my $Value = $ApiKey->Value; | ||
| 66 | |||
| 67 | # Returns a L<Paws::ApiGateway::ApiKey> object. | ||
| 68 | |||
| 69 | 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. | ||
| 70 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/CreateApiKey> | ||
| 71 | |||
| 72 | =head1 ATTRIBUTES | ||
| 73 | |||
| 74 | |||
| 75 | =head2 CustomerId => Str | ||
| 76 | |||
| 77 | An AWS Marketplace customer identifier , when integrating with the AWS | ||
| 78 | SaaS Marketplace. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 Description => Str | ||
| 83 | |||
| 84 | The description of the ApiKey. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 Enabled => Bool | ||
| 89 | |||
| 90 | Specifies whether the ApiKey can be used by callers. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 GenerateDistinctId => Bool | ||
| 95 | |||
| 96 | Specifies whether (C<true>) or not (C<false>) the key identifier is | ||
| 97 | distinct from the created API key value. This parameter is deprecated | ||
| 98 | and should not be used. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 Name => Str | ||
| 103 | |||
| 104 | The name of the ApiKey. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head2 StageKeys => ArrayRef[L<Paws::ApiGateway::StageKey>] | ||
| 109 | |||
| 110 | DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API | ||
| 111 | key. | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head2 Tags => L<Paws::ApiGateway::MapOfStringToString> | ||
| 116 | |||
| 117 | The key-value map of strings. The valid character set is | ||
| 118 | [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not | ||
| 119 | start with C<aws:>. The tag value can be up to 256 characters. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head2 Value => Str | ||
| 124 | |||
| 125 | Specifies a value of the API key. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head1 SEE ALSO | ||
| 131 | |||
| 132 | This class forms part of L<Paws>, documenting arguments for method CreateApiKey in L<Paws::ApiGateway> | ||
| 133 | |||
| 134 | =head1 BUGS and CONTRIBUTIONS | ||
| 135 | |||
| 136 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 137 | |||
| 138 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 139 | |||
| 140 | =cut | ||
| 141 |