IAM / Client / get_service_linked_role_deletion_status

get_service_linked_role_deletion_status#

IAM.Client.get_service_linked_role_deletion_status(**kwargs)#

Retrieves the status of your service-linked role deletion. After you use DeleteServiceLinkedRole to submit a service-linked role for deletion, you can use the DeletionTaskId parameter in GetServiceLinkedRoleDeletionStatus to check the status of the deletion. If the deletion fails, this operation returns the reason that it failed, if that information is returned by the service.

See also: AWS API Documentation

Request Syntax

response = client.get_service_linked_role_deletion_status(
    DeletionTaskId='string'
)
Parameters:

DeletionTaskId (string) –

[REQUIRED]

The deletion task identifier. This identifier is returned by the DeleteServiceLinkedRole operation in the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.

Return type:

dict

Returns:

Response Syntax

{
    'Status': 'SUCCEEDED'|'IN_PROGRESS'|'FAILED'|'NOT_STARTED',
    'Reason': {
        'Reason': 'string',
        'RoleUsageList': [
            {
                'Region': 'string',
                'Resources': [
                    'string',
                ]
            },
        ]
    }
}

Response Structure

  • (dict) –

    • Status (string) –

      The status of the deletion.

    • Reason (dict) –

      An object that contains details about the reason the deletion failed.

      • Reason (string) –

        A short description of the reason that the service-linked role deletion failed.

      • RoleUsageList (list) –

        A list of objects that contains details about the service-linked role deletion failure, if that information is returned by the service. If the service-linked role has active sessions or if any resources that were used by the role have not been deleted from the linked service, the role can’t be deleted. This parameter includes a list of the resources that are associated with the role and the Region in which the resources are being used.

        • (dict) –

          An object that contains details about how a service-linked role is used, if that information is returned by the service.

          This data type is used as a response element in the GetServiceLinkedRoleDeletionStatus operation.

          • Region (string) –

            The name of the Region where the service-linked role is being used.

          • Resources (list) –

            The name of the resource that is using the service-linked role.

            • (string) –

              The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.

              For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Exceptions