Seleccione sus preferencias de cookies

Usamos cookies esenciales y herramientas similares que son necesarias para proporcionar nuestro sitio y nuestros servicios. Usamos cookies de rendimiento para recopilar estadísticas anónimas para que podamos entender cómo los clientes usan nuestro sitio y hacer mejoras. Las cookies esenciales no se pueden desactivar, pero puede hacer clic en “Personalizar” o “Rechazar” para rechazar las cookies de rendimiento.

Si está de acuerdo, AWS y los terceros aprobados también utilizarán cookies para proporcionar características útiles del sitio, recordar sus preferencias y mostrar contenido relevante, incluida publicidad relevante. Para aceptar o rechazar todas las cookies no esenciales, haga clic en “Aceptar” o “Rechazar”. Para elegir opciones más detalladas, haga clic en “Personalizar”.

UpdateRule - Amazon DataZone
Esta página no se ha traducido a su idioma. Solicitar traducción

UpdateRule

Updates a rule. In Amazon DataZone, a rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.

Request Syntax

PATCH /v2/domains/domainIdentifier/rules/identifier HTTP/1.1 Content-type: application/json { "description": "string", "detail": { ... }, "includeChildDomainUnits": boolean, "name": "string", "scope": { "assetType": { "selectionMode": "string", "specificAssetTypes": [ "string" ] }, "dataProduct": boolean, "project": { "selectionMode": "string", "specificProjects": [ "string" ] } } }

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The ID of the domain in which a rule is to be updated.

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Required: Yes

identifier

The ID of the rule that is to be updated

Pattern: ^[a-zA-Z0-9_-]{1,36}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

description

The description of the rule.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Required: No

detail

The detail of the rule.

Type: RuleDetail object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

includeChildDomainUnits

Specifies whether to update this rule in the child domain units.

Type: Boolean

Required: No

name

The name of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[\w -]+$

Required: No

scope

The scrope of the rule.

Type: RuleScope object

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "action": "string", "createdAt": number, "createdBy": "string", "description": "string", "detail": { ... }, "identifier": "string", "lastUpdatedBy": "string", "name": "string", "revision": "string", "ruleType": "string", "scope": { "assetType": { "selectionMode": "string", "specificAssetTypes": [ "string" ] }, "dataProduct": boolean, "project": { "selectionMode": "string", "specificProjects": [ "string" ] } }, "target": { ... }, "updatedAt": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

action

The action of the rule.

Type: String

Valid Values: CREATE_SUBSCRIPTION_REQUEST

createdAt

The timestamp at which the rule was created.

Type: Timestamp

createdBy

The user who created the rule.

Type: String

description

The description of the rule.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

detail

The detail of the rule.

Type: RuleDetail object

Note: This object is a Union. Only one member of this object can be specified or returned.

identifier

The ID of the rule.

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

lastUpdatedBy

The timestamp at which the rule was last updated.

Type: String

name

The name of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[\w -]+$

revision

The revision of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

ruleType

The type of the rule.

Type: String

Valid Values: METADATA_FORM_ENFORCEMENT

scope

The scope of the rule.

Type: RuleScope object

target

The target of the rule.

Type: RuleTarget object

Note: This object is a Union. Only one member of this object can be specified or returned.

updatedAt

The timestamp at which the rule was last updated.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

There is a conflict while performing this action.

HTTP Status Code: 409

InternalServerException

The request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ServiceQuotaExceededException

The request has exceeded the specified service quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

PrivacidadTérminos del sitioPreferencias de cookies
© 2025, Amazon Web Services, Inc o sus afiliados. Todos los derechos reservados.