[ aws . workmail ]



Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another DescribeResource call.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--organization-id <value>
--resource-id <value>
[--name <value>]
[--booking-options <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]


--organization-id (string)

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

--resource-id (string)

The identifier of the resource to be updated.

--name (string)

The name of the resource to be updated.

--booking-options (structure)

The resource’s booking options to be updated.

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.

Shorthand Syntax:


JSON Syntax:

  "AutoAcceptRequests": true|false,
  "AutoDeclineRecurringRequests": true|false,
  "AutoDeclineConflictingRequests": true|false

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.


To update a resource

The following update-resource command updates the name of the specified resource.

aws workmail update-resource \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --resource-id r-7afe0efbade843a58cdc10251fce992c \
    --name exampleRoom2

This command produces no output.