Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . workmail ]

describe-resource

Description

Returns the data available for the resource.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-resource
--organization-id <value>
--resource-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--organization-id (string)

The identifier associated with the organization for which the resource is described.

--resource-id (string)

The identifier of the resource to be described.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

ResourceId -> (string)

The identifier of the described resource.

Email -> (string)

The email of the described resource.

Name -> (string)

The name of the described resource.

Type -> (string)

The type of the described resource.

BookingOptions -> (structure)

The booking options for the described resource.

AutoAcceptRequests -> (boolean)

The resource's ability to automatically reply to requests. If disabled, delegates must be associated to the resource.

AutoDeclineRecurringRequests -> (boolean)

The resource's ability to automatically decline any recurring requests.

AutoDeclineConflictingRequests -> (boolean)

The resource's ability to automatically decline any conflicting requests.

State -> (string)

The state of the resource: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to Amazon WorkMail).

EnabledDate -> (timestamp)

The date and time when a resource was registered to Amazon WorkMail, in UNIX epoch time format.

DisabledDate -> (timestamp)

The date and time when a resource was registered from Amazon WorkMail, in UNIX epoch time format.