com.amazonaws.services.lambda.model

Class RemovePermissionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.lambda.model.RemovePermissionRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class RemovePermissionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the RemovePermission operation.

You can remove individual permissions from an resource policy associated with a Lambda function by providing a statement ID that you provided when you addded the permission. The API removes corresponding permission that is associated with the specific ARN identified by the Qualifier parameter.

Note that removal of a permission will cause an active event source to lose permission to the function.

You need permission for the lambda:RemovePermission action.

See Also:

AWSLambda.removePermission(RemovePermissionRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RemovePermissionRequest()

Method Summary

Methods

Modifier and Type	Method and Description
RemovePermissionRequest	clone()
boolean	equals(Object obj)
String	getFunctionName() Lambda function whose resource policy you want to remove a permission from.
String	getQualifier() You can specify this optional parameter to remove permission associated with a specific function version or function alias.
String	getStatementId() Statement ID of the permission to remove.
int	hashCode()
void	setFunctionName(String functionName) Lambda function whose resource policy you want to remove a permission from.
void	setQualifier(String qualifier) You can specify this optional parameter to remove permission associated with a specific function version or function alias.
void	setStatementId(String statementId) Statement ID of the permission to remove.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RemovePermissionRequest	withFunctionName(String functionName) Lambda function whose resource policy you want to remove a permission from.
RemovePermissionRequest	withQualifier(String qualifier) You can specify this optional parameter to remove permission associated with a specific function version or function alias.
RemovePermissionRequest	withStatementId(String statementId) Statement ID of the permission to remove.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RemovePermissionRequest

public RemovePermissionRequest()

Method Detail

getFunctionName

public String getFunctionName()

Lambda function whose resource policy you want to remove a permission from.

You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?

Returns:

Lambda function whose resource policy you want to remove a permission from.

You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

setFunctionName

public void setFunctionName(String functionName)

Lambda function whose resource policy you want to remove a permission from.

You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?

Parameters:

functionName - Lambda function whose resource policy you want to remove a permission from.

You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

withFunctionName

public RemovePermissionRequest withFunctionName(String functionName)

Lambda function whose resource policy you want to remove a permission from.

You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 140
Pattern: (arn:aws:lambda:)?([a-z]{2}-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))?

Parameters:

functionName - Lambda function whose resource policy you want to remove a permission from.

You can specify an unqualified function name (for example, "Thumbnail") or you can specify Amazon Resource Name (ARN) of the function (for example, "arn:aws:lambda:us-west-2:account-id:function:ThumbNail"). AWS Lambda also allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail"). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

Returns:

A reference to this updated object so that method calls can be chained together.

getStatementId

public String getStatementId()

Statement ID of the permission to remove.

Constraints:
Length: 1 - 100
Pattern: ([a-zA-Z0-9-_]+)

Returns:

Statement ID of the permission to remove.

setStatementId

public void setStatementId(String statementId)

Statement ID of the permission to remove.

Constraints:
Length: 1 - 100
Pattern: ([a-zA-Z0-9-_]+)

Parameters:

statementId - Statement ID of the permission to remove.

withStatementId

public RemovePermissionRequest withStatementId(String statementId)

Statement ID of the permission to remove.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100
Pattern: ([a-zA-Z0-9-_]+)

Parameters:

statementId - Statement ID of the permission to remove.

Returns:

A reference to this updated object so that method calls can be chained together.

getQualifier

public String getQualifier()

You can specify this optional parameter to remove permission associated with a specific function version or function alias. The value of this paramter is the function version or alias name. If you don't specify this parameter, the API removes permission associated with the unqualified function ARN.

Constraints:
Length: 1 - 128
Pattern: (|[a-zA-Z0-9$_]+)

Returns:

You can specify this optional parameter to remove permission associated with a specific function version or function alias. The value of this paramter is the function version or alias name. If you don't specify this parameter, the API removes permission associated with the unqualified function ARN.

setQualifier

public void setQualifier(String qualifier)

You can specify this optional parameter to remove permission associated with a specific function version or function alias. The value of this paramter is the function version or alias name. If you don't specify this parameter, the API removes permission associated with the unqualified function ARN.

Constraints:
Length: 1 - 128
Pattern: (|[a-zA-Z0-9$_]+)

Parameters:

qualifier - You can specify this optional parameter to remove permission associated with a specific function version or function alias. The value of this paramter is the function version or alias name. If you don't specify this parameter, the API removes permission associated with the unqualified function ARN.

withQualifier

public RemovePermissionRequest withQualifier(String qualifier)

You can specify this optional parameter to remove permission associated with a specific function version or function alias. The value of this paramter is the function version or alias name. If you don't specify this parameter, the API removes permission associated with the unqualified function ARN.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: (|[a-zA-Z0-9$_]+)

Parameters:

qualifier - You can specify this optional parameter to remove permission associated with a specific function version or function alias. The value of this paramter is the function version or alias name. If you don't specify this parameter, the API removes permission associated with the unqualified function ARN.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public RemovePermissionRequest clone()

Overrides:

clone in class AmazonWebServiceRequest