get-web-function-revision¶

Description¶

Retrieves details about a web function revision, including its state and configuration.

Synopsis¶

  get-web-function-revision
--function-name <value>
--revision-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--function-name (string) [required]

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

Constraints:

min: 1

max: 256

--revision-id (string) [required]

The identifier of the revision to retrieve. You can specify the revision identifier or the revision ARN. The length constraint applies only to the full ARN.

Constraints:

min: 1

max: 256

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

functionArn -> (string)

The Amazon Resource Name (ARN) of the web function.

Constraints:

min: 1

max: 2048

revisionArn -> (string)

The Amazon Resource Name (ARN) of the revision.

Constraints:

min: 1

max: 2048

revisionId -> (string)

The identifier of the revision.

Constraints:

min: 1

max: 256

description -> (string)

The description of the revision.

Constraints:

min: 0

max: 256

kmsKeyArn -> (string)

The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the revision’s code and environment variables.

Constraints:

min: 20

max: 2048

pattern: arn:(aws[a-z-]*):kms:[a-z0-9-]+:[0-9]{12}:key/[a-z0-9-]+

buildConfig -> (structure)

The build configuration for a web function revision, including code location and runtime settings.

codeConfig -> (structure) [required]

The code configuration specifying where the deployment artifact is stored.

s3Object -> (structure) [required]

The Amazon S3 location of the deployment artifact.

bucket -> (string) [required]

The name of the Amazon S3 bucket. Must be between 3 and 63 characters.

Constraints:

min: 3

max: 63

pattern: ([a-z0-9][a-z0-9\.\-]{1,61}[a-z0-9])

key -> (string) [required]

The Amazon S3 object key. Must be between 1 and 1024 characters.

Constraints:

min: 1

max: 1024

versionId -> (string)

The version ID of the Amazon S3 object.

Constraints:

min: 1

max: 1024

runtimeConfig -> (structure) [required]

The runtime configuration for the revision.

runtime -> (string) [required]

The runtime identifier for the web function (for example, a Node.js runtime identifier).

Constraints:

min: 1

max: 30

pattern: [a-z][a-z0-9]*(\.[a-z0-9]+)*

serviceConfig -> (structure)

The service configuration for a web function revision, including execution role, timeout, concurrency, and telemetry settings.

executionRoleArn -> (string) [required]

The ARN of the IAM role that the web function assumes when it runs. This role provides permissions to access AWS services and resources.

Constraints:

min: 20

max: 2048

pattern: arn:(aws[a-z-]*):iam::[0-9]{12}:role/[a-zA-Z0-9+=,.@_/-]+

timeoutSeconds -> (integer)

The amount of time (in seconds) that Lambda allows the web function to run before stopping it. Minimum value of 3, maximum value of 900. If you don’t specify a value, the default is 30, and this default is returned in the response.

Constraints:

min: 3

max: 900

maxConcurrencyPerEnvironment -> (integer)

The maximum number of concurrent requests handled per execution environment. Minimum value of 1, maximum value of 128. If you don’t specify a value, the default is 64, and this default is returned in the response.

Constraints:

min: 1

max: 128

environmentVariables -> (map)

A map of environment variable key-value pairs available to the web function at runtime. Environment variable values are sensitive.

key -> (string)

Constraints:

min: 1

pattern: [a-zA-Z]([a-zA-Z0-9_])*

value -> (string)

Constraints:

min: 1

telemetryConfig -> (structure)

The telemetry configuration for the web function, including logging settings.

loggingConfig -> (structure)

The logging configuration for the web function.

logGroup -> (string)

The name of the Amazon CloudWatch Logs log group the web function sends logs to. If you don’t specify a value, the default is /aws/lambda/web/{functionName} , and this default is returned in the response.

Constraints:

min: 1

max: 500

pattern: [a-zA-Z0-9\.\-_/#]+

applicationLogLevel -> (string)

The log level for application logs emitted by the web function. If you don’t specify a value, the default is INFO , and this default is returned in the response.

Possible values:

TRACE

DEBUG

INFO

WARN

ERROR

FATAL

systemLogLevel -> (string)

The log level for system logs emitted by the Lambda runtime. If you don’t specify a value, the default is INFO , and this default is returned in the response.

Possible values:

DEBUG

INFO

WARN

state -> (string)

The current state of the revision.

Possible values:

Pending

Active

Failed

stateReason -> (string)

The reason for the current state of the revision.

errors -> (list)

A list of errors encountered during revision creation. This field is absent when the revision has no errors.

Constraints:

min: 1

max: 50

(structure)

A single error encountered while creating or reading a web function revision. The error describes the affected attribute, an error code, and a human-readable message. This structure is present only when the revision has errors.

attribute -> (string) [required]

The name of the revision attribute that the error applies to. Must be between 1 and 64 characters.

Constraints:

min: 1

max: 64

errorCode -> (string) [required]

A short, machine-readable code that identifies the error. Must be between 1 and 64 characters.

Constraints:

min: 1

max: 64

errorMessage -> (string) [required]

A human-readable message describing the error. Must be between 1 and 2048 characters.

Constraints:

min: 1

max: 2048

createdAt -> (timestamp)

The date and time the revision was created.

Table of Contents

Feedback

User Guide