Describe Function

cloudfront_describe_function

R Documentation

Gets configuration information and metadata about a CloudFront function, but not the function's code

Description

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

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

Usage

cloudfront_describe_function(Name, Stage)

Arguments

Name

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

Stage

The function's stage, either DEVELOPMENT or LIVE.

Value

A list with the following syntax:

list(
  FunctionSummary = list(
    Name = "string",
    Status = "string",
    FunctionConfig = list(
      Comment = "string",
      Runtime = "cloudfront-js-1.0"|"cloudfront-js-2.0",
      KeyValueStoreAssociations = list(
        Quantity = 123,
        Items = list(
          list(
            KeyValueStoreARN = "string"
          )
        )
      )
    ),
    FunctionMetadata = list(
      FunctionARN = "string",
      Stage = "DEVELOPMENT"|"LIVE",
      CreatedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  ETag = "string"
)

Request syntax

svc$describe_function(
  Name = "string",
  Stage = "DEVELOPMENT"|"LIVE"
)