Actions, resources, and condition keys for Amazon Transfer Family
Amazon Transfer Family (service prefix: transfer
) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.
References:
-
Learn how to configure this service.
-
View a list of the API operations available for this service.
-
Learn how to secure this service and its resources by using IAM permission policies.
Topics
Actions defined by Amazon Transfer Family
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 Amazon. 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 types column of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies 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. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource
element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.
The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition
element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.
Note
Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.
For details about the columns in the following table, see Actions table.
Actions | Description | Access level | Resource types (*required) | Condition keys | Dependent actions |
---|---|---|---|---|---|
CreateAccess | Grants permission to add an access associated with a server | Write |
iam:PassRole |
||
CreateAgreement | Grants permission to add an agreement associated with a server | Write |
iam:PassRole |
||
CreateConnector | Grants permission to create a connector | Write |
iam:PassRole |
||
CreateProfile | Grants permission to create a profile | Write | |||
CreateServer | Grants permission to create a server | Write |
iam:PassRole |
||
CreateUser | Grants permission to add a user associated with a server | Write |
iam:PassRole |
||
CreateWebApp | Grants permission to create a webapp | Write |
iam:PassRole |
||
CreateWorkflow | Grants permission to create a workflow | Write | |||
DeleteAccess | Grants permission to delete access | Write | |||
DeleteAgreement | Grants permission to delete agreement | Write | |||
DeleteCertificate | Grants permission to delete certificate | Write | |||
DeleteConnector | Grants permission to delete connector | Write | |||
DeleteHostKey | Grants permission to delete a host key associated with a server | Write | |||
DeleteProfile | Grants permission to delete profile | Write | |||
DeleteServer | Grants permission to delete a server | Write | |||
DeleteSshPublicKey | Grants permission to delete an SSH public key from a user | Write | |||
DeleteUser | Grants permission to delete a user associated with a server | Write | |||
DeleteWebApp | Grants permission to delete webapp | Write | |||
DeleteWebAppCustomization | Grants permission to delete webapp customization | Write | |||
DeleteWorkflow | Grants permission to delete a workflow | Write | |||
DescribeAccess | Grants permission to describe an access assigned to a server | Read | |||
DescribeAgreement | Grants permission to describe an agreement assigned to a server | Read | |||
DescribeCertificate | Grants permission to describe a certificate | Read | |||
DescribeConnector | Grants permission to describe a connector | Read | |||
DescribeExecution | Grants permission to describe an execution associated with a workflow | Read | |||
DescribeHostKey | Grants permission to describe a host key associated with a server | Read | |||
DescribeProfile | Grants permission to describe a profile | Read | |||
DescribeSecurityPolicy | Grants permission to describe a security policy | Read | |||
DescribeServer | Grants permission to describe a server | Read | |||
DescribeUser | Grants permission to describe a user associated with a server | Read | |||
DescribeWebApp | Grants permission to describe a webapp | Read | |||
DescribeWebAppCustomization | Grants permission to describe a webapp customization | Read | |||
DescribeWorkflow | Grants permission to describe a workflow | Read | |||
ImportCertificate | Grants permission to add a certificate | Write | |||
ImportHostKey | Grants permission to add a host key to a server | Write | |||
ImportSshPublicKey | Grants permission to add an SSH public key to a user | Write | |||
ListAccesses | Grants permission to list accesses | Read | |||
ListAgreements | Grants permission to list agreements | Read | |||
ListCertificates | Grants permission to list certificates | Read | |||
ListConnectors | Grants permission to list connectors | Read | |||
ListExecutions | Grants permission to list executions associated with a workflow | Read | |||
ListFileTransferResults | Grants permission to list file transfer statuses for connectors | Read | |||
ListHostKeys | Grants permission to list host keys associated with a server | Read | |||
ListProfiles | Grants permission to list profiles | Read | |||
ListSecurityPolicies | Grants permission to list security policies | List | |||
ListServers | Grants permission to list servers | List | |||
ListTagsForResource | Grants permission to list tags for an Amazon Transfer Family resource | Read | |||
ListUsers | Grants permission to list users associated with a server | List | |||
ListWebApps | Grants permission to list webapps | List | |||
ListWorkflows | Grants permission to list workflows | List | |||
SendWorkflowStepState | Grants permission to send a callback for asynchronous custom steps | Write | |||
StartDirectoryListing | Grants permission to initiate a list operation on a remote server using a connector | Write | |||
StartFileTransfer | Grants permission to initiate a connector file transfer | Write | |||
StartServer | Grants permission to start a server | Write | |||
StopServer | Grants permission to stop a server | Write | |||
TagResource | Grants permission to tag an Amazon Transfer Family resource | Tagging | |||
TestConnection | Grants permission to test a connector's connection to remote server | Write | |||
TestIdentityProvider | Grants permission to test a server's custom identity provider | Read | |||
UntagResource | Grants permission to untag an Amazon Transfer Family resource | Tagging | |||
UpdateAccess | Grants permission to update access | Write |
iam:PassRole |
||
UpdateAgreement | Grants permission to update an agreement | Write |
iam:PassRole |
||
UpdateCertificate | Grants permission to update a certificate | Write | |||
UpdateConnector | Grants permission to update a connector | Write |
iam:PassRole |
||
UpdateHostKey | Grants permission to update a host key | Write | |||
UpdateProfile | Grants permission to update a profile | Write | |||
UpdateServer | Grants permission to update the configuration of a server | Write |
iam:PassRole |
||
UpdateUser | Grants permission to update the configuration of a user | Write |
iam:PassRole |
||
UpdateWebApp | Grants permission to update the configuration of a webapp | Write |
iam:PassRole |
||
UpdateWebAppCustomization | Grants permission to update the configuration of a webapp cutomization | Write |
iam:PassRole |
Resource types defined by Amazon Transfer Family
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 Resource types table. For details about the columns in the following table, see 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}
|
|
workflow |
arn:${Partition}:transfer:${Region}:${Account}:workflow/${WorkflowId}
|
|
certificate |
arn:${Partition}:transfer:${Region}:${Account}:certificate/${CertificateId}
|
|
connector |
arn:${Partition}:transfer:${Region}:${Account}:connector/${ConnectorId}
|
|
profile |
arn:${Partition}:transfer:${Region}:${Account}:profile/${ProfileId}
|
|
agreement |
arn:${Partition}:transfer:${Region}:${Account}:agreement/${ServerId}/${AgreementId}
|
|
host-key |
arn:${Partition}:transfer:${Region}:${Account}:host-key/${ServerId}/${HostKeyId}
|
|
webapp |
arn:${Partition}:transfer:${Region}:${Account}:webapp/${WebAppId}
|
Condition keys for Amazon Transfer Family
Amazon Transfer Family 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 Condition keys table.
To view the global condition keys that are available to all services, see Available global condition keys.
Condition keys | Description | Type |
---|---|---|
aws:RequestTag/${TagKey} | Filters access by the tags that are passed in the request | String |
aws:ResourceTag/${TagKey} | Filters access by the tags associated with the resource | String |
aws:TagKeys | Filters access by the tag keys that are passed in the request | ArrayOfString |