++ed by:
SSCAFFIDI ETHER CAFEGRATZ DBOOK LUKEC

17 PAUSE users
15 non-PAUSE users.

Jose Luis Martinez Torres
and 1 contributors

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 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://aws.amazon.com/documentation/apigateway/

METHODS

CreateApiKey

[CustomerId => Str]
[Description => Str]
[Enabled => Bool]
[GenerateDistinctId => Bool]
[Name => Str]
[StageKeys => ArrayRef[Paws::ApiGateway::StageKey]]
[Value => Str]

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

Returns: a Paws::ApiGateway::ApiKey instance

Create an ApiKey resource.

AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html)

CreateAuthorizer

Name => Str
RestApiId => Str
Type => Str
[AuthorizerCredentials => Str]
[AuthorizerResultTtlInSeconds => Int]
[AuthorizerUri => Str]
[AuthType => Str]
[IdentitySource => Str]
[IdentityValidationExpression => Str]
[ProviderARNs => ArrayRef[Str|Undef]]

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 (http://docs.aws.amazon.com/cli/latest/reference/apigateway/create-authorizer.html)

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
[CacheClusterEnabled => Bool]
[CacheClusterSize => Str]
[CanarySettings => Paws::ApiGateway::DeploymentCanarySettings]
[Description => Str]
[StageDescription => Str]
[StageName => 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.

CreateDocumentationPart

Location => Paws::ApiGateway::DocumentationPartLocation
Properties => Str
RestApiId => Str

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

Returns: a Paws::ApiGateway::DocumentationPart instance

CreateDocumentationVersion

DocumentationVersion => Str
RestApiId => Str
[Description => Str]
[StageName => Str]

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

Returns: a Paws::ApiGateway::DocumentationVersion instance

CreateDomainName

DomainName => Str
[CertificateArn => Str]
[CertificateBody => Str]
[CertificateChain => Str]
[CertificateName => Str]
[CertificatePrivateKey => Str]
[EndpointConfiguration => Paws::ApiGateway::EndpointConfiguration]
[RegionalCertificateArn => Str]
[RegionalCertificateName => 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.

CreateRequestValidator

RestApiId => Str
[Name => Str]
[ValidateRequestBody => Bool]
[ValidateRequestParameters => Bool]

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

Returns: a Paws::ApiGateway::RequestValidator instance

Creates a ReqeustValidator of a given RestApi.

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
[ApiKeySource => Str]
[BinaryMediaTypes => ArrayRef[Str|Undef]]
[CloneFrom => Str]
[Description => Str]
[EndpointConfiguration => Paws::ApiGateway::EndpointConfiguration]
[MinimumCompressionSize => Int]
[Policy => Str]
[Version => 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]
[CanarySettings => Paws::ApiGateway::CanarySettings]
[Description => Str]
[DocumentationVersion => Str]
[Tags => Paws::ApiGateway::MapOfStringToString]
[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.

CreateUsagePlan

Name => Str
[ApiStages => ArrayRef[Paws::ApiGateway::ApiStage]]
[Description => Str]
[Quota => Paws::ApiGateway::QuotaSettings]
[Throttle => Paws::ApiGateway::ThrottleSettings]

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.

CreateUsagePlanKey

KeyId => Str
KeyType => Str
UsagePlanId => Str

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.

Name => Str
TargetArns => ArrayRef[Str|Undef]
[Description => Str]

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.

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.

AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/delete-authorizer.html)

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

Deletes the ClientCertificate resource.

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.

DeleteDocumentationPart

DocumentationPartId => Str
RestApiId => Str

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

Returns: nothing

DeleteDocumentationVersion

DocumentationVersion => Str
RestApiId => Str

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

Returns: nothing

DeleteDomainName

DomainName => Str

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

Returns: nothing

Deletes the DomainName resource.

DeleteGatewayResponse

ResponseType => Str
RestApiId => Str

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

Returns: nothing

Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

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.

DeleteRequestValidator

RequestValidatorId => Str
RestApiId => Str

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

Returns: nothing

Deletes a RequestValidator of a given RestApi.

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.

DeleteUsagePlan

UsagePlanId => Str

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

Returns: nothing

Deletes a usage plan of a given plan Id.

DeleteUsagePlanKey

KeyId => Str
UsagePlanId => Str

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

Returns: nothing

Deletes a usage plan key and remove the underlying API key from the associated usage plan.

VpcLinkId => Str

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

Returns: nothing

Deletes an existing VpcLink of a specified identifier.

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

Generates a ClientCertificate resource.

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
[IncludeValue => Bool]

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

Returns: a Paws::ApiGateway::ApiKey instance

Gets information about the current ApiKey resource.

GetApiKeys

[CustomerId => Str]
[IncludeValues => Bool]
[Limit => Int]
[NameQuery => Str]
[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.

AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizer.html)

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.

AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/get-authorizers.html)

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

Gets information about the current ClientCertificate resource.

GetClientCertificates

[Limit => Int]
[Position => Str]

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

Returns: a Paws::ApiGateway::ClientCertificates instance

Gets a collection of ClientCertificate resources.

GetDeployment

DeploymentId => Str
RestApiId => Str
[Embed => ArrayRef[Str|Undef]]

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.

GetDocumentationPart

DocumentationPartId => Str
RestApiId => Str

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

Returns: a Paws::ApiGateway::DocumentationPart instance

GetDocumentationParts

RestApiId => Str
[Limit => Int]
[LocationStatus => Str]
[NameQuery => Str]
[Path => Str]
[Position => Str]
[Type => Str]

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

Returns: a Paws::ApiGateway::DocumentationParts instance

GetDocumentationVersion

DocumentationVersion => Str
RestApiId => Str

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

Returns: a Paws::ApiGateway::DocumentationVersion instance

GetDocumentationVersions

RestApiId => Str
[Limit => Int]
[Position => Str]

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

Returns: a Paws::ApiGateway::DocumentationVersions instance

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

Exports a deployed version of a RestApi in a specified format.

GetGatewayResponse

ResponseType => Str
RestApiId => Str

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.

GetGatewayResponses

RestApiId => Str
[Limit => Int]
[Position => Str]

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.

GetIntegration

HttpMethod => Str
ResourceId => Str
RestApiId => Str

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

Returns: a Paws::ApiGateway::Integration instance

Get the integration settings.

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.

GetRequestValidator

RequestValidatorId => Str
RestApiId => Str

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

Returns: a Paws::ApiGateway::RequestValidator instance

Gets a RequestValidator of a given RestApi.

GetRequestValidators

RestApiId => Str
[Limit => Int]
[Position => Str]

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

Returns: a Paws::ApiGateway::RequestValidators instance

Gets the RequestValidators collection of a given RestApi.

GetResource

ResourceId => Str
RestApiId => Str
[Embed => ArrayRef[Str|Undef]]

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

Returns: a Paws::ApiGateway::Resource instance

Lists information about a resource.

GetResources

RestApiId => Str
[Embed => ArrayRef[Str|Undef]]
[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

Generates a client SDK for a RestApi and Stage.

GetSdkType

Id => Str

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

Returns: a Paws::ApiGateway::SdkType instance

GetSdkTypes

[Limit => Int]
[Position => Str]

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

Returns: a Paws::ApiGateway::SdkTypes 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.

GetTags

ResourceArn => Str
[Limit => Int]
[Position => Str]

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

Returns: a Paws::ApiGateway::Tags instance

Gets the Tags collection for a given resource.

GetUsage

EndDate => Str
StartDate => Str
UsagePlanId => Str
[KeyId => Str]
[Limit => Int]
[Position => Str]

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.

GetUsagePlan

UsagePlanId => Str

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

Returns: a Paws::ApiGateway::UsagePlan instance

Gets a usage plan of a given plan identifier.

GetUsagePlanKey

KeyId => Str
UsagePlanId => Str

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

Returns: a Paws::ApiGateway::UsagePlanKey instance

Gets a usage plan key of a given key identifier.

GetUsagePlanKeys

UsagePlanId => Str
[Limit => Int]
[NameQuery => Str]
[Position => Str]

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.

GetUsagePlans

[KeyId => Str]
[Limit => Int]
[Position => Str]

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.

VpcLinkId => Str

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

Returns: a Paws::ApiGateway::VpcLink instance

Gets a specified VPC link under the caller's account in a region.

[Limit => Int]
[Position => Str]

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.

ImportApiKeys

Body => Str
Format => Str
[FailOnWarnings => Bool]

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.

ImportDocumentationParts

Body => Str
RestApiId => Str
[FailOnWarnings => Bool]
[Mode => Str]

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

Returns: a Paws::ApiGateway::DocumentationPartIds instance

ImportRestApi

Body => Str
[FailOnWarnings => Bool]
[Parameters => Paws::ApiGateway::MapOfStringToString]

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

Returns: a Paws::ApiGateway::RestApi instance

A feature of the API Gateway control service for creating a new API from an external API definition file.

PutGatewayResponse

ResponseType => Str
RestApiId => Str
[ResponseParameters => Paws::ApiGateway::MapOfStringToString]
[ResponseTemplates => Paws::ApiGateway::MapOfStringToString]
[StatusCode => Str]

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

Returns: a Paws::ApiGateway::GatewayResponse instance

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

PutIntegration

HttpMethod => Str
ResourceId => Str
RestApiId => Str
Type => Str
[CacheKeyParameters => ArrayRef[Str|Undef]]
[CacheNamespace => Str]
[ConnectionId => Str]
[ConnectionType => Str]
[ContentHandling => Str]
[Credentials => Str]
[IntegrationHttpMethod => Str]
[PassthroughBehavior => Str]
[RequestParameters => Paws::ApiGateway::MapOfStringToString]
[RequestTemplates => Paws::ApiGateway::MapOfStringToString]
[TimeoutInMillis => Int]
[Uri => Str]

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

Returns: a Paws::ApiGateway::Integration instance

Sets up a method's integration.

PutIntegrationResponse

HttpMethod => Str
ResourceId => Str
RestApiId => Str
StatusCode => Str
[ContentHandling => 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]
[AuthorizationScopes => ArrayRef[Str|Undef]]
[AuthorizerId => Str]
[OperationName => Str]
[RequestModels => Paws::ApiGateway::MapOfStringToString]
[RequestParameters => Paws::ApiGateway::MapOfStringToBoolean]
[RequestValidatorId => Str]

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.

PutRestApi

Body => Str
RestApiId => Str
[FailOnWarnings => Bool]
[Mode => Str]
[Parameters => Paws::ApiGateway::MapOfStringToString]

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

Returns: a Paws::ApiGateway::RestApi instance

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.

TagResource

ResourceArn => Str
Tags => Paws::ApiGateway::MapOfStringToString

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

Returns: nothing

Adds or updates a tag on a given 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

Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

Enable custom authorizers (http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html)

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

Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

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

Returns: nothing

Removes a tag from a given resource.

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.

AWS CLI (http://docs.aws.amazon.com/cli/latest/reference/apigateway/update-authorizer.html)

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

Changes information about an ClientCertificate resource.

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.

UpdateDocumentationPart

DocumentationPartId => Str
RestApiId => Str
[PatchOperations => ArrayRef[Paws::ApiGateway::PatchOperation]]

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

Returns: a Paws::ApiGateway::DocumentationPart instance

UpdateDocumentationVersion

DocumentationVersion => Str
RestApiId => Str
[PatchOperations => ArrayRef[Paws::ApiGateway::PatchOperation]]

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

Returns: a Paws::ApiGateway::DocumentationVersion instance

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.

UpdateGatewayResponse

ResponseType => Str
RestApiId => Str
[PatchOperations => ArrayRef[Paws::ApiGateway::PatchOperation]]

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

Returns: a Paws::ApiGateway::GatewayResponse instance

Updates a GatewayResponse of a specified response type on the given RestApi.

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.

UpdateRequestValidator

RequestValidatorId => Str
RestApiId => Str
[PatchOperations => ArrayRef[Paws::ApiGateway::PatchOperation]]

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

Returns: a Paws::ApiGateway::RequestValidator instance

Updates a RequestValidator of a given RestApi.

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.

UpdateUsage

KeyId => Str
UsagePlanId => Str
[PatchOperations => ArrayRef[Paws::ApiGateway::PatchOperation]]

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

Returns: a Paws::ApiGateway::Usage instance

Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.

UpdateUsagePlan

UsagePlanId => Str
[PatchOperations => ArrayRef[Paws::ApiGateway::PatchOperation]]

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

Returns: a Paws::ApiGateway::UsagePlan instance

Updates a usage plan of a given plan Id.

VpcLinkId => Str
[PatchOperations => ArrayRef[Paws::ApiGateway::PatchOperation]]

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

Returns: a Paws::ApiGateway::VpcLink instance

Updates an existing VpcLink of a specified identifier.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

GetAllApiKeys(sub { },[CustomerId => Str, IncludeValues => Bool, Limit => Int, NameQuery => Str, Position => Str])

GetAllApiKeys([CustomerId => Str, IncludeValues => Bool, Limit => Int, NameQuery => Str, Position => Str])

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.

GetAllBasePathMappings(sub { },DomainName => Str, [Limit => Int, Position => Str])

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

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::BasePathMappings instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllClientCertificates(sub { },[Limit => Int, Position => Str])

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

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::ClientCertificates instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllDeployments(sub { },RestApiId => Str, [Limit => Int, Position => Str])

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

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::Deployments instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllDomainNames(sub { },[Limit => Int, Position => Str])

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

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::DomainNames instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllModels(sub { },RestApiId => Str, [Limit => Int, Position => Str])

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

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::Models instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllResources(sub { },RestApiId => Str, [Embed => ArrayRef[Str|Undef], Limit => Int, Position => Str])

GetAllResources(RestApiId => Str, [Embed => ArrayRef[Str|Undef], Limit => Int, Position => Str])

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::Resources instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllRestApis(sub { },[Limit => Int, Position => Str])

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

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::RestApis instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllUsage(sub { },EndDate => Str, StartDate => Str, UsagePlanId => Str, [KeyId => Str, Limit => Int, Position => Str])

GetAllUsage(EndDate => Str, StartDate => Str, UsagePlanId => Str, [KeyId => Str, Limit => Int, Position => Str])

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::Usage instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllUsagePlanKeys(sub { },UsagePlanId => Str, [Limit => Int, NameQuery => Str, Position => Str])

GetAllUsagePlanKeys(UsagePlanId => Str, [Limit => Int, NameQuery => Str, Position => Str])

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::UsagePlanKeys instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllUsagePlans(sub { },[KeyId => Str, Limit => Int, Position => Str])

GetAllUsagePlans([KeyId => Str, Limit => Int, Position => Str])

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::UsagePlans instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

GetAllVpcLinks(sub { },[Limit => Int, Position => Str])

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

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::VpcLinks instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

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