View a markdown version of this page

ListFunctions - AWS Elemental MediaTailor

ListFunctions

Retrieves all functions associated with your AWS account in the current Region. For more information about functions, see Working with functions in the MediaTailor User Guide.

Request Syntax

GET /functions?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of functions that you want MediaTailor to return in response to the current request. If there are more than MaxResults functions, use the value of NextToken in the response to get the next page of results.

The default value is 100. MediaTailor uses token-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

For the first ListFunctions request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Items": [ { "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" } } ], "NextToken": "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.

Items

A list of functions associated with your account in the current Region.

Type: Array of Function objects

NextToken

Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

For the first ListFunctions request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.

Type: String

Errors

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: