Paws::ApiGateway - Perl Interface to AWS Amazon API Gateway
use Paws; my $obj = Paws->service('ApiGateway'); my $res = $obj->Method( Arg1 => $val1, Arg2 => [ 'V1', 'V2' ], # if Arg3 is an object, the HashRef will be used as arguments to the constructor # of the arguments type Arg3 => { Att1 => 'Val1' }, # if Arg4 is an array of objects, the HashRefs will be passed as arguments to # the constructor of the arguments type Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], );
Amazon API Gateway
Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
For the AWS API documentation, see https://docs.aws.amazon.com/apigateway/
Each argument is described in detail in: Paws::ApiGateway::CreateApiKey
Returns: a Paws::ApiGateway::ApiKey instance
Create an ApiKey resource.
AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html)
Each argument is described in detail in: Paws::ApiGateway::CreateAuthorizer
Returns: a Paws::ApiGateway::Authorizer instance
Adds a new Authorizer resource to an existing RestApi resource.
AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-authorizer.html)
Each argument is described in detail in: Paws::ApiGateway::CreateBasePathMapping
Returns: a Paws::ApiGateway::BasePathMapping instance
Creates a new BasePathMapping resource.
Each argument is described in detail in: Paws::ApiGateway::CreateDeployment
Returns: a Paws::ApiGateway::Deployment instance
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
Each argument is described in detail in: Paws::ApiGateway::CreateDocumentationPart
Returns: a Paws::ApiGateway::DocumentationPart instance
Each argument is described in detail in: Paws::ApiGateway::CreateDocumentationVersion
Returns: a Paws::ApiGateway::DocumentationVersion instance
Each argument is described in detail in: Paws::ApiGateway::CreateDomainName
Returns: a Paws::ApiGateway::DomainName instance
Creates a new domain name.
Each argument is described in detail in: Paws::ApiGateway::CreateModel
Returns: a Paws::ApiGateway::Model instance
Adds a new Model resource to an existing RestApi resource.
Each argument is described in detail in: Paws::ApiGateway::CreateRequestValidator
Returns: a Paws::ApiGateway::RequestValidator instance
Creates a ReqeustValidator of a given RestApi.
Each argument is described in detail in: Paws::ApiGateway::CreateResource
Returns: a Paws::ApiGateway::Resource instance
Creates a Resource resource.
Each argument is described in detail in: Paws::ApiGateway::CreateRestApi
Returns: a Paws::ApiGateway::RestApi instance
Creates a new RestApi resource.
Each argument is described in detail in: Paws::ApiGateway::CreateStage
Returns: a Paws::ApiGateway::Stage instance
Creates a new Stage resource that references a pre-existing Deployment for the API.
Each argument is described in detail in: Paws::ApiGateway::CreateUsagePlan
Returns: a Paws::ApiGateway::UsagePlan instance
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
Each argument is described in detail in: Paws::ApiGateway::CreateUsagePlanKey
Returns: a Paws::ApiGateway::UsagePlanKey instance
Creates a usage plan key for adding an existing API key to a usage plan.
Each argument is described in detail in: Paws::ApiGateway::CreateVpcLink
Returns: a Paws::ApiGateway::VpcLink instance
Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
Each argument is described in detail in: Paws::ApiGateway::DeleteApiKey
Returns: nothing
Deletes the ApiKey resource.
Each argument is described in detail in: Paws::ApiGateway::DeleteAuthorizer
Deletes an existing Authorizer resource.
AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/delete-authorizer.html)
Each argument is described in detail in: Paws::ApiGateway::DeleteBasePathMapping
Deletes the BasePathMapping resource.
Each argument is described in detail in: Paws::ApiGateway::DeleteClientCertificate
Deletes the ClientCertificate resource.
Each argument is described in detail in: Paws::ApiGateway::DeleteDeployment
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
Each argument is described in detail in: Paws::ApiGateway::DeleteDocumentationPart
Each argument is described in detail in: Paws::ApiGateway::DeleteDocumentationVersion
Each argument is described in detail in: Paws::ApiGateway::DeleteDomainName
Deletes the DomainName resource.
Each argument is described in detail in: Paws::ApiGateway::DeleteGatewayResponse
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
Each argument is described in detail in: Paws::ApiGateway::DeleteIntegration
Represents a delete integration.
Each argument is described in detail in: Paws::ApiGateway::DeleteIntegrationResponse
Represents a delete integration response.
Each argument is described in detail in: Paws::ApiGateway::DeleteMethod
Deletes an existing Method resource.
Each argument is described in detail in: Paws::ApiGateway::DeleteMethodResponse
Deletes an existing MethodResponse resource.
Each argument is described in detail in: Paws::ApiGateway::DeleteModel
Deletes a model.
Each argument is described in detail in: Paws::ApiGateway::DeleteRequestValidator
Deletes a RequestValidator of a given RestApi.
Each argument is described in detail in: Paws::ApiGateway::DeleteResource
Deletes a Resource resource.
Each argument is described in detail in: Paws::ApiGateway::DeleteRestApi
Deletes the specified API.
Each argument is described in detail in: Paws::ApiGateway::DeleteStage
Deletes a Stage resource.
Each argument is described in detail in: Paws::ApiGateway::DeleteUsagePlan
Deletes a usage plan of a given plan Id.
Each argument is described in detail in: Paws::ApiGateway::DeleteUsagePlanKey
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
Each argument is described in detail in: Paws::ApiGateway::DeleteVpcLink
Deletes an existing VpcLink of a specified identifier.
Each argument is described in detail in: Paws::ApiGateway::FlushStageAuthorizersCache
Flushes all authorizer cache entries on a stage.
Each argument is described in detail in: Paws::ApiGateway::FlushStageCache
Flushes a stage's cache.
Each argument is described in detail in: Paws::ApiGateway::GenerateClientCertificate
Returns: a Paws::ApiGateway::ClientCertificate instance
Generates a ClientCertificate resource.
Each argument is described in detail in: Paws::ApiGateway::GetAccount
Returns: a Paws::ApiGateway::Account instance
Gets information about the current Account resource.
Each argument is described in detail in: Paws::ApiGateway::GetApiKey
Gets information about the current ApiKey resource.
Each argument is described in detail in: Paws::ApiGateway::GetApiKeys
Returns: a Paws::ApiGateway::ApiKeys instance
Gets information about the current ApiKeys resource.
Each argument is described in detail in: Paws::ApiGateway::GetAuthorizer
Describe an existing Authorizer resource.
AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizer.html)
Each argument is described in detail in: Paws::ApiGateway::GetAuthorizers
Returns: a Paws::ApiGateway::Authorizers instance
Describe an existing Authorizers resource.
AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizers.html)
Each argument is described in detail in: Paws::ApiGateway::GetBasePathMapping
Describe a BasePathMapping resource.
Each argument is described in detail in: Paws::ApiGateway::GetBasePathMappings
Returns: a Paws::ApiGateway::BasePathMappings instance
Represents a collection of BasePathMapping resources.
Each argument is described in detail in: Paws::ApiGateway::GetClientCertificate
Gets information about the current ClientCertificate resource.
Each argument is described in detail in: Paws::ApiGateway::GetClientCertificates
Returns: a Paws::ApiGateway::ClientCertificates instance
Gets a collection of ClientCertificate resources.
Each argument is described in detail in: Paws::ApiGateway::GetDeployment
Gets information about a Deployment resource.
Each argument is described in detail in: Paws::ApiGateway::GetDeployments
Returns: a Paws::ApiGateway::Deployments instance
Gets information about a Deployments collection.
Each argument is described in detail in: Paws::ApiGateway::GetDocumentationPart
Each argument is described in detail in: Paws::ApiGateway::GetDocumentationParts
Returns: a Paws::ApiGateway::DocumentationParts instance
Each argument is described in detail in: Paws::ApiGateway::GetDocumentationVersion
Each argument is described in detail in: Paws::ApiGateway::GetDocumentationVersions
Returns: a Paws::ApiGateway::DocumentationVersions instance
Each argument is described in detail in: Paws::ApiGateway::GetDomainName
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
Each argument is described in detail in: Paws::ApiGateway::GetDomainNames
Returns: a Paws::ApiGateway::DomainNames instance
Represents a collection of DomainName resources.
Each argument is described in detail in: Paws::ApiGateway::GetExport
Returns: a Paws::ApiGateway::ExportResponse instance
Exports a deployed version of a RestApi in a specified format.
Each argument is described in detail in: Paws::ApiGateway::GetGatewayResponse
Returns: a Paws::ApiGateway::GatewayResponse instance
Gets a GatewayResponse of a specified response type on the given RestApi.
Each argument is described in detail in: Paws::ApiGateway::GetGatewayResponses
Returns: a Paws::ApiGateway::GatewayResponses instance
Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
Each argument is described in detail in: Paws::ApiGateway::GetIntegration
Returns: a Paws::ApiGateway::Integration instance
Get the integration settings.
Each argument is described in detail in: Paws::ApiGateway::GetIntegrationResponse
Returns: a Paws::ApiGateway::IntegrationResponse instance
Represents a get integration response.
Each argument is described in detail in: Paws::ApiGateway::GetMethod
Returns: a Paws::ApiGateway::Method instance
Describe an existing Method resource.
Each argument is described in detail in: Paws::ApiGateway::GetMethodResponse
Returns: a Paws::ApiGateway::MethodResponse instance
Describes a MethodResponse resource.
Each argument is described in detail in: Paws::ApiGateway::GetModel
Describes an existing model defined for a RestApi resource.
Each argument is described in detail in: Paws::ApiGateway::GetModels
Returns: a Paws::ApiGateway::Models instance
Describes existing Models defined for a RestApi resource.
Each argument is described in detail in: Paws::ApiGateway::GetModelTemplate
Returns: a Paws::ApiGateway::Template instance
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
Each argument is described in detail in: Paws::ApiGateway::GetRequestValidator
Gets a RequestValidator of a given RestApi.
Each argument is described in detail in: Paws::ApiGateway::GetRequestValidators
Returns: a Paws::ApiGateway::RequestValidators instance
Gets the RequestValidators collection of a given RestApi.
Each argument is described in detail in: Paws::ApiGateway::GetResource
Lists information about a resource.
Each argument is described in detail in: Paws::ApiGateway::GetResources
Returns: a Paws::ApiGateway::Resources instance
Lists information about a collection of Resource resources.
Each argument is described in detail in: Paws::ApiGateway::GetRestApi
Lists the RestApi resource in the collection.
Each argument is described in detail in: Paws::ApiGateway::GetRestApis
Returns: a Paws::ApiGateway::RestApis instance
Lists the RestApis resources for your collection.
Each argument is described in detail in: Paws::ApiGateway::GetSdk
Returns: a Paws::ApiGateway::SdkResponse instance
Generates a client SDK for a RestApi and Stage.
Each argument is described in detail in: Paws::ApiGateway::GetSdkType
Returns: a Paws::ApiGateway::SdkType instance
Each argument is described in detail in: Paws::ApiGateway::GetSdkTypes
Returns: a Paws::ApiGateway::SdkTypes instance
Each argument is described in detail in: Paws::ApiGateway::GetStage
Gets information about a Stage resource.
Each argument is described in detail in: Paws::ApiGateway::GetStages
Returns: a Paws::ApiGateway::Stages instance
Gets information about one or more Stage resources.
Each argument is described in detail in: Paws::ApiGateway::GetTags
Returns: a Paws::ApiGateway::Tags instance
Gets the Tags collection for a given resource.
Each argument is described in detail in: Paws::ApiGateway::GetUsage
Returns: a Paws::ApiGateway::Usage instance
Gets the usage data of a usage plan in a specified time interval.
Each argument is described in detail in: Paws::ApiGateway::GetUsagePlan
Gets a usage plan of a given plan identifier.
Each argument is described in detail in: Paws::ApiGateway::GetUsagePlanKey
Gets a usage plan key of a given key identifier.
Each argument is described in detail in: Paws::ApiGateway::GetUsagePlanKeys
Returns: a Paws::ApiGateway::UsagePlanKeys instance
Gets all the usage plan keys representing the API keys added to a specified usage plan.
Each argument is described in detail in: Paws::ApiGateway::GetUsagePlans
Returns: a Paws::ApiGateway::UsagePlans instance
Gets all the usage plans of the caller's account.
Each argument is described in detail in: Paws::ApiGateway::GetVpcLink
Gets a specified VPC link under the caller's account in a region.
Each argument is described in detail in: Paws::ApiGateway::GetVpcLinks
Returns: a Paws::ApiGateway::VpcLinks instance
Gets the VpcLinks collection under the caller's account in a selected region.
Each argument is described in detail in: Paws::ApiGateway::ImportApiKeys
Returns: a Paws::ApiGateway::ApiKeyIds instance
Import API keys from an external source, such as a CSV-formatted file.
Each argument is described in detail in: Paws::ApiGateway::ImportDocumentationParts
Returns: a Paws::ApiGateway::DocumentationPartIds instance
Each argument is described in detail in: Paws::ApiGateway::ImportRestApi
A feature of the API Gateway control service for creating a new API from an external API definition file.
Each argument is described in detail in: Paws::ApiGateway::PutGatewayResponse
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
Each argument is described in detail in: Paws::ApiGateway::PutIntegration
Sets up a method's integration.
Each argument is described in detail in: Paws::ApiGateway::PutIntegrationResponse
Represents a put integration.
Each argument is described in detail in: Paws::ApiGateway::PutMethod
Add a method to an existing Resource resource.
Each argument is described in detail in: Paws::ApiGateway::PutMethodResponse
Adds a MethodResponse to an existing Method resource.
Each argument is described in detail in: Paws::ApiGateway::PutRestApi
A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.
Each argument is described in detail in: Paws::ApiGateway::TagResource
Adds or updates a tag on a given resource.
Each argument is described in detail in: Paws::ApiGateway::TestInvokeAuthorizer
Returns: a Paws::ApiGateway::TestInvokeAuthorizerResponse instance
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
Enable custom authorizers (https://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html)
Each argument is described in detail in: Paws::ApiGateway::TestInvokeMethod
Returns: a Paws::ApiGateway::TestInvokeMethodResponse instance
Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
Each argument is described in detail in: Paws::ApiGateway::UntagResource
Removes a tag from a given resource.
Each argument is described in detail in: Paws::ApiGateway::UpdateAccount
Changes information about the current Account resource.
Each argument is described in detail in: Paws::ApiGateway::UpdateApiKey
Changes information about an ApiKey resource.
Each argument is described in detail in: Paws::ApiGateway::UpdateAuthorizer
Updates an existing Authorizer resource.
AWS CLI (https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-authorizer.html)
Each argument is described in detail in: Paws::ApiGateway::UpdateBasePathMapping
Changes information about the BasePathMapping resource.
Each argument is described in detail in: Paws::ApiGateway::UpdateClientCertificate
Changes information about an ClientCertificate resource.
Each argument is described in detail in: Paws::ApiGateway::UpdateDeployment
Changes information about a Deployment resource.
Each argument is described in detail in: Paws::ApiGateway::UpdateDocumentationPart
Each argument is described in detail in: Paws::ApiGateway::UpdateDocumentationVersion
Each argument is described in detail in: Paws::ApiGateway::UpdateDomainName
Changes information about the DomainName resource.
Each argument is described in detail in: Paws::ApiGateway::UpdateGatewayResponse
Updates a GatewayResponse of a specified response type on the given RestApi.
Each argument is described in detail in: Paws::ApiGateway::UpdateIntegration
Represents an update integration.
Each argument is described in detail in: Paws::ApiGateway::UpdateIntegrationResponse
Represents an update integration response.
Each argument is described in detail in: Paws::ApiGateway::UpdateMethod
Updates an existing Method resource.
Each argument is described in detail in: Paws::ApiGateway::UpdateMethodResponse
Updates an existing MethodResponse resource.
Each argument is described in detail in: Paws::ApiGateway::UpdateModel
Changes information about a model.
Each argument is described in detail in: Paws::ApiGateway::UpdateRequestValidator
Updates a RequestValidator of a given RestApi.
Each argument is described in detail in: Paws::ApiGateway::UpdateResource
Changes information about a Resource resource.
Each argument is described in detail in: Paws::ApiGateway::UpdateRestApi
Changes information about the specified API.
Each argument is described in detail in: Paws::ApiGateway::UpdateStage
Changes information about a Stage resource.
Each argument is described in detail in: Paws::ApiGateway::UpdateUsage
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
Each argument is described in detail in: Paws::ApiGateway::UpdateUsagePlan
Updates a usage plan of a given plan Id.
Each argument is described in detail in: Paws::ApiGateway::UpdateVpcLink
Updates an existing VpcLink of a specified identifier.
Paginator methods are helpers that repetively call methods that return partial results
If passed a sub as first parameter, it will call the sub for each element found in :
- items, passing the object as the first parameter, and the string 'items' as the second parameter
If not, it will return a a Paws::ApiGateway::ApiKeys instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
param
If not, it will return a a Paws::ApiGateway::Authorizers instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
If not, it will return a a Paws::ApiGateway::BasePathMappings instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
If not, it will return a a Paws::ApiGateway::ClientCertificates instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
If not, it will return a a Paws::ApiGateway::Deployments instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
If not, it will return a a Paws::ApiGateway::DocumentationParts instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
If not, it will return a a Paws::ApiGateway::DocumentationVersions instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
If not, it will return a a Paws::ApiGateway::DomainNames instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
If not, it will return a a Paws::ApiGateway::GatewayResponses instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
If not, it will return a a Paws::ApiGateway::Models instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
If not, it will return a a Paws::ApiGateway::RequestValidators instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
If not, it will return a a Paws::ApiGateway::Resources instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
If not, it will return a a Paws::ApiGateway::RestApis instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
If not, it will return a a Paws::ApiGateway::SdkTypes instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
If not, it will return a a Paws::ApiGateway::Usage instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
If not, it will return a a Paws::ApiGateway::UsagePlanKeys instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
If not, it will return a a Paws::ApiGateway::UsagePlans instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
If not, it will return a a Paws::ApiGateway::VpcLinks instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
This service class forms part of Paws
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
To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws::SDK::Config
CPAN shell
perl -MCPAN -e shell install Paws::SDK::Config
For more information on module installation, please visit the detailed CPAN module installation guide.