[ 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 | --cli-input-yaml]
[--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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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.

Examples

To retrieve information for a resource

The following describe-resource command retrieves information about the specified resource.

aws workmail describe-resource \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --resource-id r-7afe0efbade843a58cdc10251fce992c

Output:

{
    "ResourceId": "r-7afe0efbade843a58cdc10251fce992c",
    "Name": "exampleRoom1",
    "Type": "ROOM",
    "BookingOptions": {
        "AutoAcceptRequests": true,
        "AutoDeclineRecurringRequests": false,
        "AutoDeclineConflictingRequests": true
    },
    "State": "ENABLED"
}

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), disabled (deregistered or never registered to WorkMail), or deleted.

EnabledDate -> (timestamp)

The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.

DisabledDate -> (timestamp)

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