GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::ApiGateway::CreateApiKey(3) User Contributed Perl Documentation Paws::ApiGateway::CreateApiKey(3)

Paws::ApiGateway::CreateApiKey - Arguments for method CreateApiKey on Paws::ApiGateway

This class represents the parameters used for calling the method CreateApiKey on the Amazon API Gateway service. Use the attributes of this class as arguments to method CreateApiKey.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateApiKey.

    my $apigateway = Paws->service('ApiGateway');
    my $ApiKey = $apigateway->CreateApiKey(
      CustomerId         => 'MyString',    # OPTIONAL
      Description        => 'MyString',    # OPTIONAL
      Enabled            => 1,             # OPTIONAL
      GenerateDistinctId => 1,             # OPTIONAL
      Name               => 'MyString',    # OPTIONAL
      StageKeys          => [
        {
          RestApiId => 'MyString',
          StageName => 'MyString',
        },
        ...
      ],                                   # OPTIONAL
      Tags  => { 'MyString' => 'MyString', },    # OPTIONAL
      Value => 'MyString',                       # OPTIONAL
    );
    # Results:
    my $CreatedDate     = $ApiKey->CreatedDate;
    my $CustomerId      = $ApiKey->CustomerId;
    my $Description     = $ApiKey->Description;
    my $Enabled         = $ApiKey->Enabled;
    my $Id              = $ApiKey->Id;
    my $LastUpdatedDate = $ApiKey->LastUpdatedDate;
    my $Name            = $ApiKey->Name;
    my $StageKeys       = $ApiKey->StageKeys;
    my $Tags            = $ApiKey->Tags;
    my $Value           = $ApiKey->Value;
    # Returns a L<Paws::ApiGateway::ApiKey> object.

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. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/apigateway/CreateApiKey>

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

The description of the ApiKey.

Specifies whether the ApiKey can be used by callers.

Specifies whether ("true") or not ("false") the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

The name of the ApiKey.

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with "aws:". The tag value can be up to 256 characters.

Specifies a value of the API key.

This class forms part of Paws, documenting arguments for method CreateApiKey in Paws::ApiGateway

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.