function-active¶
Description¶
Waits for the function’s State to be Active. It will poll every 5 seconds until a successful state has been reached. This will exit with a return code of 255 after 60 failed checks.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
function-active
--function-name <value>
[--qualifier <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--function-name (string)
The name of the Lambda function, version, or alias.
Name formats
Function name -
my-function(name-only),my-function:v1(with alias).Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function.Partial ARN -
123456789012:function:my-function.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.
--qualifier (string)
Specify a version or alias to get details about a published version of the function.
--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.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Output¶
None