root
API
Generated with
root/org.encalmo.aws/AwsApiGatewayApi

AwsApiGatewayApi

org.encalmo.aws.AwsApiGatewayApi
object AwsApiGatewayApi

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

def addAwsIntegration(restApiId: String, resourceId: String, httpMethod: String, integrationHttpMethod: String, uri: String, pathParameters: Map[String, String], headers: Map[String, String], queryParameters: Map[String, String], requestTemplates: Map[String, String], credentials: Option[String])(using aws: AwsClient): PutIntegrationResponse

Adds a new method with AWS_PROXY integration

Adds a new method with AWS_PROXY integration

Attributes

def addHttpIntegration(restApiId: String, resourceId: String, httpMethod: String, integrationHttpMethod: String, uri: String, pathParameters: Map[String, String], headers: Map[String, String], queryParameters: Map[String, String], requestTemplates: Map[String, String], credentials: Option[String])(using aws: AwsClient): PutIntegrationResponse

Adds a new method with HTTP integration

Adds a new method with HTTP integration

Attributes

def addIntegrationResponse(restApiId: String, resourceId: String, httpMethod: String, statusCode: String, responseParameters: Map[String, String], responseTemplates: Map[String, String], selectionPattern: Option[String])(using aws: AwsClient): PutIntegrationResponseResponse

Add new integration response mapping

Add new integration response mapping

Attributes

def addMethod(restApiId: String, resourceId: String, httpMethod: String, apiKeyRequired: Boolean, operationName: String, requestModels: Map[String, String])(using aws: AwsClient): PutMethodResponse

Add a method to an existing Resource resource.

Add a method to an existing Resource resource.

Attributes

def addMethodResponse(restApiId: String, resourceId: String, httpMethod: String, statusCode: String, responseModels: Map[String, String], responseParameters: Map[String, Boolean])(using aws: AwsClient): PutMethodResponseResponse

Add a method reponse type to an existing method.

Add a method reponse type to an existing method.

Attributes

def addMethodResponses(restApiId: String, resourceId: String, httpMethod: String, statusCodes: Seq[String])(using aws: AwsClient): Unit
def createModel(restApiId: String, name: String, description: String, schema: String, contentType: String)(using aws: AwsClient): String
def createRequestValidator(restApiId: String, name: String, validateRequestBody: Boolean, validateRequestParameters: Boolean)(using aws: AwsClient): String

Creates a RequestValidator of a given RestApi.

Creates a RequestValidator of a given RestApi.

Attributes

def createResource(restApiId: String, parentResourceId: String, pathPart: String)(using aws: AwsClient): String

Creates new resource.

Creates new resource.

Attributes

def deleteIntegration(restApiId: String, resourceId: String, httpMethod: String)(using aws: AwsClient): DeleteIntegrationResponse

Delete existing method integration

Delete existing method integration

Attributes

def exportOpenApi3SpecWithAWSExtensions(restApiId: String, stageName: String)(using aws: AwsClient): String

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

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

Attributes

def generateTemplateFromModel(restApiId: String, modelName: String)(using aws: AwsClient): GetModelTemplateResponse

Generates a sample mapping template that can be used to transform a payload into the structure of a model.

Generates a sample mapping template that can be used to transform a payload into the structure of a model.

Attributes

def getApiKey(apiKey: String)(using aws: AwsClient): String

Gets information about the current ApiKey resource.

Gets information about the current ApiKey resource.

Attributes

def getApiKeys()(using aws: AwsClient): Seq[ApiKey]

Gets information about the current ApiKeys resource.

Gets information about the current ApiKeys resource.

Attributes

def getIntegration(restApiId: String, resourceId: String, method: String)(using aws: AwsClient): GetIntegrationResponse

Get integration.

Get integration.

Attributes

def getResource(restApiId: String, resourceId: String)(using aws: AwsClient): GetResourceResponse

Get resource.

Get resource.

Attributes

def getStage(restApiId: String, stageName: String)(using aws: AwsClient): GetStageResponse

Gets information about a Stage resource.

Gets information about a Stage resource.

Attributes

def getUsagePlan(usagePlanId: String)(using aws: AwsClient): GetUsagePlanResponse

Gets a usage plan of a given plan identifier.

Gets a usage plan of a given plan identifier.

Attributes

def getUsagePlanKey(usagePlanId: String, keyId: String)(using aws: AwsClient): GetUsagePlanKeyResponse

Gets a usage plan key of a given key identifier.

Gets a usage plan key of a given key identifier.

Attributes

def getUsagePlanKeys(usagePlanId: String)(using aws: AwsClient): Seq[UsagePlanKey]

Gets all the usage plan keys representing the API keys added to a specified usage plan.

Gets all the usage plan keys representing the API keys added to a specified usage plan.

Attributes

def listApiMappings(domainName: String)(using aws: AwsClient): Seq[BasePathMapping]

Lists BasePathMapping resources.

Lists BasePathMapping resources.

Attributes

def listDomainNames()(using aws: AwsClient): Seq[DomainName]

Lists domain name resources.

Lists domain name resources.

Attributes

def listResources(restApiId: String)(using aws: AwsClient): Seq[Resource]

Lists resources.

Lists resources.

Attributes

def listRestApis()(using aws: AwsClient): Seq[RestApi]

Lists the RestApis resources for your collection.

Lists the RestApis resources for your collection.

Attributes

def listStages(restApiId: String)(using aws: AwsClient): Seq[Stage]

Gets information about one or more Stage resources.

Gets information about one or more Stage resources.

Attributes

def listUsagePlans()(using aws: AwsClient): Seq[UsagePlan]

Gets all the usage plans of the caller's account.

Gets all the usage plans of the caller's account.

Attributes

Generated with