Actions, resources, and condition keys for AWS Server Migration Service
AWS Server Migration Service (service prefix: sms
) 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 AWS Server Migration Service
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 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 |
---|---|---|---|---|---|
CreateApp | Grants permission to create an application configuration to migrate on-premise application onto AWS | Write | |||
CreateReplicationJob | Grants permission to create a job to migrate on-premise server onto AWS | Write | |||
DeleteApp | Grants permission to delete an existing application configuration | Write | |||
DeleteAppLaunchConfiguration | Grants permission to delete launch configuration for an existing application | Write | |||
DeleteAppReplicationConfiguration | Grants permission to delete replication configuration for an existing application | Write | |||
DeleteAppValidationConfiguration | Grants permission to delete validation configuration for an existing application | Write | |||
DeleteReplicationJob | Grants permission to delete an existing job to migrate on-premise server onto AWS | Write | |||
DeleteServerCatalog | Grants permission to delete the complete list of on-premise servers gathered into AWS | Write | |||
DisassociateConnector | Grants permission to disassociate a connector that has been associated | Write | |||
GenerateChangeSet | Grants permission to generate a changeSet for the CloudFormation stack of an application | Write | |||
GenerateTemplate | Grants permission to generate a CloudFormation template for an existing application | Write | |||
GetApp | Grants permission to get the configuration and statuses for an existing application | Read | |||
GetAppLaunchConfiguration | Grants permission to get launch configuration for an existing application | Read | |||
GetAppReplicationConfiguration | Grants permission to get replication configuration for an existing application | Read | |||
GetAppValidationConfiguration | Grants permission to get validation configuration for an existing application | Read | |||
GetAppValidationOutput | Grants permission to get notification sent from application validation script. | Read | |||
GetConnectors | Grants permission to get all connectors that have been associated | Read | |||
GetMessages [permission only] | Grants permission to gets messages from AWS Server Migration Service to Server Migration Connector | Read | |||
GetReplicationJobs | Grants permission to get all existing jobs to migrate on-premise servers onto AWS | Read | |||
GetReplicationRuns | Grants permission to get all runs for an existing job | Read | |||
GetServers | Grants permission to get all servers that have been imported | Read | |||
ImportAppCatalog | Grants permission to import application catalog from AWS Application Discovery Service | Write | |||
ImportServerCatalog | Grants permission to gather a complete list of on-premise servers | Write | |||
LaunchApp | Grants permission to create and launch a CloudFormation stack for an existing application | Write | |||
ListApps | Grants permission to get a list of summaries for existing applications | List | |||
NotifyAppValidationOutput | Grants permission to send notification for application validation script | Write | |||
PutAppLaunchConfiguration | Grants permission to create or update launch configuration for an existing application | Write | |||
PutAppReplicationConfiguration | Grants permission to create or update replication configuration for an existing application | Write | |||
PutAppValidationConfiguration | Grants permission to put validation configuration for an existing application | Write | |||
SendMessage [permission only] | Grants permission to send message from Server Migration Connector to AWS Server Migration Service | Write | |||
StartAppReplication | Grants permission to create and start replication jobs for an existing application | Write | |||
StartOnDemandAppReplication | Grants permission to start a replication run for an existing application | Write | |||
StartOnDemandReplicationRun | Grants permission to start a replication run for an existing replication job | Write | |||
StopAppReplication | Grants permission to stop and delete replication jobs for an existing application | Write | |||
TerminateApp | Grants permission to terminate the CloudFormation stack for an existing application | Write | |||
UpdateApp | Grants permission to update an existing application configuration | Write | |||
UpdateReplicationJob | Grants permission to update an existing job to migrate on-premise server onto AWS | Write |
Resource types defined by AWS Server Migration Service
AWS Server Migration Service does not support specifying a resource ARN in the Resource
element of an IAM policy statement. To allow access to AWS Server Migration Service, specify "Resource": "*"
in your policy.
Condition keys for AWS Server Migration Service
ServerMigrationService has no service-specific context keys that can be used in the Condition
element of policy statements. For the list of the global context keys that are available to all services, see Available keys for conditions.