update_function

update_function(**kwargs)

Updates a CloudFront function.

You can update a function's code or the comment that describes the function. You cannot update a function's name.

To update a function, you provide the function's name and version ( ETag value) along with the updated function code. To get the name and version, you can use ListFunctions and DescribeFunction .

See also: AWS API Documentation

Request Syntax

response = client.update_function(
    Name='string',
    IfMatch='string',
    FunctionConfig={
        'Comment': 'string',
        'Runtime': 'cloudfront-js-1.0'
    },
    FunctionCode=b'bytes'
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name of the function that you are updating.

  • IfMatch (string) --

    [REQUIRED]

    The current version ( ETag value) of the function that you are updating, which you can get using DescribeFunction .

  • FunctionConfig (dict) --

    [REQUIRED]

    Configuration information about the function.

    • Comment (string) -- [REQUIRED]

      A comment to describe the function.

    • Runtime (string) -- [REQUIRED]

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

  • FunctionCode (bytes) --

    [REQUIRED]

    The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide .

Return type

dict

Returns

Response Syntax

{
    'FunctionSummary': {
        'Name': 'string',
        'Status': 'string',
        'FunctionConfig': {
            'Comment': 'string',
            'Runtime': 'cloudfront-js-1.0'
        },
        'FunctionMetadata': {
            'FunctionARN': 'string',
            'Stage': 'DEVELOPMENT'|'LIVE',
            'CreatedTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1)
        }
    },
    'ETag': 'string'
}

Response Structure

  • (dict) --

    • FunctionSummary (dict) --

      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 (dict) --

        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 (dict) --

        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 (datetime) --

          The date and time when the function was created.

        • LastModifiedTime (datetime) --

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

    • ETag (string) --

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

Exceptions

  • CloudFront.Client.exceptions.InvalidArgument
  • CloudFront.Client.exceptions.InvalidIfMatchVersion
  • CloudFront.Client.exceptions.NoSuchFunctionExists
  • CloudFront.Client.exceptions.PreconditionFailed
  • CloudFront.Client.exceptions.FunctionSizeLimitExceeded
  • CloudFront.Client.exceptions.UnsupportedOperation