Returns details about a Lambda Event Function alias.
Parameters:
-
function_name
(FunctionName)
–
The name or ARN of the Lambda function.
Name formats
-
Function name - MyFunction.
-
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
-
Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
-
name
(Alias)
–
Raises:
Examples:
To get a Lambda function alias
The following example returns details about an alias named BLUE for a function named my-function
>>> client.get_alias(function_name='my-function', name='BLUE')
Source code in docs_src/capo_lambda/_services/_lambda.py
| def get_alias(
self,
function_name: "capo_lambda.types.function_name.FunctionName",
name: "capo_lambda.types.alias.Alias",
*,
config_overrides: Optional[LambdaClientConfig] = None,
) -> "capo_lambda.types.alias_configuration.AliasConfiguration":
"""<p>Returns details about a Lambda Event Function <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html">alias</a>.</p>
Args:
function_name: <p>The name or ARN of the Lambda function.</p> <p class="title"> <b>Name formats</b> </p> <ul> <li> <p> <b>Function name</b> - <code>MyFunction</code>.</p> </li> <li> <p> <b>Function ARN</b> - <code>arn:aws:lambda:us-west-2:123456789012:function:MyFunction</code>.</p> </li> <li> <p> <b>Partial ARN</b> - <code>123456789012:function:MyFunction</code>.</p> </li> </ul> <p>The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.</p>
name: <p>The name of the alias.</p>
Raises:
capo_lambda.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One of the parameters in the request is not valid.</p>
capo_lambda.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource specified in the request does not exist.</p>
capo_lambda.errors.service_exception.ServiceException: <p>The Lambda service encountered an internal error.</p>
capo_lambda.errors.too_many_requests_exception.TooManyRequestsException: <p>The request throughput limit was exceeded. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html#api-requests">Lambda quotas</a>.</p>
capo_lambda.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
To get a Lambda function alias
The following example returns details about an alias named BLUE for a function named my-function
>>> client.get_alias(function_name='my-function', name='BLUE')
"""
def _handler(
req: "OperationRequest[capo_lambda.types.get_alias_request.GetAliasRequest]",
) -> OperationResponse[
"capo_lambda.types.alias_configuration.AliasConfiguration"
]:
import capo_lambda._operations.aws_gir_api_service.get_alias
output, http_response = (
capo_lambda._operations.aws_gir_api_service.get_alias.get_alias(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetAlias")
)
input_: capo_lambda.types.get_alias_request.GetAliasRequest = {
"function_name": function_name,
"name": name,
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|