Skip to content

IAM  >  Operations  >  delete_service_linked_role

delete_service_linked_role

Operation

delete_service_linked_role async

delete_service_linked_role(input: DeleteServiceLinkedRoleInput, plugins: list[Plugin] | None = None) -> DeleteServiceLinkedRoleOutput

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 Amazon Web Services documentation for your service.

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

Parameters:

Name Type Description Default
input DeleteServiceLinkedRoleInput

An instance of DeleteServiceLinkedRoleInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DeleteServiceLinkedRoleOutput

An instance of DeleteServiceLinkedRoleOutput.

Input

DeleteServiceLinkedRoleInput dataclass

Bases: _SerdeShape

Dataclass for DeleteServiceLinkedRoleInput structure.

Attributes

role_name class-attribute instance-attribute
role_name: str | None = ...

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

Output

DeleteServiceLinkedRoleOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteServiceLinkedRoleOutput structure.

Attributes

deletion_task_id instance-attribute
deletion_task_id: str

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>.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.