APIs.io Engineering Platform 2015 03 31 API
The 2015 03 31 API from APIs.io Engineering Platform — 13 operation(s) for 2015 03 31.
This API exposes 23 operations across 13 paths, and defines 162 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.
Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.
23 operations
13 paths
162 schemas
4 DELETE9 GET6 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
APIs.io Engineering Platform 2015 03 31 API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac— Amazon Signature authorization v4
Paths & Operations 23
Across 13 paths, the API surfaces 23 operations — 4 DELETE, 9 GET, 6 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
2015 03 31 23
POST
/2015-03-31/functions/{FunctionName}/policy
Grants an Amazon Web Service, Amazon Web Services account, or Amazon Web Services organization permission to use a function. You can apply the policy at the function level, or specify a qualifier to…
GET
/2015-03-31/functions/{FunctionName}/policy
Returns the resource-based IAM policy for a function, version, or alias.
POST
/2015-03-31/functions/{FunctionName}/aliases
Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version. You can also map an alias to split invocat…
GET
/2015-03-31/functions/{FunctionName}/aliases
Returns a list of aliases for a Lambda function.
POST
/2015-03-31/event-source-mappings/
Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and invokes the function. For details about how to configure different event sources, see th…
GET
/2015-03-31/event-source-mappings/
Lists event source mappings. Specify an EventSourceArn to show only event source mappings for a single event source.
POST
/2015-03-31/functions
Creates a Lambda function. To create a function, you need a deployment package and an execution role . The deployment package is a .zip file archive or container image that contains your function cod…
DELETE
/2015-03-31/functions/{FunctionName}/aliases/{Name}
Deletes a Lambda function alias .
GET
/2015-03-31/functions/{FunctionName}/aliases/{Name}
Returns details about a Lambda function alias .
PUT
/2015-03-31/functions/{FunctionName}/aliases/{Name}
Updates the configuration of a Lambda function alias .
DELETE
/2015-03-31/event-source-mappings/{UUID}
Deletes an event source mapping . You can get the identifier of a mapping from the output of ListEventSourceMappings . When you delete an event source mapping, it enters a Deleting state and might no…
GET
/2015-03-31/event-source-mappings/{UUID}
Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings .
PUT
/2015-03-31/event-source-mappings/{UUID}
Updates an event source mapping. You can change the function that Lambda invokes, or pause invocation and resume later from the same location. For details about how to configure different event sourc…
DELETE
/2015-03-31/functions/{FunctionName}
Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted. To delete Lambda event source mappings that invoke a fu…
GET
/2015-03-31/functions/{FunctionName}
Returns information about the function or function version, with a link to download the deployment package that's valid for 10 minutes. If you specify a function version, only details that are specif…
GET
/2015-03-31/functions/{FunctionName}/configuration
Returns the version-specific settings of a Lambda function or version. The output includes only options that can vary between versions of a function. To modify these settings, use UpdateFunctionConfi…
PUT
/2015-03-31/functions/{FunctionName}/configuration
Modify the version-specific settings of a Lambda function. When you update a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC,…
POST
/2015-03-31/functions/{FunctionName}/invocations
Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. To invoke a function asynchronously, set InvocationType to Event . For synchronous i…
GET
/2015-03-31/functions/
Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call. Set FunctionVersion to ALL to include all published versions of each f…
GET
/2015-03-31/functions/{FunctionName}/versions
Returns a list of versions , with the version-specific configuration of each. Lambda returns up to 50 versions per call.
POST
/2015-03-31/functions/{FunctionName}/versions
Creates a version from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change. Lambda doesn't publish a versio…
DELETE
/2015-03-31/functions/{FunctionName}/policy/{StatementId}
Revokes function-use permission from an Amazon Web Service or another Amazon Web Services account. You can get the ID of the statement from the output of GetPolicy .
PUT
/2015-03-31/functions/{FunctionName}/code
Updates a Lambda function's code. If code signing is enabled for the function, the code package must be signed by a trusted publisher. For more information, see Configuring code signing for Lambda .…
Schemas 162
The contract defines 162 schemas that model the data the API accepts and returns. The most detailed are FunctionConfiguration (35 properties), EventSourceMappingConfiguration (27 properties), AliasConfiguration (6 properties), Layer (4 properties). Each schema is shown below with its type and property counts.
ImageConfigError
object
Error response to GetFunctionConfiguration .
2 properties
EnvironmentError
object
Error messages for environment variables that couldn't be applied.
2 properties
KMSInvalidStateException
TooManyRequestsException
EFSMountFailureException
ReservedConcurrentExecutions
integer
FileSystemConfig
object
Details about the connection between a Lambda function and an Amazon EFS file system .
2 properties
2 required
LocalMountPath
string
MaximumConcurrency
integer
SnapStartResponse
object
The function's SnapStart setting.
2 properties
AliasConfiguration
object
Provides configuration information about a Lambda function alias .
6 properties
EventSourceMappingConfiguration
object
A mapping between an Amazon Web Services resource and a Lambda function. For details, see CreateEventSourceMapping .
27 properties
GetPolicyResponse
object
2 properties
CodeVerificationFailedException
MaximumRecordAgeInSeconds
integer
Layer
object
An Lambda layer .
4 properties
Timestamp
string
GetFunctionResponse
object
4 properties
SensitiveString
string
Pattern
string
VpcId
string
VpcConfigResponse
object
The VPC security groups and subnets that are attached to a Lambda function.
3 properties
URI
string
ResourceConflictException
DatabaseName
string
InvalidParameterValueException
ENILimitReachedException
Topic
string
EphemeralStorageSize
integer
EnvironmentVariableValue
string
AmazonManagedKafkaEventSourceConfig
object
Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
1 property
SnapStartTimeoutException
EndpointLists
array
ListEventSourceMappingsResponse
object
2 properties
CollectionName
string
EphemeralStorage
object
The size of the function's /tmp directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.
1 property
1 required
InvalidRuntimeException
SourceAccessType
string
Filter
object
A structure within a FilterCriteria object that defines an event filtering pattern.
1 property
SelfManagedKafkaEventSourceConfig
object
Specific configuration settings for a self-managed Apache Kafka event source.
1 property
FunctionResponseTypeList
array
CodeStorageExceededException
Queue
string
Endpoint
string
ListAliasesResponse
object
2 properties
FunctionCodeLocation
object
Details about a function's deployment package.
4 properties
Endpoints
object
EnvironmentVariables
object
StringList
array
Version
string
ResourceNotReadyException
TracingConfigResponse
object
The function's X-Ray tracing configuration.
1 property
StateReasonCode
string
FunctionArn
string
SecurityGroupId
string
NameSpacedFunctionArn
string
Topics
array
Arn
string
AliasList
array
SnapStartApplyOn
string
S3Key
string
SecurityGroupIds
array
FunctionConfiguration
object
Details about a function's configuration.
35 properties
FilterCriteria
object
An object that contains the filters for an event source.
1 property
ArchitecturesList
array
DestinationConfig
object
A configuration object that specifies the destination of an event after Lambda processes it.
2 properties
ImageConfigResponse
object
Response to a GetFunctionConfiguration request.
2 properties
ScalingConfig
object
(Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value.
1 property
ParallelizationFactor
integer
Alias
string
LastUpdateStatusReason
string
EFSMountTimeoutException
SubnetIds
array
SourceAccessConfiguration
object
To secure and define access to your event source, you can specify the authentication protocol, VPC components, or virtual host.
2 properties
Runtime
string
FunctionList
array
SubnetIPAddressLimitReachedException
RequestTooLargeException
PackageType
string
FileSystemConfigList
array
SubnetId
string
DocumentDBEventSourceConfig
object
Specific configuration settings for a DocumentDB event source.
3 properties
Timeout
integer
EC2UnexpectedException
WorkingDirectory
string
FullDocument
string
CodeSigningConfigNotFoundException
DestinationArn
string
Weight
number
FunctionResponseType
string
KMSNotFoundException
LastUpdateStatusReasonCode
string
AliasRoutingConfiguration
object
The traffic-shifting configuration of a Lambda function alias.
1 property
RuntimeVersionConfig
object
The ARN of the runtime and any errors that occured.
2 properties
InvocationResponse
object
2 properties
PolicyLengthExceededException
PreconditionFailedException
MaximumRetryAttemptsEventSourceMapping
integer
InvalidZipFileException
EnvironmentResponse
object
The results of an operation to update or read environment variables. If the operation succeeds, the response contains the environment variables. If it fails, t…
2 properties
Long
integer
AdditionalVersionWeights
object
ResourceArn
string
InvalidRequestContentException
String
string
S3Bucket
string
KMSAccessDeniedException
Concurrency
object
1 property
SnapStartOptimizationStatus
string
RuntimeVersionError
object
Any error returned when the runtime version information for the function could not be retrieved.
2 properties
ImageConfig
object
Configuration values that override the container image Dockerfile settings. For more information, see Container image settings .
3 properties
ServiceException
TracingMode
string
ListFunctionsResponse
object
A list of Lambda functions.
2 properties
ResourceNotFoundException
Architecture
string
FileSystemArn
string
EC2AccessDeniedException
EFSMountConnectivityException
UnsupportedMediaTypeException
MemorySize
integer
FilterList
array
TagValue
string
RoleArn
string
SourceAccessConfigurations
array
BatchSize
integer
AddPermissionResponse
object
1 property
StateReason
string
ResourceInUseException
LayerVersionArn
string
RuntimeVersionArn
string
EC2ThrottledException
Integer
integer
SnapStartNotReadyException
KMSDisabledException
LayersReferenceList
array
OnSuccess
object
A destination for events that were processed successfully.
1 property
InvalidCodeSignatureException
OnFailure
object
A destination for events that failed processing.
1 property
InvalidSubnetIDException
EFSIOException
State
string
MaximumBatchingWindowInSeconds
integer
TumblingWindowInSeconds
integer
SelfManagedEventSource
object
The self-managed Apache Kafka cluster for your event source.
1 property
S3ObjectVersion
string
LastUpdateStatus
string
EventSourcePosition
string
Description
string
EventSourceMappingsList
array
ListVersionsByFunctionResponse
object
2 properties
InvalidSecurityGroupIDException
Queues
array
Date
string
KMSKeyArn
string
DeadLetterConfig
object
The dead-letter queue for failed asynchronous invocations.
1 property
BisectBatchOnFunctionError
boolean
Blob
string
NamespacedFunctionName
string
SnapStartException
Tags
object
Handler
string
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#2015 03 31