DescribeResource
Returns the data available for the resource.
Request Syntax
{
"OrganizationId": "string",
"ResourceId": "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.
- OrganizationId
-
The identifier associated with the organization for which the resource is described.
Type: String
Length Constraints: Fixed length of 34.
Pattern:
^m-[0-9a-f]{32}$Required: Yes
- ResourceId
-
The identifier of the resource to be described.
The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:
-
Resource ID: r-0123456789a0123456789b0123456789
-
Email address: resource@domain.tld
-
Resource name: resource
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9._%+@-]+Required: Yes
-
Response Syntax
{
"BookingOptions": {
"AutoAcceptRequests": boolean,
"AutoDeclineConflictingRequests": boolean,
"AutoDeclineRecurringRequests": boolean
},
"Description": "string",
"DisabledDate": number,
"Email": "string",
"EnabledDate": number,
"HiddenFromGlobalAddressList": boolean,
"Name": "string",
"ResourceId": "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.
- BookingOptions
-
The booking options for the described resource.
Type: BookingOptions object
- Description
-
Description of the resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
- DisabledDate
-
The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.
Type: Timestamp
-
The email of the described resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 254.
Pattern:
[a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\.[a-zA-Z-]{2,} - EnabledDate
-
The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.
Type: Timestamp
- HiddenFromGlobalAddressList
-
If enabled, the resource is hidden from the global address list.
Type: Boolean
- Name
-
The name of the described resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern:
[\w\-.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z0-9-]{2,})? - ResourceId
-
The identifier of the described resource.
Type: String
Length Constraints: Fixed length of 34.
Pattern:
^r-[0-9a-f]{32}$ - State
-
The state of the resource: enabled (registered to WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.
Type: String
Valid Values:
ENABLED | DISABLED | DELETED - Type
-
The type of the described resource.
Type: String
Valid Values:
ROOM | EQUIPMENT
Errors
For information about the errors that are common to all actions, see Common Errors.
- EntityNotFoundException
-
The identifier supplied for the user, group, or resource does not exist in your organization.
HTTP Status Code: 400
- 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:
