« blib/lib/Paws/AppSync/CreateApiCacheResponse.pm
↑ Summary
blib/lib/Paws/AppSync/CreateApiKeyResponse.pm »
| 1 | |||
| 2 | package Paws::AppSync::CreateApiKey; | ||
| 3 | use Moose; | ||
| 4 | has ApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'apiId', required => 1); | ||
| 5 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 6 | has Expires => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'expires'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateApiKey'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/apis/{apiId}/apikeys'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AppSync::CreateApiKeyResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::AppSync::CreateApiKey - Arguments for method CreateApiKey on L<Paws::AppSync> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method CreateApiKey on the | ||
| 25 | L<AWS AppSync|Paws::AppSync> service. Use the attributes of this class | ||
| 26 | as arguments to method CreateApiKey. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateApiKey. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $appsync = Paws->service('AppSync'); | ||
| 33 | my $CreateApiKeyResponse = $appsync->CreateApiKey( | ||
| 34 | ApiId => 'MyString', | ||
| 35 | Description => 'MyString', # OPTIONAL | ||
| 36 | Expires => 1, # OPTIONAL | ||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $ApiKey = $CreateApiKeyResponse->ApiKey; | ||
| 41 | |||
| 42 | # Returns a L<Paws::AppSync::CreateApiKeyResponse> object. | ||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/appsync/CreateApiKey> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> ApiId => Str | ||
| 51 | |||
| 52 | The ID for your GraphQL API. | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | =head2 Description => Str | ||
| 57 | |||
| 58 | A description of the purpose of the API key. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 Expires => Int | ||
| 63 | |||
| 64 | The time from creation time after which the API key expires. The date | ||
| 65 | is represented as seconds since the epoch, rounded down to the nearest | ||
| 66 | hour. The default value for this parameter is 7 days from creation | ||
| 67 | time. For more information, see . | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head1 SEE ALSO | ||
| 73 | |||
| 74 | This class forms part of L<Paws>, documenting arguments for method CreateApiKey in L<Paws::AppSync> | ||
| 75 | |||
| 76 | =head1 BUGS and CONTRIBUTIONS | ||
| 77 | |||
| 78 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 79 | |||
| 80 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 81 | |||
| 82 | =cut | ||
| 83 |