{ "opencollection": "1.0.0", "info": { "name": "APIs.io Engineering Platform Amazon API Gateway 2014 11 13 2015 03 31 API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "2015 03 31", "type": "folder" }, "items": [ { "info": { "name": "GetPolicy", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/2015-03-31/functions/:FunctionName/policy", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "FunctionName", "value": "", "type": "path", "description": "

The name of the Lambda function, version, or alias.

Name formats

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

" }, { "name": "Qualifier", "value": "", "type": "query", "description": "Specify a version or alias to get the policy for that resource." } ] }, "docs": "Returns the resource-based IAM policy for a function, version, or alias." }, { "info": { "name": "AddPermission", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/2015-03-31/functions/:FunctionName/policy", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "FunctionName", "value": "", "type": "path", "description": "

The name of the Lambda function, version, or alias.

Name formats

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

" }, { "name": "Qualifier", "value": "", "type": "query", "description": "Specify a version or alias to add permissions to a published version of the function." } ], "body": { "type": "json", "data": "{}" } }, "docs": "

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 restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies to version $LATEST.

To grant permission to another account, specify t" }, { "info": { "name": "ListAliases", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/2015-03-31/functions/:FunctionName/aliases", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "FunctionName", "value": "", "type": "path", "description": "

The name of the Lambda function.

Name formats

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

" }, { "name": "FunctionVersion", "value": "", "type": "query", "description": "Specify a function version to only list aliases that invoke that version." }, { "name": "Marker", "value": "", "type": "query", "description": "Specify the pagination token that's returned by a previous request to retrieve the next page of results." }, { "name": "MaxItems", "value": "", "type": "query", "description": "Limit the number of aliases returned." } ] }, "docs": "Returns a list of aliases for a Lambda function." }, { "info": { "name": "CreateAlias", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/2015-03-31/functions/:FunctionName/aliases", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "FunctionName", "value": "", "type": "path", "description": "

The name of the Lambda function.

Name formats

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

" } ], "body": { "type": "json", "data": "{}" } }, "docs": "

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 invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.

" }, { "info": { "name": "ListEventSourceMappings", "type": "http" }, "http": { "method": "GET", "url": "http://apigateway.{region}.amazonaws.com/2015-03-31/event-source-mappings/", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "EventSourceArn", "value": "", "type": "query", "description": "

The Amazon Resource Name (ARN) of the event source.

" }, { "name": "FunctionName", "value": "", "type": "query", "description": "

The name of the Lambda function.

Name formats

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

" }, { "name": "Marker", "value": "", "type": "query", "description": "A pagination token returned by a previous call." }, { "name": "MaxItems", "value": "", "type": "query", "description": "The maximum number of event source mappings to return. Note that ListEventSourceMappings returns a maximum of 100 items in each response, even if you set the number higher." } ] }, "docs": "Lists event source mappings. Specify an EventSourceArn to show only event source mappings for a single event source." }, { "info": { "name": "CreateEventSourceMapping", "type": "http" }, "http": { "method": "POST", "url": "http://apigateway.{region}.amazonaws.com/2015-03-31/event-source-mappings/", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "

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 the following topics.