Menu
AWS Systems Manager
API Reference (API Version 2014-11-06)

UpdateManagedInstanceRole

Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.

Request Syntax

{
   "IamRole": "string",
   "InstanceId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

IamRole

The IAM role you want to assign or change.

Type: String

Length Constraints: Maximum length of 64.

Required: Yes

InstanceId

The ID of the managed instance where you want to update the role.

Type: String

Pattern: ^mi-[0-9a-f]{17}$

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An error occurred on the server side.

HTTP Status Code: 400

InvalidInstanceId

The following problems can cause this exception:

You do not have permission to access the instance.

The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.

The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: