DeleteServiceLinkedRole - AWS Identity and Access Management

DeleteServiceLinkedRole

Submits a service-linked role deletion request and returns a DeletionTaskId, which you can use to check the status of the deletion. Before you call this operation, confirm that the role has no active sessions and that any resources used by the role in the linked service are deleted. If you call this operation more than once for the same service-linked role and an earlier deletion task is not complete, then the DeletionTaskId of the earlier request is returned.

If you submit a deletion request for a service-linked role whose linked service is still accessing a resource, then the deletion task fails. If it fails, the GetServiceLinkedRoleDeletionStatus operation returns the reason for the failure, usually including the resources that must be deleted. To delete the service-linked role, you must first remove those resources from the linked service and then submit the deletion request again. Resources are specific to the service that is linked to the role. For more information about removing resources from a service, see the AWS documentation for your service.

For more information about service-linked roles, see Roles terms and concepts: AWS service-linked role in the IAM User Guide.

Request Parameters

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

RoleName

The name of the service-linked role to be deleted.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\w+=,.@-]+

Required: Yes

Response Elements

The following element is returned by the service.

DeletionTaskId

The deletion task identifier that you can use to check the status of the deletion. This identifier is returned in the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Errors

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

LimitExceeded

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

HTTP Status Code: 409

NoSuchEntity

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

HTTP Status Code: 404

ServiceFailure

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

HTTP Status Code: 500

Examples

Example

The following example shows how to submit the role named AWSServiceRoleForLexBots for deletion.

Sample Request

https://iam.amazonaws.com/?Action=DeleteServiceLinkedRole &RoleName=AWSServiceRoleForLexBots &Version=2010-05-08

Example

This example illustrates one usage of DeleteServiceLinkedRole.

Sample Response

<DeleteServiceLinkedRoleResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/"> <DeleteServiceLinkedRoleResult> <DeletionTaskId>task/aws-service-role/lex.amazonaws.com/AWSServiceRoleForLexBots/ec720f7a-c0ba-4838-be33-f72e1873dd52</DeletionTaskId> </DeleteServiceLinkedRoleResult> <ResponseMetadata> <RequestId>4aff7ebf-8297-11e7-898c-4904717fb079</RequestId> </ResponseMetadata> </DeleteServiceLinkedRoleResponse>

See Also

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