[ aws . cloudfront ]

describe-function

Description

Gets configuration information and metadata about a CloudFront function, but not the function’s code. To get a function’s code, use GetFunction .

To get configuration information and metadata about a function, you must provide the function’s name and stage. To get these values, you can use ListFunctions .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-function
--name <value>
[--stage <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the function that you are getting information about.

--stage (string)

The function’s stage, either DEVELOPMENT or LIVE .

Possible values:

• DEVELOPMENT

• LIVE

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

See ‘aws help’ for descriptions of global parameters.

Output

FunctionSummary -> (structure)

Contains configuration information and metadata about a CloudFront function.

Name -> (string)

The name of the CloudFront function.

Status -> (string)

The status of the CloudFront function.

FunctionConfig -> (structure)

Contains configuration information about a CloudFront function.

Comment -> (string)

A comment to describe the function.

Runtime -> (string)

The function’s runtime environment. The only valid value is cloudfront-js-1.0 .

FunctionMetadata -> (structure)

Contains metadata about a CloudFront function.

FunctionARN -> (string)

The Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the function.

Stage -> (string)

The stage that the function is in, either DEVELOPMENT or LIVE .

When a function is in the DEVELOPMENT stage, you can test the function with TestFunction , and update it with UpdateFunction .

When a function is in the LIVE stage, you can attach the function to a distribution’s cache behavior, using the function’s ARN.

CreatedTime -> (timestamp)

The date and time when the function was created.

LastModifiedTime -> (timestamp)

The date and time when the function was most recently updated.

ETag -> (string)

The version identifier for the current version of the CloudFront function.