Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetFunction

Retrieves the configuration and metadata for a function. For more information about functions, see Working with functions in the MediaTailor User Guide.

Request Syntax


GET /function/FunctionId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

FunctionId

The identifier of the function.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CustomOutputConfiguration": { 
      "Output": { 
         "string" : "string" 
      },
      "Runtime": "string"
   },
   "Description": "string",
   "FunctionId": "string",
   "FunctionType": "string",
   "HttpRequestConfiguration": { 
      "Body": "string",
      "Headers": { 
         "string" : "string" 
      },
      "MethodType": "string",
      "Output": { 
         "string" : "string" 
      },
      "RequestTimeoutMilliseconds": number,
      "Runtime": "string",
      "Url": "string"
   },
   "SequentialExecutorConfiguration": { 
      "FunctionList": [ 
         { 
            "FunctionId": "string",
            "RunCondition": "string"
         }
      ],
      "Output": { 
         "string" : "string" 
      },
      "Runtime": "string",
      "TimeoutMilliseconds": number
   },
   "tags": { 
      "string" : "string" 
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Arn

The Amazon Resource Name (ARN) of the function.

Type: String

CustomOutputConfiguration

The configuration for a CUSTOM_OUTPUT function.

Type: CustomOutputConfiguration object

Description

A description of the function.

Type: String

FunctionId

The identifier of the function.

Type: String

FunctionType

The type of the function.

Type: String

Valid Values: HTTP_REQUEST | CUSTOM_OUTPUT | SEQUENTIAL_EXECUTOR

HttpRequestConfiguration

The configuration for an HTTP_REQUEST function.

Type: HttpRequestConfiguration object

SequentialExecutorConfiguration

The configuration for a SEQUENTIAL_EXECUTOR function.

Type: SequentialExecutorConfiguration object

tags

The tags assigned to the function. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

Type: String to string map

Errors

For information about the errors that are common to all actions, see Common Error Types.