update-web-function-endpoint¶

Description¶

Updates the configuration of a web function endpoint. You can modify the authorization type, auto-deployment mode, revision weights, scaling, and throttling settings.

Synopsis¶

  update-web-function-endpoint
--function-name <value>
--endpoint-name <value>
[--description <value>]
[--auth-type <value>]
[--auto-deployment-mode <value>]
[--revision-weights <value>]
[--scaling-config <value>]
[--throttle-config <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

--endpoint-name (string) [required]

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

Constraints:

min: 1

max: 256

--description (string)

A description of the endpoint.

Constraints:

min: 0

max: 256

--auth-type (string)

The authorization type for the endpoint.

Possible values:

ApplicationManaged

IamAuth

--auto-deployment-mode (string)

The auto-deployment mode for the endpoint.

Possible values:

LatestRevision

Disabled

--revision-weights (list)

A list of revision weights that determine how traffic is distributed across revisions.

Constraints:

min: 1

max: 2

(structure)

Specifies a revision and its traffic weight for an endpoint. Up to two revisions can be assigned weights to split traffic for canary or blue-green deployments.

revisionId -> (string) [required]

The identifier of the revision.

Constraints:

min: 1

max: 256

weight -> (integer) [required]

The percentage of traffic to route to this revision. Minimum value of 1, maximum value of 100.

Constraints:

min: 1

max: 100

Shorthand Syntax:

revisionId=string,weight=integer ...

JSON Syntax:

[
  {
    "revisionId": "string",
    "weight": integer
  }
  ...
]

--scaling-config (structure)

The scaling configuration for the endpoint. Omit this field to keep the current scaling configuration. To clear a previously set maxEnvironments value, specify an empty object.

maxEnvironments -> (integer)

The maximum number of concurrent execution environments for the endpoint. Minimum value of 2, maximum value of 10000. There is no default value. If you don’t specify a value, the scaling configuration is absent from the response. On an update, omit scalingConfig to keep the current value, or specify an empty object to clear a previously set value.

Constraints:

min: 2

max: 10000

Shorthand Syntax:

maxEnvironments=integer

JSON Syntax:

{
  "maxEnvironments": integer
}

--throttle-config (structure)

The throttling configuration for the endpoint. Omit this field to keep the current throttling configuration. To clear a previously set rateLimit value, specify an empty object.

rateLimit -> (integer)

The maximum request rate per second for the endpoint. The value must be one of the following supported values: 0 , 100 , 200 , 300 , 400 , 500 , 600 , 700 , 800 , 900 , 1000 , 2000 , 3000 , 4000 , 5000 , 6000 , 7000 , 8000 , 9000 , or 10000 . The maximum effective value is also bounded by your account-level maximum total rate limit. There is no default value. If you don’t specify a value, the throttling configuration is absent from the response. On an update, omit throttleConfig to keep the current value, or specify an empty object to clear a previously set value.

Constraints:

min: 0

Shorthand Syntax:

rateLimit=integer

JSON Syntax:

{
  "rateLimit": integer
}

--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

endpointArn -> (string)

The Amazon Resource Name (ARN) of the endpoint.

Constraints:

min: 1

max: 2048

endpointName -> (string)

The name of the endpoint.

Constraints:

min: 1

max: 256

description -> (string)

The description of the endpoint.

Constraints:

min: 0

max: 256

endpointType -> (string)

The type of a web function endpoint. Possible values: HomeRegion (serves from the Region where the function was created), MultiRegion (replicates across chosen Regions and routes to the nearest), PerRegion (separate endpoint per Region).

Possible values:

HomeRegion

MultiRegion

PerRegion

domainName -> (string)

The domain name assigned to the endpoint.

Constraints:

min: 4

max: 256

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

authType -> (string)

The authorization type for a web function endpoint. Possible values: ApplicationManaged (the function handles authorization), IamAuth (Lambda authorizes requests with AWS SigV4 and IAM).

Possible values:

ApplicationManaged

IamAuth

autoDeploymentMode -> (string)

The auto-deployment mode for a web function endpoint. Possible values: LatestRevision (endpoint automatically serves the newest revision), Disabled (revision routing is fixed until explicitly changed).

Possible values:

LatestRevision

Disabled

revisionWeights -> (list)

The traffic distribution across revisions for the endpoint. Each entry maps a revision to a weight from 1 to 100.

Constraints:

min: 1

max: 2

(structure)

Specifies a revision and its traffic weight for an endpoint. Up to two revisions can be assigned weights to split traffic for canary or blue-green deployments.

revisionId -> (string) [required]

The identifier of the revision.

Constraints:

min: 1

max: 256

weight -> (integer) [required]

The percentage of traffic to route to this revision. Minimum value of 1, maximum value of 100.

Constraints:

min: 1

max: 100

regions -> (list)

The Regions configured for the endpoint.

Constraints:

min: 1

max: 100

(string)

Constraints:

min: 1

max: 50

pattern: ([a-z]{2,}-){2,}[0-9]

scalingConfig -> (structure)

The scaling configuration for a web function endpoint.

maxEnvironments -> (integer)

The maximum number of concurrent execution environments for the endpoint. Minimum value of 2, maximum value of 10000. There is no default value. If you don’t specify a value, the scaling configuration is absent from the response. On an update, omit scalingConfig to keep the current value, or specify an empty object to clear a previously set value.

Constraints:

min: 2

max: 10000

throttleConfig -> (structure)

The throttling configuration for a web function endpoint.

rateLimit -> (integer)

The maximum request rate per second for the endpoint. The value must be one of the following supported values: 0 , 100 , 200 , 300 , 400 , 500 , 600 , 700 , 800 , 900 , 1000 , 2000 , 3000 , 4000 , 5000 , 6000 , 7000 , 8000 , 9000 , or 10000 . The maximum effective value is also bounded by your account-level maximum total rate limit. There is no default value. If you don’t specify a value, the throttling configuration is absent from the response. On an update, omit throttleConfig to keep the current value, or specify an empty object to clear a previously set value.

Constraints:

min: 0

state -> (string)

The current state of the endpoint.

Possible values:

Pending

Active

Failed

Deleting

stateReason -> (string)

The reason for the current state of the endpoint.

updateStatus -> (string)

The status of the most recent update to an endpoint. Possible values: InProgress (update is in progress), Successful (update completed successfully), Failed (update failed).

Possible values:

InProgress

Successful

Failed

updateStatusReason -> (string)

The reason for the endpoint’s most recent update status.

regionalEndpoints -> (map)

The list of regional endpoint configurations.

key -> (string)

Constraints:

min: 1

max: 50

pattern: ([a-z]{2,}-){2,}[0-9]

value -> (structure)

Represents the endpoint configuration and state in a specific Region.

domainName -> (string)

The domain name of the regional endpoint.

Constraints:

min: 4

max: 256

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

authType -> (string) [required]

The authorization type for the regional endpoint.

Possible values:

ApplicationManaged

IamAuth

revisionWeights -> (list) [required]

The revision weights for the regional endpoint.

Constraints:

min: 1

max: 2

(structure)

Specifies a revision and its traffic weight for an endpoint. Up to two revisions can be assigned weights to split traffic for canary or blue-green deployments.

revisionId -> (string) [required]

The identifier of the revision.

Constraints:

min: 1

max: 256

weight -> (integer) [required]

The percentage of traffic to route to this revision. Minimum value of 1, maximum value of 100.

Constraints:

min: 1

max: 100

scalingConfig -> (structure)

The scaling configuration for the regional endpoint. This field is absent if the endpoint has no scaling configuration.

maxEnvironments -> (integer)

The maximum number of concurrent execution environments for the endpoint. Minimum value of 2, maximum value of 10000. There is no default value. If you don’t specify a value, the scaling configuration is absent from the response. On an update, omit scalingConfig to keep the current value, or specify an empty object to clear a previously set value.

Constraints:

min: 2

max: 10000

throttleConfig -> (structure)

The throttling configuration for the regional endpoint. This field is absent if the endpoint has no throttling configuration.

rateLimit -> (integer)

The maximum request rate per second for the endpoint. The value must be one of the following supported values: 0 , 100 , 200 , 300 , 400 , 500 , 600 , 700 , 800 , 900 , 1000 , 2000 , 3000 , 4000 , 5000 , 6000 , 7000 , 8000 , 9000 , or 10000 . The maximum effective value is also bounded by your account-level maximum total rate limit. There is no default value. If you don’t specify a value, the throttling configuration is absent from the response. On an update, omit throttleConfig to keep the current value, or specify an empty object to clear a previously set value.

Constraints:

min: 0

state -> (string) [required]

The current state of the regional endpoint.

Possible values:

Pending

Active

Failed

Deleting

stateReason -> (string) [required]

The reason for the current state of the regional endpoint.

updateStatus -> (string)

The status of the most recent update to the regional endpoint.

Possible values:

InProgress

Successful

Failed

updateStatusReason -> (string)

The reason for the current update status of the regional endpoint.

createdAt -> (timestamp)

The date and time the endpoint was created.

updatedAt -> (timestamp)

The date and time the endpoint was last updated.

Table of Contents

Feedback

User Guide

update-web-function-endpoint¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶