AWS Identity and Access Management
User Guide

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Actions, Resources, and Condition Keys for AWS Transfer for SFTP

AWS Transfer for SFTP (service prefix: transfer) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.

References:

Actions Defined by AWS Transfer for SFTP

You can specify the following actions in the Action element of an IAM policy statement. Use policies to grant permissions to perform an operation in AWS. When you use an action in a policy, you usually allow or deny access to the API operation or CLI command with the same name. However, in some cases, a single action controls access to more than one operation. Alternatively, some operations require several different actions.

The Resource column indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") in the Resource element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. Required resources are indicated in the table with an asterisk (*). If you specify a resource-level permission ARN in a statement using this action, then it must be of this type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one but not the other.

For details about the columns in the following table, see The Actions Table.

Actions Description Access Level Resource Types (*required) Condition Keys Dependent Actions
CreateServer Enables the caller to create a server. Write

aws:TagKeys

aws:RequestTag/${TagKey}

CreateUser Enables the caller to add a user associated with a server. Write

server*

iam:PassRole

aws:TagKeys

aws:RequestTag/${TagKey}

DeleteServer Enables the caller to delete a server. Write

server*

DeleteSshPublicKey Enables the caller to delete an SSH public key from a user. Write

user*

DeleteUser Enables the caller to delete a user associated with a server. Write

user*

DescribeServer Enables the caller to describe a server. Read

server*

DescribeUser Enables the caller to describe a user associated with a server. Read

user*

ImportSshPublicKey Enables the caller to add an SSH public key to a user. Write

user*

ListServers Enables the caller to list servers List
ListTagsForResource Enables the caller to list tags for a server or a user. Read

server

user

ListUsers Enables the caller to list users associated with a server. List

user*

StartServer Enables the caller to start a server. Write

server*

StopServer Enables the caller to stop a server. Write

server*

TagResource Enables the caller to tag a server or a user. Tagging

server

user

aws:TagKeys

aws:RequestTag/${TagKey}

TestIdentityProvider Enables the caller to test a server's custom identity provider. Read

server*

UntagResource Enables the caller to untag a server or a user. Tagging

server

user

aws:TagKeys

aws:RequestTag/${TagKey}

UpdateServer Enables the caller to update the configuration of a server Write

server*

UpdateUser Enables the caller to update the configuration of a user Write

server*

user*

Resources Defined by AWS Transfer for SFTP

The following resource types are defined by this service and can be used in the Resource element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the table. For details about the columns in the following table, see The Resource Types Table.

Resource Types ARN Condition Keys
user arn:${Partition}:transfer:${region}:${account}:user/${serverId}/${username}
server arn:${Partition}:transfer:${region}:${account}:server/${serverId}

Condition Keys for AWS Transfer for SFTP

AWS Transfer for SFTP defines the following condition keys that can be used in the Condition element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see The Condition Keys Table.

To view the global condition keys that are available to all services, see Available Global Condition Keys in the IAM Policy Reference.

Condition Keys Description Type
aws:RequestTag/${TagKey} A key that is present in the request the user makes. String
aws:TagKeys The list of all the tag key names associated with the resource in the request. String