openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 384 kB

JSON

{"openapi":"3.0.0","info":{"version":"2015-03-31","x-release":"v4","title":"AWS Lambda","description":"<fullname>Lambda</fullname> Overview Lambda is a compute service that lets you run code without provisioning or managing servers. Lambda runs your code on a high-availability compute infrastructure and performs all of the administration of the compute resources, including server and operating system maintenance, capacity provisioning and automatic scaling, code monitoring and logging. With Lambda, you can run code for virtually any type of application or backend service. For more information about the Lambda service, see <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/welcome.html\">What is Lambda</a> in the Lambda Developer Guide. The Lambda API Reference provides information about each of the API methods, including details about the parameters in each API request and response. You can use Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools to access the API. For installation instructions, see <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services</a>. For a list of Region-specific endpoints that Lambda supports, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/lambda-service.html/\">Lambda endpoints and quotas </a> in the Amazon Web Services General Reference.. When making the API calls, you will need to authenticate your request by providing a signature. Lambda supports signature version 4. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 signing process</a> in the Amazon Web Services General Reference.. CA certificates Because Amazon Web Services SDKs use the CA certificates from your computer, changes to the certificates on the Amazon Web Services servers can cause connection failures when you attempt to use an SDK. You can prevent these failures by keeping your computer's CA certificates and operating system up-to-date. If you encounter this issue in a corporate environment and do not manage your own computer, you might need to ask an administrator to assist with the update process. The following list shows minimum operating system and Java versions: <ul> <li> Microsoft Windows versions that have updates from January 2005 or later installed contain at least one of the required CAs in their trust list. </li> <li> Mac OS X 10.4 with Java for Mac OS X 10.4 Release 5 (February 2007), Mac OS X 10.5 (October 2007), and later versions contain at least one of the required CAs in their trust list. </li> <li> Red Hat Enterprise Linux 5 (March 2007), 6, and 7 and CentOS 5, 6, and 7 all contain at least one of the required CAs in their default trusted CA list. </li> <li> Java 1.4.2_12 (May 2006), 5 Update 2 (March 2005), and all later versions, including Java 6 (December 2006), 7, and 8, contain at least one of the required CAs in their default trusted CA list. </li> </ul> When accessing the Lambda management console or Lambda API endpoints, whether through browsers or programmatically, you will need to ensure your client machines support any of the following CAs: <ul> <li> Amazon Root CA 1 </li> <li> Starfield Services Root Certificate Authority - G2 </li> <li> Starfield Class 2 Certification Authority </li> </ul> Root certificates from the first two authorities are available from <a href=\"https://www.amazontrust.com/repository/\">Amazon trust services</a>, but keeping your computer up-to-date is the more straightforward solution. To learn more about ACM-provided certificates, see <a href=\"http://aws.amazon.com/certificate-manager/faqs/#certificates\">Amazon Web Services Certificate Manager FAQs.</a> ","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"lambda","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/lambda-2015-03-31.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/lambda/"},"servers":[{"url":"http://lambda.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AWS Lambda multi-region endpoint"},{"url":"https://lambda.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AWS Lambda multi-region endpoint"},{"url":"http://lambda.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AWS Lambda endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://lambda.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AWS Lambda endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy":{"post":{"operationId":"AddLayerVersionPermission","description":"Adds permissions to the resource-based policy of a version of an <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html\">Lambda layer</a>. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all accounts in an organization, or all Amazon Web Services accounts. To revoke permission, call <a>RemoveLayerVersionPermission</a> with the statement ID that you specified when you added it.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddLayerVersionPermissionResponse"}}}},"480":{"description":"ServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ResourceConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceConflictException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"484":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"485":{"description":"PolicyLengthExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyLengthExceededException"}}}},"486":{"description":"PreconditionFailedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionFailedException"}}}}},"parameters":[{"name":"LayerName","in":"path","required":true,"description":"The name or Amazon Resource Name (ARN) of the layer.","schema":{"type":"string","pattern":"(arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\\d{12}:layer:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+","minLength":1,"maxLength":140}},{"name":"VersionNumber","in":"path","required":true,"description":"The version number.","schema":{"type":"integer"}},{"name":"RevisionId","in":"query","required":false,"description":"Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StatementId","Action","Principal"],"properties":{"StatementId":{"description":"An identifier that distinguishes the policy from others on the same layer version.","type":"string","pattern":"([a-zA-Z0-9-_]+)","minLength":1,"maxLength":100},"Action":{"description":"The API action that grants access to the layer. For example, <code>lambda:GetLayerVersion</code>.","type":"string","pattern":"lambda:GetLayerVersion","maxLength":22},"Principal":{"description":"An account ID, or <code>*</code> to grant layer usage permission to all accounts in an organization, or all Amazon Web Services accounts (if <code>organizationId</code> is not specified). For the last case, make sure that you really do want all Amazon Web Services accounts to have usage permission to this layer. ","type":"string","pattern":"\\d{12}|\\*|arn:(aws[a-zA-Z-]*):iam::\\d{12}:root"},"OrganizationId":{"description":"With the principal set to <code>*</code>, grant permission to all accounts in the specified organization.","type":"string","pattern":"o-[a-z0-9]{10,32}","maxLength":34}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetLayerVersionPolicy","description":"Returns the permission policy for a version of an <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html\">Lambda layer</a>. For more information, see <a>AddLayerVersionPermission</a>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLayerVersionPolicyResponse"}}}},"480":{"description":"ServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"483":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}}},"parameters":[{"name":"LayerName","in":"path","required":true,"description":"The name or Amazon Resource Name (ARN) of the layer.","schema":{"type":"string","pattern":"(arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\\d{12}:layer:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+","minLength":1,"maxLength":140}},{"name":"VersionNumber","in":"path","required":true,"description":"The version number.","schema":{"type":"integer"}}]}},"/2015-03-31/functions/{FunctionName}/policy":{"post":{"operationId":"AddPermission","description":"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 the account ID as the <code>Principal</code>. To grant permission to an organization defined in Organizations, specify the organization ID as the <code>PrincipalOrgID</code>. For Amazon Web Services, the principal is a domain-style identifier that the service defines, such as <code>s3.amazonaws.com</code> or <code>sns.amazonaws.com</code>. For Amazon Web Services, you can also specify the ARN of the associated resource as the <code>SourceArn</code>. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function. This operation adds a statement to a resource-based permissions policy for the function. For more information about function policies, see <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html\">Using resource-based policies for Lambda</a>.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddPermissionResponse"}}}},"480":{"description":"ServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ResourceConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceConflictException"}}}},"483":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"484":{"description":"PolicyLengthExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyLengthExceededException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"486":{"description":"PreconditionFailedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionFailedException"}}}}},"parameters":[{"name":"FunctionName","in":"path","required":true,"description":"The name of the Lambda function, version, or alias. Name formats <ul> <li> Function name – <code>my-function</code> (name-only), <code>my-function:v1</code> (with alias). </li> <li> Function ARN – <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>. </li> <li> Partial ARN – <code>123456789012:function:my-function</code>. </li> </ul> 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.","schema":{"type":"string","pattern":"(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?","minLength":1,"maxLength":140}},{"name":"Qualifier","in":"query","required":false,"description":"Specify a version or alias to add permissions to a published version of the function.","schema":{"type":"string","pattern":"(|[a-zA-Z0-9$_-]+)","minLength":1,"maxLength":128}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StatementId","Action","Principal"],"properties":{"StatementId":{"description":"A statement identifier that differentiates the statement from others in the same policy.","type":"string","pattern":"([a-zA-Z0-9-_]+)","minLength":1,"maxLength":100},"Action":{"description":"The action that the principal can use on the function. For example, <code>lambda:InvokeFunction</code> or <code>lambda:GetFunction</code>.","type":"string","pattern":"(lambda:[*]|lambda:[a-zA-Z]+|[*])"},"Principal":{"description":"The Amazon Web Service or Amazon Web Services account that invokes the function. If you specify a service, use <code>SourceArn</code> or <code>SourceAccount</code> to limit who can invoke the function through that service.","type":"string","pattern":"[^\\s]+"},"SourceArn":{"description":"For Amazon Web Services, the ARN of the Amazon Web Services resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic. Note that Lambda configures the comparison using the <code>StringLike</code> operator.","type":"string","pattern":"arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]{2}(-gov)?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)"},"SourceAccount":{"description":"For Amazon Web Service, the ID of the Amazon Web Services account that owns the resource. Use this together with <code>SourceArn</code> to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.","type":"string","pattern":"\\d{12}","maxLength":12},"EventSourceToken":{"description":"For Alexa Smart Home functions, a token that the invoker must supply.","type":"string","pattern":"[a-zA-Z0-9._\\-]+","minLength":0,"maxLength":256},"RevisionId":{"description":"Update the policy only if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.","type":"string"},"PrincipalOrgID":{"description":"The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.","type":"string","pattern":"^o-[a-z0-9]{10,32}$","minLength":12,"maxLength":34},"FunctionUrlAuthType":{"description":"The type of authentication that your function URL uses. Set to <code>AWS_IAM</code> if you want to restrict access to authenticated users only. Set to <code>NONE</code> if you want to bypass IAM authentication to create a public endpoint. For more information, see <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html\">Security and auth model for Lambda function URLs</a>.","type":"string","enum":["NONE","AWS_IAM"]}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetPolicy","description":"Returns the <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html\">resource-based IAM policy</a> for a function, version, or alias.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPolicyResponse"}}}},"480":{"description":"ServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"483":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}}},"parameters":[{"name":"FunctionName","in":"path","required":true,"description":"The name of the Lambda function, version, or alias. Name formats <ul> <li> Function name – <code>my-function</code> (name-only), <code>my-function:v1</code> (with alias). </li> <li> Function ARN – <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>. </li> <li> Partial ARN – <code>123456789012:function:my-function</code>. </li> </ul> 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.","schema":{"type":"string","pattern":"(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_\\.]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?","minLength":1,"maxLength":170}},{"name":"Qualifier","in":"query","required":false,"description":"Specify a version or alias to get the policy for that resource.","schema":{"type":"string","pattern":"(|[a-zA-Z0-9$_-]+)","minLength":1,"maxLength":128}}]}},"/2015-03-31/functions/{FunctionName}/aliases":{"post":{"operationId":"CreateAlias","description":"Creates an <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html\">alias</a> 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 <code>RoutingConfig</code> parameter to specify a second version and the percentage of invocation requests that it receives.","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AliasConfiguration"}}}},"480":{"description":"ServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ResourceConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceConflictException"}}}},"483":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"FunctionName","in":"path","required":true,"description":"The name of the Lambda function. Name formats <ul> <li> Function name - <code>MyFunction</code>. </li> <li> Function ARN - <code>arn:aws:lambda:us-west-2:123456789012:function:MyFunction</code>. </li> <li> Partial ARN - <code>123456789012:function:MyFunction</code>. </li> </ul> The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.","schema":{"type":"string","pattern":"(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?","minLength":1,"maxLength":140}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","FunctionVersion"],"properties":{"Name":{"description":"The name of the alias.","type":"string","pattern":"(?!^[0-9]+$)([a-zA-Z0-9-_]+)","minLength":1,"maxLength":128},"FunctionVersion":{"description":"The function version that the alias invokes.","type":"string","pattern":"(\\$LATEST|[0-9]+)","minLength":1,"maxLength":1024},"Description":{"description":"A description of the alias.","type":"string","minLength":0,"maxLength":256},"RoutingConfig":{"description":"The <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html\">traffic-shifting</a> configuration of a Lambda function alias.","type":"object","properties":{"AdditionalVersionWeights":{"allOf":[{"$ref":"#/components/schemas/AdditionalVersionWeights"},{"description":"The second version, and the percentage of traffic that's routed to it."}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListAliases","description":"Returns a list of <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html\">aliases</a> for a Lambda function.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAliasesResponse"}}}},"480":{"description":"ServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"FunctionName","in":"path","required":true,"description":"The name of the Lambda function. Name formats <ul> <li> Function name - <code>MyFunction</code>. </li> <li> Function ARN - <code>arn:aws:lambda:us-west-2:123456789012:function:MyFunction</code>. </li> <li> Partial ARN - <code>123456789012:function:MyFunction</code>. </li> </ul> The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.","schema":{"type":"string","pattern":"(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?","minLength":1,"maxLength":140}},{"name":"FunctionVersion","in":"query","required":false,"description":"Specify a function version to only list aliases that invoke that version.","schema":{"type":"string","pattern":"(\\$LATEST|[0-9]+)","minLength":1,"maxLength":1024}},{"name":"Marker","in":"query","required":false,"description":"Specify the pagination token that's returned by a previous request to retrieve the next page of results.","schema":{"type":"string"}},{"name":"MaxItems","in":"query","required":false,"description":"Limit the number of aliases returned.","schema":{"type":"integer","minimum":1,"maximum":10000}}]}},"/2020-04-22/code-signing-configs/":{"post":{"operationId":"CreateCodeSigningConfig","description":"Creates a code signing configuration. A <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html\">code signing configuration</a> defines a list of allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment validation checks fail). ","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCodeSigningConfigResponse"}}}},"480":{"description":"ServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AllowedPublishers"],"properties":{"Description":{"description":"Descriptive name for this code signing configuration.","type":"string","minLength":0,"maxLength":256},"AllowedPublishers":{"description":"List of signing profiles that can sign a code package. ","type":"object","properties":{"SigningProfileVersionArns":{"allOf":[{"$ref":"#/components/schemas/SigningProfileVersionArns"},{"description":"The Amazon Resource Name (ARN) for each of the signing profiles. A signing profile defines a trusted user who can sign a code package. "}]}}},"CodeSigningPolicies":{"description":"Code signing configuration <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html#config-codesigning-policies\">policies</a> specify the validation failure action for signature mismatch or expiry.","type":"object","properties":{"UntrustedArtifactOnDeployment":{"allOf":[{"$ref":"#/components/schemas/CodeSigningPolicy"},{"description":"Code signing configuration policy for deployment validation failure. If you set the policy to <code>Enforce</code>, Lambda blocks the deployment request if signature validation checks fail. If you set the policy to <code>Warn</code>, Lambda allows the deployment and creates a CloudWatch log. Default value: <code>Warn</code> "}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListCodeSigningConfigs","description":"Returns a list of <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/configuring-codesigning.html\">code signing configurations</a>. A request returns up to 10,000 configurations per call. You can use the <code>MaxItems</code> parameter to return fewer configurations per call. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCodeSigningConfigsResponse"}}}},"480":{"description":"ServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}}},"parameters":[{"name":"Marker","in":"query","required":false,"description":"Specify the pagination token that's returned by a previous request to retrieve the next page of results.","schema":{"type":"string"}},{"name":"MaxItems","in":"query","required":false,"description":"Maximum number of items to return.","schema":{"type":"integer","minimum":1,"maximum":10000}}]}},"/2015-03-31/event-source-mappings/":{"post":{"operationId":"CreateEventSourceMapping","description":"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. <ul> <li> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping\"> Amazon DynamoDB Streams</a> </li> <li> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping\"> Amazon Kinesis</a> </li> <li> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource\"> Amazon SQS</a> </li> <li> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping\"> Amazon MQ and RabbitMQ</a> </li> <li> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html\"> Amazon MSK</a> </li> <li> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html\"> Apache Kafka</a> </li> <li> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html\"> Amazon DocumentDB</a> </li> </ul> The following error handling options are available only for stream sources (DynamoDB and Kinesis): <ul> <li> <code>BisectBatchOnFunctionError</code> – If the function returns an error, split the batch in two and retry. </li> <li> <code>DestinationConfig</code> – Send discarded records to an Amazon SQS queue or Amazon SNS topic. </li> <li> <code>MaximumRecordAgeInSeconds</code> – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires </li> <li> <code>MaximumRetryAttempts</code> – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires. </li> <li> <code>ParallelizationFactor</code> – Process multiple batches from each shard concurrently. </li> </ul> For information about which configuration parameters apply to each event source, see the following topics. <ul> <li> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-params\"> Amazon DynamoDB Streams</a> </li> <li> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-params\"> Amazon Kinesis</a> </li> <li> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-params\"> Amazon SQS</a> </li> <li> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-params\"> Amazon MQ and RabbitMQ</a> </li> <li> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-parms\"> Amazon MSK</a> </li> <li> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-kafka-parms\"> Apache Kafka</a> </li> <li> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/with-documentdb.html#docdb-configuration\"> Amazon DocumentDB</a> </li> </ul>","responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventSourceMappingConfiguration"}}}},"480":{"description":"ServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"ResourceConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceConflictException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"484":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FunctionName"],"properties":{"EventSourceArn":{"description":"The Amazon Resource Name (ARN) of the event source. <ul> <li> Amazon Kinesis – The ARN of the data stream or a stream consumer. </li> <li> Amazon DynamoDB Streams – The ARN of the stream. </li> <li> Amazon Simple Queue Service – The ARN of the queue. </li> <li> Amazon Managed Streaming for Apache Kafka – The ARN of the cluster. </li> <li> Amazon MQ – The ARN of the broker. </li> <li> Amazon DocumentDB – The ARN of the DocumentDB change stream. </li> </ul>","type":"string","pattern":"arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]{2}(-gov)?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)"},"FunctionName":{"description":"The name of the Lambda function. Name formats <ul> <li> Function name – <code>MyFunction</code>. </li> <li> Function ARN – <code>arn:aws:lambda:us-west-2:123456789012:function:MyFunction</code>. </li> <li> Version or Alias ARN – <code>arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD</code>. </li> <li> Partial ARN – <code>123456789012:function:MyFunction</code>. </li> </ul> The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.","type":"string","pattern":"(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?","minLength":1,"maxLength":140},"Enabled":{"description":"When true, the event source mapping is active. When false, Lambda pauses polling and invocation. Default: True","type":"boolean"},"BatchSize":{"description":"The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB). <ul> <li> Amazon Kinesis – Default 100. Max 10,000. </li> <li> Amazon DynamoDB Streams – Default 100. Max 10,000. </li> <li> Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10. </li> <li> Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000. </li> <li> Self-managed Apache Kafka – Default 100. Max 10,000. </li> <li> Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000. </li> <li> DocumentDB – Default 100. Max 10,000. </li> </ul>","type":"integer","minimum":1,"maximum":10000},"FilterCriteria":{"description":" An object that contains the filters for an event source. ","type":"object","properties":{"Filters":{"allOf":[{"$ref":"#/components/schemas/FilterList"},{"description":" A list of filters. "}]}}},"MaximumBatchingWindowInSeconds":{"description":"The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure <code>MaximumBatchingWindowInSeconds</code> to any value from 0 seconds to 300 seconds in increments of seconds. For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change <code>MaximumBatchingWindowInSeconds</code> in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping. Related setting: For streams and Amazon SQS event sources, when you set <code>BatchSize</code> to a value greater than 10, you must set <code>MaximumBatchingWindowInSeconds</code> to at least 1.","type":"integer","minimum":0,"maximum":300},"ParallelizationFactor":{"description":"(Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.","type":"integer","minimum":1,"maximum":10},"StartingPosition":{"description":"The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. <code>AT_TIMESTAMP</code> is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.","type":"string","enum":["TRIM_HORIZON","LATEST","AT_TIMESTAMP"]},"StartingPositionTimestamp":{"description":"With <code>StartingPosition</code> set to <code>AT_TIMESTAMP</code>, the time from which to start reading. <code>StartingPositionTimestamp</code> cannot be in the future.","type":"string","format":"date-time"},"DestinationConfig":{"description":"A configuration object that specifies the destination of an event after Lambda processes it.","type":"object","properties":{"OnSuccess":{"allOf":[{"$ref":"#/components/schemas/OnSuccess"},{"description":"The destination configuration for successful invocations."}]},"OnFailure":{"allOf":[{"$ref":"#/components/schemas/OnFailure"},{"description":"The destination configuration for failed invocations."}]}}},"MaximumRecordAgeInSeconds":{"description":"(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1).","type":"integer","minimum":-1,"maximum":604800},"BisectBatchOnFunctionError":{"description":"(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.","type":"boolean"},"MaximumRetryAttempts":{"description":"(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.","type":"integer","minimum":-1,"maximum":10000},"TumblingWindowInSeconds":{"description":"(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.","type":"integer","minimum":0,"maximum":900},"Topics":{"description":"The name of the Kafka topic.","type":"array","items":{"$ref":"#/components/schemas/Topic"},"minItems":1,"maxItems":1},"Queues":{"description":" (MQ) The name of the Amazon MQ broker destination queue to consume. ","type":"array","items":{"$ref":"#/components/schemas/Queue"},"minItems":1,"maxItems":1},"SourceAccessConfigurations":{"description":"An array of authentication protocols or VPC components required to secure your event source.","type":"array","items":{"$ref":"#/components/schemas/SourceAccessConfiguration"},"minItems":0,"maxItems":22},"SelfManagedEventSource":{"description":"The self-managed Apache Kafka cluster for your event source.","type":"object","properties":{"Endpoints":{"allOf":[{"$ref":"#/components/schemas/Endpoints"},{"description":"The list of bootstrap servers for your Kafka brokers in the following format: <code>\"KAFKA_BOOTSTRAP_SERVERS\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"]</code>."}]}}},"FunctionResponseTypes":{"description":"(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.","type":"array","items":{"$ref":"#/components/schemas/FunctionResponseType"},"minItems":0,"maxItems":1},"AmazonManagedKafkaEventSourceConfig":{"description":"Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.","type":"object","properties":{"ConsumerGroupId":{"allOf":[{"$ref":"#/components/schemas/URI"},{"description":"The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id\">Customizable consumer group ID</a>."}]}}},"SelfManagedKafkaEventSourceConfig":{"description":"Specific configuration settings for a self-managed Apache Kafka event source.","type":"object","properties":{"ConsumerGroupId":{"allOf":[{"$ref":"#/components/schemas/URI"},{"description":"The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id\">Customizable consumer group ID</a>."}]}}},"ScalingConfig":{"description":"(Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value.","type":"object","properties":{"MaximumConcurrency":{"allOf":[{"$ref":"#/components/schemas/MaximumConcurrency"},{"description":"Limits the number of concurrent instances that the Amazon SQS event source can invoke."}]}}},"DocumentDBEventSourceConfig":{"description":" Specific configuration settings for a DocumentDB event source. ","type":"object","properties":{"DatabaseName":{"allOf":[{"$ref":"#/components/schemas/DatabaseName"},{"description":" The name of the database to consume within the DocumentDB cluster. "}]},"CollectionName":{"allOf":[{"$ref":"#/components/schemas/CollectionName"},{"description":" The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections. "}]},"FullDocument":{"allOf":[{"$ref":"#/components/schemas/FullDocument"},{"description":" Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes. "}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListEventSourceMappings","description":"Lists event source mappings. Specify an <code>EventSourceArn</code> to show only event source mappings for a single event source.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListEventSourceMappingsResponse"}}}},"480":{"description":"ServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"EventSourceArn","in":"query","required":false,"description":"The Amazon Resource Name (ARN) of the event source. <ul> <li> Amazon Kinesis – The ARN of the data stream or a stream consumer. </li> <li> Amazon DynamoDB Streams – The ARN of the stream. </li> <li> Amazon Simple Queue Service – The ARN of the queue. </li> <li> Amazon Managed Streaming for Apache Kafka – The ARN of the cluster. </li> <li> Amazon MQ – The ARN of the broker. </li> <li> Amazon DocumentDB – The ARN of the DocumentDB change stream. </li> </ul>","schema":{"type":"string","pattern":"arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]{2}(-gov)?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)"}},{"name":"FunctionName","in":"query","required":false,"description":"The name of the Lambda function. Name formats <ul> <li> Function name – <code>MyFunction</code>. </li> <li> Function ARN – <code>arn:aws:lambda:us-west-2:123456789012:function:MyFunction</code>. </li> <li> Version or Alias ARN – <code>arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD</code>. </li> <li> Partial ARN – <code>123456789012:function:MyFunction</code>. </li> </ul> The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.","schema":{"type":"string","pattern":"(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?","minLength":1,"maxLength":140}},{"name":"Marker","in":"query","required":false,"description":"A pagination token returned by a previous call.","schema":{"type":"string"}},{"name":"MaxItems","in":"query","required":false,"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.","schema":{"type":"integer","minimum":1,"maximum":10000}}]}},"/2015-03-31/functions":{"post":{"operationId":"CreateFunction","description":"Creates a Lambda function. To create a function, you need a <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html\">deployment package</a> and an <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/intro-permission-model.html#lambda-intro-execution-role\">execution role</a>. The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use Amazon Web Services, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing. If the deployment package is a <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html\">container image</a>, then you set the package type to <code>Image</code>. For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties. If the deployment package is a <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip\">.zip file archive</a>, then you set the package type to <code>Zip</code>. For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must be compatible with the target instruction set architecture of the function (<code>x86-64</code> or <code>arm64</code>). If you do not specify the architecture, the