delete_service_linked_role¶
Operation¶
delete_service_linked_role
¶
delete_service_linked_role(request: DeleteServiceLinkedRoleInput | DeleteServiceLinkedRoleInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteServiceLinkedRoleInputDict]) -> 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 |
|---|---|---|---|
request
|
DeleteServiceLinkedRoleInput | DeleteServiceLinkedRoleInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DeleteServiceLinkedRoleInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteServiceLinkedRoleOutput
|
An instance of |
delete_service_linked_role
async
¶
delete_service_linked_role(request: DeleteServiceLinkedRoleInput | DeleteServiceLinkedRoleInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteServiceLinkedRoleInputDict]) -> 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 |
|---|---|---|---|
request
|
DeleteServiceLinkedRoleInput | DeleteServiceLinkedRoleInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DeleteServiceLinkedRoleInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteServiceLinkedRoleOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
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
¶
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.