get_policy `async` ¶

get_policy(
    function_name: NamespacedFunctionName,
    *,
    config_overrides: Optional[AsyncLambdaClientConfig] = None,
    qualifier: Optional[NumericLatestPublishedOrAliasQualifier] = None,
) -> GetPolicyResponse

Returns the resource-based IAM policy for a function, version, or alias.

Parameters:

function_name (NamespacedFunctionName) –
The name or ARN of the Lambda function, version, or alias.

Name formats
- Function name – my-function (name-only), my-function:v1 (with alias).
- Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
- Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the 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 (Optional[NumericLatestPublishedOrAliasQualifier], default: None ) –

Specify a version or alias to get the policy for that resource.

Raises:

InvalidParameterValueException –

One of the parameters in the request is not valid.
ResourceNotFoundException –

The resource specified in the request does not exist.
ServiceException –

The Lambda service encountered an internal error.
TooManyRequestsException –

The request throughput limit was exceeded. For more information, see Lambda quotas.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To retrieve a Lambda function policy The following example returns the resource-based policy for version 1 of a Lambda function named my-function.

>>> await client.get_policy(function_name='my-function', qualifier='1')

Source code in docs_src/capo_lambda/_services/async__lambda.py

async def get_policy(
    self,
    function_name: "capo_lambda.types.namespaced_function_name.NamespacedFunctionName",
    *,
    config_overrides: Optional[AsyncLambdaClientConfig] = None,
    qualifier: Optional[
        "capo_lambda.types.numeric_latest_published_or_alias_qualifier.NumericLatestPublishedOrAliasQualifier"
    ] = None,
) -> "capo_lambda.types.get_policy_response.GetPolicyResponse":
    """<p>Returns the <a href="https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html">resource-based IAM policy</a> for a function, version, or alias.</p>

    Args:
        function_name: <p>The name or ARN of the Lambda function, version, or alias.</p> <p class="title"> <b>Name formats</b> </p> <ul> <li> <p> <b>Function name</b> – <code>my-function</code> (name-only), <code>my-function:v1</code> (with alias).</p> </li> <li> <p> <b>Function ARN</b> – <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>.</p> </li> <li> <p> <b>Partial ARN</b> – <code>123456789012:function:my-function</code>.</p> </li> </ul> <p>You can append a version number or alias to any of the 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.</p>
        qualifier: <p>Specify a version or alias to get the policy for that resource.</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 retrieve a Lambda function policy
        The following example returns the resource-based policy for version 1 of a Lambda function named my-function.

        >>> await client.get_policy(function_name='my-function', qualifier='1')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_lambda.types.get_policy_request.GetPolicyRequest]",
    ) -> AsyncOperationResponse[
        "capo_lambda.types.get_policy_response.GetPolicyResponse"
    ]:
        import capo_lambda._operations.aws_gir_api_service.get_policy

        (
            output,
            http_response,
        ) = await capo_lambda._operations.aws_gir_api_service.get_policy.async_get_policy(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetPolicy")
    )
    input_: capo_lambda.types.get_policy_request.GetPolicyRequest = {
        "function_name": function_name
    }
    if qualifier is not None:
        input_["qualifier"] = qualifier

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_policy async ¶

get_policy `async` ¶