WorkMail / Client / update_resource

update_resource#

WorkMail.Client.update_resource(**kwargs)#

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

Request Syntax

response = client.update_resource(
    OrganizationId='string',
    ResourceId='string',
    Name='string',
    BookingOptions={
        'AutoAcceptRequests': True|False,
        'AutoDeclineRecurringRequests': True|False,
        'AutoDeclineConflictingRequests': True|False
    },
    Description='string',
    Type='ROOM'|'EQUIPMENT',
    HiddenFromGlobalAddressList=True|False
)
Parameters:

  • OrganizationId (string) –

    [REQUIRED]

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

  • ResourceId (string) –

    [REQUIRED]

    The identifier of the resource to be updated.

    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

  • Name (string) – The name of the resource to be updated.

  • BookingOptions (dict) –

    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.

  • Description (string) – Updates the resource description.

  • Type (string) – Updates the resource type.

  • HiddenFromGlobalAddressList (boolean) – If enabled, the resource is hidden from the global address list.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • WorkMail.Client.exceptions.DirectoryUnavailableException

  • WorkMail.Client.exceptions.EntityNotFoundException

  • WorkMail.Client.exceptions.EntityStateException

  • WorkMail.Client.exceptions.InvalidConfigurationException

  • WorkMail.Client.exceptions.EmailAddressInUseException

  • WorkMail.Client.exceptions.MailDomainNotFoundException

  • WorkMail.Client.exceptions.MailDomainStateException

  • WorkMail.Client.exceptions.NameAvailabilityException

  • WorkMail.Client.exceptions.OrganizationNotFoundException

  • WorkMail.Client.exceptions.OrganizationStateException

  • WorkMail.Client.exceptions.UnsupportedOperationException

  • WorkMail.Client.exceptions.InvalidParameterException