Help Center/ IAM Identity Center/ API Reference/ API/ Account Assignment Management/ Listing Account Assignment Deletion Statuses
Updated on 2024-04-10 GMT+08:00

Listing Account Assignment Deletion Statuses

Function

This API is used to list the account assignment deletion statuses of a specified IAM Identity Center instance.

URI

GET /v1/instances/{instance_id}/account-assignments/deletion-statuses

Table 1 Path parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Globally unique ID of an IAM Identity Center instance

Table 2 Query parameters

Parameter

Mandatory

Type

Description

status

No

String

Status of the listing account assignment deletion process

Enumerated value:

  • IN_PROGRESS
  • SUCCEEDED
  • FAILED

limit

No

Integer

Maximum number of results returned for each request

Minimum value: 1

Maximum value: 100

Default value: 100

marker

No

String

Pagination marker

Minimum length: 24

Maximum length: 24

Request Parameters

Table 3 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Maximum length: 2048

Response Parameters

Status code: 200

Table 4 Parameters in the response body

Parameter

Type

Description

account_assignments_deletion_status

Array of objects

Operation status list

page_info

Object

Pagination information

Table 5 account_assignments_deletion_status

Parameter

Type

Description

created_date

Long

Creation date

request_id

String

Unique ID of a request

status

String

Authorization status of a permission set

Enumerated value:

  • IN_PROGRESS
  • FAILED
  • SUCCEEDED
Table 6 page_info

Parameter

Type

Description

next_marker

String

If present, it indicates that the available output is more than the output contained in the current response. Use this value in the marker request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this operation until the next_marker response returns null.

current_count

Integer

Number of records returned on this page

Status code: 400

Table 7 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

request_id

String

Unique ID of a request

Status code: 403

Table 8 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

request_id

String

Unique ID of a request

Example Request

Listing the account assignment deletion statuses of a specified IAM Identity Center instance

GET https://{hostname}/v1/instances/{instance_id}/account-assignments/deletion-statuses

Example Response

Status code: 200

Successful

{
  "account_assignments_deletion_status" : [ {
    "created_date" : 1677175760379,
    "request_id" : "9238e6aaaaaaaaaaaaaaaaaaaa4cad92",
    "status" : "IN_PROGRESS"
  } ],
  "page_info" : {
    "next_marker" : null,
    "current_count" : 1
  }
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.