Querying CloseAccount Requests in Specified State

Function

This API is used to query the CloseAccount requests in the specified state for an organization. This API can be called only from the organization's management account or a delegated administrator account.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

organizations:closeAccountStatuses:list

List

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
organizations:closeAccountStatuses:list	List	-	-	-	-

URI

GET /v1/organizations/close-account-status

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
states	No	Array of strings	Definition List of one or more states that you want to include in the response. If this parameter is not present, all items are included in the response. It can be pending_closure or suspended. Constraints N/A Range 0 to 2 states Enumerated values: pending_closure and suspended. Default Value No default value

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Definition Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. Constraints N/A Range The value contains 0 to 32,768 characters. Default Value No default value

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
close_account_statuses	Array of CloseAccountStatusDto objects	Definition List of objects with details about the requests. Constraints Mandatory Range N/A Default Value No default value

**Table 4** CloseAccountStatusDto
Parameter	Type	Description
account_id	String	Definition Unique ID of an account. Constraints Mandatory Range The value must comply with the regular expression ^[\w-]+$. The value contains a maximum of 64 characters. Default Value No default value
created_at	String	Definition Date and time when the CloseAccount request was made. Constraints Mandatory Range The value must be in ISO 8601 format. Default Value No default value
updated_at	String	Definition Date and time when the status of CloseAccount request was updated. Constraints Mandatory Range The value must be in ISO 8601 format. Default Value No default value
organization_id	String	Definition Unique ID of an organization. Constraints Mandatory Range The value must comply with the regular expression ^o-[0-9a-z]{10,32}$. The value contains a maximum of 34 characters. Default Value No default value
state	String	Definition Status of the CloseAccount request. It can be pending_closure or suspended. Constraints Mandatory Range The value contains 1 to 64 characters. Default Value No default value
failure_reason	String	Definition Reason for a request failure. Constraints N/A Range N/A Default Value No default value

Example Requests

Querying CloseAccount requests in the specified state

GET https://{endpoint}/v1/organizations/close-account-status

Example Responses

Status code: 200

Successful

{
  "close_account_statuses" : [ {
    "account_id" : "0a6d25d23900d45c0faac010e0fb4de0",
    "updated_at" : "2022-08-24T06:41:15Z",
    "created_at" : "2022-08-24T06:41:15Z",
    "organization_id" : "o-awjp43m7bz3b8jgy5v61jrfwakt3og8w",
    "state" : "pending_closure"
  } ]
}