GetFunctionUrlConfigCommand
Returns details about a Lambda function URL.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { LambdaClient, GetFunctionUrlConfigCommand } from "@aws-sdk/client-lambda"; // ES Modules import
// const { LambdaClient, GetFunctionUrlConfigCommand } = require("@aws-sdk/client-lambda"); // CommonJS import
const client = new LambdaClient(config);
const input = { // GetFunctionUrlConfigRequest
FunctionName: "STRING_VALUE", // required
Qualifier: "STRING_VALUE",
};
const command = new GetFunctionUrlConfigCommand(input);
const response = await client.send(command);
// { // GetFunctionUrlConfigResponse
// FunctionUrl: "STRING_VALUE", // required
// FunctionArn: "STRING_VALUE", // required
// AuthType: "NONE" || "AWS_IAM", // required
// Cors: { // Cors
// AllowCredentials: true || false,
// AllowHeaders: [ // HeadersList
// "STRING_VALUE",
// ],
// AllowMethods: [ // AllowMethodsList
// "STRING_VALUE",
// ],
// AllowOrigins: [ // AllowOriginsList
// "STRING_VALUE",
// ],
// ExposeHeaders: [
// "STRING_VALUE",
// ],
// MaxAge: Number("int"),
// },
// CreationTime: "STRING_VALUE", // required
// LastModifiedTime: "STRING_VALUE", // required
// InvokeMode: "BUFFERED" || "RESPONSE_STREAM",
// };
GetFunctionUrlConfigCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
FunctionName Required | string | undefined | The name or ARN of the Lambda function. Name formats
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length. |
Qualifier | string | undefined | The alias name. |
GetFunctionUrlConfigCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
AuthType Required | FunctionUrlAuthType | undefined | The type of authentication that your function URL uses. Set to |
CreationTime Required | string | undefined | When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD). |
FunctionArn Required | string | undefined | The Amazon Resource Name (ARN) of your function. |
FunctionUrl Required | string | undefined | The HTTP URL endpoint for your function. |
LastModifiedTime Required | string | undefined | When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD). |
Cors | Cors | undefined | The cross-origin resource sharing (CORS) settings for your function URL. |
InvokeMode | InvokeMode | undefined | Use one of the following options:
|
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
InvalidParameterValueException | client | One of the parameters in the request is not valid. |
ResourceNotFoundException | client | The resource specified in the request does not exist. |
ServiceException | server | The Lambda service encountered an internal error. |
TooManyRequestsException | client | The request throughput limit was exceeded. For more information, see Lambda quotas . |
LambdaServiceException | Base exception class for all service exceptions from Lambda service. |