GetPolicyRequest Class | AWS SDK for .NET V3

Container for the parameters to the GetPolicy operation. Returns the resource-based IAM policy for a function, version, or alias.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Lambda.AmazonLambdaRequest
      Amazon.Lambda.Model.GetPolicyRequest

Namespace: Amazon.Lambda.Model
Assembly: AWSSDK.Lambda.dll
Version: 3.x.y.z

Syntax

public class GetPolicyRequest : AmazonLambdaRequest
         IAmazonWebServiceRequest

The GetPolicyRequest type exposes the following members

Constructors

	Name	Description
	GetPolicyRequest()

Properties

Name Type Description

	Name	Type	Description
	FunctionName	System.String	Gets and sets the property FunctionName. 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	System.String	Gets and sets the property Qualifier. Specify a version or alias to get the policy for that resource.

FunctionName

System.String

Gets and sets the property FunctionName.

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

System.String

Gets and sets the property Qualifier.

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

Examples

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

To retrieve a Lambda function policy


var response = client.GetPolicy(new GetPolicyRequest 
{
    FunctionName = "my-function",
    Qualifier = "1"
});

string policy = response.Policy;
string revisionId = response.RevisionId;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5