ListResources
Returns summaries of the organization's resources.
Request Syntax
{
"Filters": {
"NamePrefix": "string",
"PrimaryEmailPrefix": "string",
"State": "string"
},
"MaxResults": number,
"NextToken": "string",
"OrganizationId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Filters
-
Limit the resource search results based on the filter criteria. You can only use one filter per request.
Type: ListResourcesFilters object
Required: No
- MaxResults
-
The maximum number of results to return in a single call.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
The token to use to retrieve the next page of results. The first call does not contain any tokens.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\S\s]*|[a-zA-Z0-9/+=]{1,1024}Required: No
- OrganizationId
-
The identifier for the organization under which the resources exist.
Type: String
Length Constraints: Fixed length of 34.
Pattern:
^m-[0-9a-f]{32}$Required: Yes
Response Syntax
{
"NextToken": "string",
"Resources": [
{
"Description": "string",
"DisabledDate": number,
"Email": "string",
"EnabledDate": number,
"Id": "string",
"Name": "string",
"State": "string",
"Type": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- NextToken
-
The token used to paginate through all the organization's resources. While results are still available, it has an associated value. When the last page is reached, the token is empty.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\S\s]*|[a-zA-Z0-9/+=]{1,1024} - Resources
-
One page of the organization's resource representation.
Type: Array of Resource objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterException
-
One or more of the input parameters don't match the service's restrictions.
HTTP Status Code: 400
- OrganizationNotFoundException
-
An operation received a valid organization identifier that either doesn't belong or exist in the system.
HTTP Status Code: 400
- OrganizationStateException
-
The organization must have a valid state to perform certain operations on the organization or its members.
HTTP Status Code: 400
- UnsupportedOperationException
-
You can't perform a write operation against a read-only directory.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
