CreateRuleGroupsNamespace
The CreateRuleGroupsNamespace operation creates a rule groups namespace
within a workspace. A rule groups namespace is associated with exactly one rules file. A
workspace can have multiple rule groups namespaces.
Use this operation only to create new rule groups namespaces. To update an existing
rule groups namespace, use PutRuleGroupsNamespace.
Request Syntax
POST /workspaces/workspaceId/rulegroupsnamespaces HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"data": blob,
"name": "string",
"tags": {
"string" : "string"
}
}URI Request Parameters
The request uses the following URI parameters.
- workspaceId
-
The ID of the workspace to add the rule groups namespace.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[0-9A-Za-z][-.0-9A-Z_a-z]*Required: Yes
Request Body
The request accepts the following data in JSON format.
- clientToken
-
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[!-~]+$Required: No
- data
-
The rules file to use in the new namespace.
Contains the base64-encoded version of the YAML rules file.
For details about the rule groups namespace structure, see RuleGroupsNamespaceData.
Type: Base64-encoded binary data object
Required: Yes
- name
-
The name for the new rule groups namespace.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[0-9A-Za-z][-.0-9A-Z_a-z]*Required: Yes
-
The list of tag keys and values to associate with the rule groups namespace.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$Required: No
Response Syntax
HTTP/1.1 202
Content-type: application/json
{
"arn": "string",
"name": "string",
"status": {
"statusCode": "string",
"statusReason": "string"
},
"tags": {
"string" : "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
- arn
-
The Amazon Resource Name (ARN) of the new rule groups namespace.
Type: String
- name
-
The name of the new rule groups namespace.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[0-9A-Za-z][-.0-9A-Z_a-z]* - status
-
A structure that returns the current status of the rule groups namespace.
Type: RuleGroupsNamespaceStatus object
-
The list of tag keys and values that are associated with the namespace.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
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
-
The request would cause an inconsistent state.
HTTP Status Code: 409
- InternalServerException
-
An unexpected error occurred during the processing of the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The request references a resources that doesn't exist.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
Completing the request would cause a service quota to be exceeded.
HTTP Status Code: 402
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an 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:
