get_policy¶
Operation¶
get_policy
¶
get_policy(request: GetPolicyInput | GetPolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPolicyInputDict]) -> GetPolicyOutput
Returns the resource-based IAM policy for a function, version, or alias.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetPolicyInput | GetPolicyInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[GetPolicyInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetPolicyOutput
|
An instance of |
get_policy
async
¶
get_policy(request: GetPolicyInput | GetPolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPolicyInputDict]) -> GetPolicyOutput
Returns the resource-based IAM policy for a function, version, or alias.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetPolicyInput | GetPolicyInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[GetPolicyInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetPolicyOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetPolicyInputDict
¶
Bases: TypedDict
Dictionary form of GetPolicyInput.
Attributes¶
function_name
instance-attribute
¶
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.
GetPolicyInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetPolicyInput structure.
Attributes¶
function_name
class-attribute
instance-attribute
¶
function_name: str | None = ...
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.
Output¶
GetPolicyOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetPolicyOutput structure.