NAME

Paws::ApiGateway - Perl Interface to AWS Amazon API Gateway

SYNOPSIS

  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' } ],
  );

DESCRIPTION

Amazon API Gateway

Amazon API Gateway helps developers deliver robust, secure and scalable mobile and web application backends. Amazon 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.

METHODS

CreateApiKey([Description => Str, Enabled => Bool, Name => Str, StageKeys => ArrayRef[Paws::ApiGateway::StageKey]])

Each argument is described in detail in: Paws::ApiGateway::CreateApiKey

Returns: a Paws::ApiGateway::ApiKey instance

CreateAuthorizer(AuthorizerUri => Str, IdentitySource => Str, Name => Str, RestApiId => Str, Type => Str, [AuthorizerCredentials => Str, AuthorizerResultTtlInSeconds => Int, IdentityValidationExpression => Str])

Each argument is described in detail in: Paws::ApiGateway::CreateAuthorizer

Returns: a Paws::ApiGateway::Authorizer instance

CreateBasePathMapping(DomainName => Str, RestApiId => Str, [BasePath => Str, Stage => Str])

Each argument is described in detail in: Paws::ApiGateway::CreateBasePathMapping

Returns: a Paws::ApiGateway::BasePathMapping instance

  Creates a new BasePathMapping resource.

CreateDeployment(RestApiId => Str, StageName => Str, [CacheClusterEnabled => Bool, CacheClusterSize => Str, Description => Str, StageDescription => Str, Variables => Paws::ApiGateway::MapOfStringToString])

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.

CreateDomainName(CertificateBody => Str, CertificateChain => Str, CertificateName => Str, CertificatePrivateKey => Str, DomainName => Str)

Each argument is described in detail in: Paws::ApiGateway::CreateDomainName

Returns: a Paws::ApiGateway::DomainName instance

  Creates a new domain name.

CreateModel(ContentType => Str, Name => Str, RestApiId => Str, [Description => Str, Schema => Str])

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.

CreateResource(ParentId => Str, PathPart => Str, RestApiId => Str)

Each argument is described in detail in: Paws::ApiGateway::CreateResource

Returns: a Paws::ApiGateway::Resource instance

  Creates a Resource resource.

CreateRestApi(Name => Str, [CloneFrom => Str, Description => Str])

Each argument is described in detail in: Paws::ApiGateway::CreateRestApi

Returns: a Paws::ApiGateway::RestApi instance

  Creates a new RestApi resource.

CreateStage(DeploymentId => Str, RestApiId => Str, StageName => Str, [CacheClusterEnabled => Bool, CacheClusterSize => Str, Description => Str, Variables => Paws::ApiGateway::MapOfStringToString])

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.

DeleteApiKey(ApiKey => Str)

Each argument is described in detail in: Paws::ApiGateway::DeleteApiKey

Returns: nothing

  Deletes the ApiKey resource.

DeleteAuthorizer(AuthorizerId => Str, RestApiId => Str)

Each argument is described in detail in: Paws::ApiGateway::DeleteAuthorizer

Returns: nothing

  Deletes an existing Authorizer resource.

DeleteBasePathMapping(BasePath => Str, DomainName => Str)

Each argument is described in detail in: Paws::ApiGateway::DeleteBasePathMapping

Returns: nothing

  Deletes the BasePathMapping resource.

DeleteClientCertificate(ClientCertificateId => Str)

Each argument is described in detail in: Paws::ApiGateway::DeleteClientCertificate

Returns: nothing

DeleteDeployment(DeploymentId => Str, RestApiId => Str)

Each argument is described in detail in: Paws::ApiGateway::DeleteDeployment

Returns: nothing

  Deletes a Deployment resource. Deleting a deployment will only succeed
if there are no Stage resources associated with it.

DeleteDomainName(DomainName => Str)

Each argument is described in detail in: Paws::ApiGateway::DeleteDomainName

Returns: nothing

  Deletes the DomainName resource.

DeleteIntegration(HttpMethod => Str, ResourceId => Str, RestApiId => Str)

Each argument is described in detail in: Paws::ApiGateway::DeleteIntegration

Returns: nothing

  Represents a delete integration.

DeleteIntegrationResponse(HttpMethod => Str, ResourceId => Str, RestApiId => Str, StatusCode => Str)

Each argument is described in detail in: Paws::ApiGateway::DeleteIntegrationResponse

Returns: nothing

  Represents a delete integration response.

DeleteMethod(HttpMethod => Str, ResourceId => Str, RestApiId => Str)

Each argument is described in detail in: Paws::ApiGateway::DeleteMethod

Returns: nothing

  Deletes an existing Method resource.

DeleteMethodResponse(HttpMethod => Str, ResourceId => Str, RestApiId => Str, StatusCode => Str)

Each argument is described in detail in: Paws::ApiGateway::DeleteMethodResponse

Returns: nothing

  Deletes an existing MethodResponse resource.

DeleteModel(ModelName => Str, RestApiId => Str)

Each argument is described in detail in: Paws::ApiGateway::DeleteModel

Returns: nothing

  Deletes a model.

DeleteResource(ResourceId => Str, RestApiId => Str)

Each argument is described in detail in: Paws::ApiGateway::DeleteResource

Returns: nothing

  Deletes a Resource resource.

DeleteRestApi(RestApiId => Str)

Each argument is described in detail in: Paws::ApiGateway::DeleteRestApi

Returns: nothing

  Deletes the specified API.

DeleteStage(RestApiId => Str, StageName => Str)

Each argument is described in detail in: Paws::ApiGateway::DeleteStage

Returns: nothing

  Deletes a Stage resource.

FlushStageAuthorizersCache(RestApiId => Str, StageName => Str)

Each argument is described in detail in: Paws::ApiGateway::FlushStageAuthorizersCache

Returns: nothing

  Flushes all authorizer cache entries on a stage.

FlushStageCache(RestApiId => Str, StageName => Str)

Each argument is described in detail in: Paws::ApiGateway::FlushStageCache

Returns: nothing

  Flushes a stage's cache.

GenerateClientCertificate([Description => Str])

Each argument is described in detail in: Paws::ApiGateway::GenerateClientCertificate

Returns: a Paws::ApiGateway::ClientCertificate instance

GetAccount()

Each argument is described in detail in: Paws::ApiGateway::GetAccount

Returns: a Paws::ApiGateway::Account instance

  Gets information about the current Account resource.

GetApiKey(ApiKey => Str)

Each argument is described in detail in: Paws::ApiGateway::GetApiKey

Returns: a Paws::ApiGateway::ApiKey instance

  Gets information about the current ApiKey resource.

GetApiKeys([Limit => Int, Position => Str])

Each argument is described in detail in: Paws::ApiGateway::GetApiKeys

Returns: a Paws::ApiGateway::ApiKeys instance

  Gets information about the current ApiKeys resource.

GetAuthorizer(AuthorizerId => Str, RestApiId => Str)

Each argument is described in detail in: Paws::ApiGateway::GetAuthorizer

Returns: a Paws::ApiGateway::Authorizer instance

  Describe an existing Authorizer resource.

GetAuthorizers(RestApiId => Str, [Limit => Int, Position => Str])

Each argument is described in detail in: Paws::ApiGateway::GetAuthorizers

Returns: a Paws::ApiGateway::Authorizers instance

  Describe an existing Authorizers resource.

GetBasePathMapping(BasePath => Str, DomainName => Str)

Each argument is described in detail in: Paws::ApiGateway::GetBasePathMapping

Returns: a Paws::ApiGateway::BasePathMapping instance

  Describe a BasePathMapping resource.

GetBasePathMappings(DomainName => Str, [Limit => Int, Position => Str])

Each argument is described in detail in: Paws::ApiGateway::GetBasePathMappings

Returns: a Paws::ApiGateway::BasePathMappings instance

  Represents a collection of BasePathMapping resources.

GetClientCertificate(ClientCertificateId => Str)

Each argument is described in detail in: Paws::ApiGateway::GetClientCertificate

Returns: a Paws::ApiGateway::ClientCertificate instance

GetClientCertificates([Limit => Int, Position => Str])

Each argument is described in detail in: Paws::ApiGateway::GetClientCertificates

Returns: a Paws::ApiGateway::ClientCertificates instance

GetDeployment(DeploymentId => Str, RestApiId => Str)

Each argument is described in detail in: Paws::ApiGateway::GetDeployment

Returns: a Paws::ApiGateway::Deployment instance

  Gets information about a Deployment resource.

GetDeployments(RestApiId => Str, [Limit => Int, Position => Str])

Each argument is described in detail in: Paws::ApiGateway::GetDeployments

Returns: a Paws::ApiGateway::Deployments instance

  Gets information about a Deployments collection.

GetDomainName(DomainName => Str)

Each argument is described in detail in: Paws::ApiGateway::GetDomainName

Returns: a Paws::ApiGateway::DomainName instance

  Represents a domain name that is contained in a simpler, more intuitive
URL that can be called.

GetDomainNames([Limit => Int, Position => Str])

Each argument is described in detail in: Paws::ApiGateway::GetDomainNames

Returns: a Paws::ApiGateway::DomainNames instance

  Represents a collection of DomainName resources.

GetExport(ExportType => Str, RestApiId => Str, StageName => Str, [Accepts => Str, Parameters => Paws::ApiGateway::MapOfStringToString])

Each argument is described in detail in: Paws::ApiGateway::GetExport

Returns: a Paws::ApiGateway::ExportResponse instance

GetIntegration(HttpMethod => Str, ResourceId => Str, RestApiId => Str)

Each argument is described in detail in: Paws::ApiGateway::GetIntegration

Returns: a Paws::ApiGateway::Integration instance

  Represents a get integration.

GetIntegrationResponse(HttpMethod => Str, ResourceId => Str, RestApiId => Str, StatusCode => Str)

Each argument is described in detail in: Paws::ApiGateway::GetIntegrationResponse

Returns: a Paws::ApiGateway::IntegrationResponse instance

  Represents a get integration response.

GetMethod(HttpMethod => Str, ResourceId => Str, RestApiId => Str)

Each argument is described in detail in: Paws::ApiGateway::GetMethod

Returns: a Paws::ApiGateway::Method instance

  Describe an existing Method resource.

GetMethodResponse(HttpMethod => Str, ResourceId => Str, RestApiId => Str, StatusCode => Str)

Each argument is described in detail in: Paws::ApiGateway::GetMethodResponse

Returns: a Paws::ApiGateway::MethodResponse instance

  Describes a MethodResponse resource.

GetModel(ModelName => Str, RestApiId => Str, [Flatten => Bool])

Each argument is described in detail in: Paws::ApiGateway::GetModel

Returns: a Paws::ApiGateway::Model instance

  Describes an existing model defined for a RestApi resource.

GetModels(RestApiId => Str, [Limit => Int, Position => Str])

Each argument is described in detail in: Paws::ApiGateway::GetModels

Returns: a Paws::ApiGateway::Models instance

  Describes existing Models defined for a RestApi resource.

GetModelTemplate(ModelName => Str, RestApiId => Str)

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.

GetResource(ResourceId => Str, RestApiId => Str)

Each argument is described in detail in: Paws::ApiGateway::GetResource

Returns: a Paws::ApiGateway::Resource instance

  Lists information about a resource.

GetResources(RestApiId => Str, [Limit => Int, Position => Str])

Each argument is described in detail in: Paws::ApiGateway::GetResources

Returns: a Paws::ApiGateway::Resources instance

  Lists information about a collection of Resource resources.

GetRestApi(RestApiId => Str)

Each argument is described in detail in: Paws::ApiGateway::GetRestApi

Returns: a Paws::ApiGateway::RestApi instance

  Lists the RestApi resource in the collection.

GetRestApis([Limit => Int, Position => Str])

Each argument is described in detail in: Paws::ApiGateway::GetRestApis

Returns: a Paws::ApiGateway::RestApis instance

  Lists the RestApis resources for your collection.

GetSdk(RestApiId => Str, SdkType => Str, StageName => Str, [Parameters => Paws::ApiGateway::MapOfStringToString])

Each argument is described in detail in: Paws::ApiGateway::GetSdk

Returns: a Paws::ApiGateway::SdkResponse instance

GetStage(RestApiId => Str, StageName => Str)

Each argument is described in detail in: Paws::ApiGateway::GetStage

Returns: a Paws::ApiGateway::Stage instance

  Gets information about a Stage resource.

GetStages(RestApiId => Str, [DeploymentId => Str])

Each argument is described in detail in: Paws::ApiGateway::GetStages

Returns: a Paws::ApiGateway::Stages instance

  Gets information about one or more Stage resources.

PutIntegration(HttpMethod => Str, ResourceId => Str, RestApiId => Str, Type => Str, [CacheKeyParameters => ArrayRef[Str], CacheNamespace => Str, Credentials => Str, IntegrationHttpMethod => Str, RequestParameters => Paws::ApiGateway::MapOfStringToString, RequestTemplates => Paws::ApiGateway::MapOfStringToString, Uri => Str])

Each argument is described in detail in: Paws::ApiGateway::PutIntegration

Returns: a Paws::ApiGateway::Integration instance

  Represents a put integration.

PutIntegrationResponse(HttpMethod => Str, ResourceId => Str, RestApiId => Str, StatusCode => Str, [ResponseParameters => Paws::ApiGateway::MapOfStringToString, ResponseTemplates => Paws::ApiGateway::MapOfStringToString, SelectionPattern => Str])

Each argument is described in detail in: Paws::ApiGateway::PutIntegrationResponse

Returns: a Paws::ApiGateway::IntegrationResponse instance

  Represents a put integration.

PutMethod(AuthorizationType => Str, HttpMethod => Str, ResourceId => Str, RestApiId => Str, [ApiKeyRequired => Bool, AuthorizerId => Str, RequestModels => Paws::ApiGateway::MapOfStringToString, RequestParameters => Paws::ApiGateway::MapOfStringToBoolean])

Each argument is described in detail in: Paws::ApiGateway::PutMethod

Returns: a Paws::ApiGateway::Method instance

  Add a method to an existing Resource resource.

PutMethodResponse(HttpMethod => Str, ResourceId => Str, RestApiId => Str, StatusCode => Str, [ResponseModels => Paws::ApiGateway::MapOfStringToString, ResponseParameters => Paws::ApiGateway::MapOfStringToBoolean])

Each argument is described in detail in: Paws::ApiGateway::PutMethodResponse

Returns: a Paws::ApiGateway::MethodResponse instance

  Adds a MethodResponse to an existing Method resource.

TestInvokeAuthorizer(AuthorizerId => Str, RestApiId => Str, [AdditionalContext => Paws::ApiGateway::MapOfStringToString, Body => Str, Headers => Paws::ApiGateway::MapOfHeaderValues, PathWithQueryString => Str, StageVariables => Paws::ApiGateway::MapOfStringToString])

Each argument is described in detail in: Paws::ApiGateway::TestInvokeAuthorizer

Returns: a Paws::ApiGateway::TestInvokeAuthorizerResponse instance

TestInvokeMethod(HttpMethod => Str, ResourceId => Str, RestApiId => Str, [Body => Str, ClientCertificateId => Str, Headers => Paws::ApiGateway::MapOfHeaderValues, PathWithQueryString => Str, StageVariables => Paws::ApiGateway::MapOfStringToString])

Each argument is described in detail in: Paws::ApiGateway::TestInvokeMethod

Returns: a Paws::ApiGateway::TestInvokeMethodResponse instance

UpdateAccount([PatchOperations => ArrayRef[Paws::ApiGateway::PatchOperation]])

Each argument is described in detail in: Paws::ApiGateway::UpdateAccount

Returns: a Paws::ApiGateway::Account instance

  Changes information about the current Account resource.

UpdateApiKey(ApiKey => Str, [PatchOperations => ArrayRef[Paws::ApiGateway::PatchOperation]])

Each argument is described in detail in: Paws::ApiGateway::UpdateApiKey

Returns: a Paws::ApiGateway::ApiKey instance

  Changes information about an ApiKey resource.

UpdateAuthorizer(AuthorizerId => Str, RestApiId => Str, [PatchOperations => ArrayRef[Paws::ApiGateway::PatchOperation]])

Each argument is described in detail in: Paws::ApiGateway::UpdateAuthorizer

Returns: a Paws::ApiGateway::Authorizer instance

  Updates an existing Authorizer resource.

UpdateBasePathMapping(BasePath => Str, DomainName => Str, [PatchOperations => ArrayRef[Paws::ApiGateway::PatchOperation]])

Each argument is described in detail in: Paws::ApiGateway::UpdateBasePathMapping

Returns: a Paws::ApiGateway::BasePathMapping instance

  Changes information about the BasePathMapping resource.

UpdateClientCertificate(ClientCertificateId => Str, [PatchOperations => ArrayRef[Paws::ApiGateway::PatchOperation]])

Each argument is described in detail in: Paws::ApiGateway::UpdateClientCertificate

Returns: a Paws::ApiGateway::ClientCertificate instance

UpdateDeployment(DeploymentId => Str, RestApiId => Str, [PatchOperations => ArrayRef[Paws::ApiGateway::PatchOperation]])

Each argument is described in detail in: Paws::ApiGateway::UpdateDeployment

Returns: a Paws::ApiGateway::Deployment instance

  Changes information about a Deployment resource.

UpdateDomainName(DomainName => Str, [PatchOperations => ArrayRef[Paws::ApiGateway::PatchOperation]])

Each argument is described in detail in: Paws::ApiGateway::UpdateDomainName

Returns: a Paws::ApiGateway::DomainName instance

  Changes information about the DomainName resource.

UpdateIntegration(HttpMethod => Str, ResourceId => Str, RestApiId => Str, [PatchOperations => ArrayRef[Paws::ApiGateway::PatchOperation]])

Each argument is described in detail in: Paws::ApiGateway::UpdateIntegration

Returns: a Paws::ApiGateway::Integration instance

  Represents an update integration.

UpdateIntegrationResponse(HttpMethod => Str, ResourceId => Str, RestApiId => Str, StatusCode => Str, [PatchOperations => ArrayRef[Paws::ApiGateway::PatchOperation]])

Each argument is described in detail in: Paws::ApiGateway::UpdateIntegrationResponse

Returns: a Paws::ApiGateway::IntegrationResponse instance

  Represents an update integration response.

UpdateMethod(HttpMethod => Str, ResourceId => Str, RestApiId => Str, [PatchOperations => ArrayRef[Paws::ApiGateway::PatchOperation]])

Each argument is described in detail in: Paws::ApiGateway::UpdateMethod

Returns: a Paws::ApiGateway::Method instance

  Updates an existing Method resource.

UpdateMethodResponse(HttpMethod => Str, ResourceId => Str, RestApiId => Str, StatusCode => Str, [PatchOperations => ArrayRef[Paws::ApiGateway::PatchOperation]])

Each argument is described in detail in: Paws::ApiGateway::UpdateMethodResponse

Returns: a Paws::ApiGateway::MethodResponse instance

  Updates an existing MethodResponse resource.

UpdateModel(ModelName => Str, RestApiId => Str, [PatchOperations => ArrayRef[Paws::ApiGateway::PatchOperation]])

Each argument is described in detail in: Paws::ApiGateway::UpdateModel

Returns: a Paws::ApiGateway::Model instance

  Changes information about a model.

UpdateResource(ResourceId => Str, RestApiId => Str, [PatchOperations => ArrayRef[Paws::ApiGateway::PatchOperation]])

Each argument is described in detail in: Paws::ApiGateway::UpdateResource

Returns: a Paws::ApiGateway::Resource instance

  Changes information about a Resource resource.

UpdateRestApi(RestApiId => Str, [PatchOperations => ArrayRef[Paws::ApiGateway::PatchOperation]])

Each argument is described in detail in: Paws::ApiGateway::UpdateRestApi

Returns: a Paws::ApiGateway::RestApi instance

  Changes information about the specified API.

UpdateStage(RestApiId => Str, StageName => Str, [PatchOperations => ArrayRef[Paws::ApiGateway::PatchOperation]])

Each argument is described in detail in: Paws::ApiGateway::UpdateStage

Returns: a Paws::ApiGateway::Stage instance

  Changes information about a Stage resource.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

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

cpanm Paws::SDK::Config

perl -MCPAN -e shell
install Paws::SDK::Config