Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class RemoveRoleFromInstanceProfileCommandProtected

Removes the specified IAM role from the specified EC2 instance profile.

Make sure that you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance might break any applications running on the instance.

For more information about roles, see IAM roles in the IAM User Guide. For more information about instance profiles, see Using instance profiles in the IAM User Guide.

Example

Use a bare-bones client and the command you need to make an API call.

import { IAMClient, RemoveRoleFromInstanceProfileCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, RemoveRoleFromInstanceProfileCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // RemoveRoleFromInstanceProfileRequest
InstanceProfileName: "STRING_VALUE", // required
RoleName: "STRING_VALUE", // required
};
const command = new RemoveRoleFromInstanceProfileCommand(input);
const response = await client.send(command);
// {};

Param

RemoveRoleFromInstanceProfileCommandInput

Returns

RemoveRoleFromInstanceProfileCommandOutput

See

Throws

LimitExceededException (client fault)

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.

Throws

NoSuchEntityException (client fault)

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

Throws

ServiceFailureException (server fault)

The request processing has failed because of an unknown error, exception or failure.

Throws

UnmodifiableEntityException (client fault)

The request was rejected because service-linked roles are protected Amazon Web Services resources. Only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.

Throws

IAMServiceException

Base exception class for all service exceptions from IAM service.

Example

To remove a role from an instance profile

// The following command removes the role named Test-Role from the instance profile named ExampleInstanceProfile.
const input = {
"InstanceProfileName": "ExampleInstanceProfile",
"RoleName": "Test-Role"
};
const command = new RemoveRoleFromInstanceProfileCommand(input);
await client.send(command);
// example id: 6d9f46f1-9f4a-4873-b403-51a85c5c627c

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods