update_domain

DatasetsApi.update_domain(name, role_id, domain_update_obj, action=None, content_type=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update a domain or manage its external schemas

Omit action to update the domain description or display name using the request body. Use action=create-external-schema or action=drop-external-schema to manage the domain’s Redshift external schemas. For these actions, request-body fields are ignored, but API Gateway still requires a JSON request body. Callers must send an empty object ({}) rather than omitting the body.

Parameters:

  • name (str) – (required)

  • role_id (str) – (required)

  • domain_update_obj (DomainUpdateObj) – (required)

  • action (str) – Optional external-schema operation. Omit to update domain metadata.

  • content_type (str)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

MessageStatus

Returns:

Returns the result object.

Request and Response Examples

HTTP: PUT /domains/{name}

Success (HTTP 200)

Successfully updated the domain

Errors

HTTP 400

Invalid input for updating domains

HTTP 500

Something went wrong at backend