Skip to content

create_rule_groups_namespace

create_rule_groups_namespace(
    workspace_id: WorkspaceId,
    name: RuleGroupsNamespaceName,
    data: RuleGroupsNamespaceData,
    *,
    config_overrides: Optional[ampClientConfig] = None,
    client_token: Optional[IdempotencyToken] = None,
    tags: Optional[TagMap] = None,
) -> CreateRuleGroupsNamespaceResponse

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.

The combined length of a rule group namespace and a rule group name cannot exceed 721 UTF-8 bytes.

Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, use PutRuleGroupsNamespace.

Parameters:

  • workspace_id (WorkspaceId) –

    The ID of the workspace to add the rule groups namespace.

  • name (RuleGroupsNamespaceName) –

    The name for the new rule groups namespace.

  • data (RuleGroupsNamespaceData) –

    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.

  • client_token (Optional[IdempotencyToken], default: None ) –

    A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

  • tags (Optional[TagMap], default: None ) –

    The list of tag keys and values to associate with the rule groups namespace.

Raises:

Source code in docs_src/capo_amp/_services/amp.py
def create_rule_groups_namespace(
    self,
    workspace_id: "capo_amp.types.workspace_id.WorkspaceId",
    name: "capo_amp.types.rule_groups_namespace_name.RuleGroupsNamespaceName",
    data: "capo_amp.types.rule_groups_namespace_data.RuleGroupsNamespaceData",
    *,
    config_overrides: Optional[ampClientConfig] = None,
    client_token: Optional[
        "capo_amp.types.idempotency_token.IdempotencyToken"
    ] = None,
    tags: Optional["capo_amp.types.tag_map.TagMap"] = None,
) -> "capo_amp.types.create_rule_groups_namespace_response.CreateRuleGroupsNamespaceResponse":
    """<p>The <code>CreateRuleGroupsNamespace</code> 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.</p> <important> <p>The combined length of a rule group namespace and a rule group name cannot exceed 721 UTF-8 bytes.</p> </important> <p>Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, use <code>PutRuleGroupsNamespace</code>.</p>

    Args:
        workspace_id: <p>The ID of the workspace to add the rule groups namespace.</p>
        name: <p>The name for the new rule groups namespace.</p>
        data: <p>The rules file to use in the new namespace.</p> <p>Contains the base64-encoded version of the YAML rules file.</p> <p>For details about the rule groups namespace structure, see <a href="https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html">RuleGroupsNamespaceData</a>.</p>
        client_token: <p>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</p>
        tags: <p>The list of tag keys and values to associate with the rule groups namespace.</p>

    Raises:
        capo_amp.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_amp.errors.conflict_exception.ConflictException: <p>The request would cause an inconsistent state.</p>
        capo_amp.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred during the processing of the request.</p>
        capo_amp.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resources that doesn't exist.</p>
        capo_amp.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Completing the request would cause a service quota to be exceeded.</p>
        capo_amp.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_amp.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_amp.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_amp.types.create_rule_groups_namespace_request.CreateRuleGroupsNamespaceRequest]",
    ) -> OperationResponse[
        "capo_amp.types.create_rule_groups_namespace_response.CreateRuleGroupsNamespaceResponse"
    ]:
        import capo_amp._operations.amazon_prometheus_service.create_rule_groups_namespace

        output, http_response = (
            capo_amp._operations.amazon_prometheus_service.create_rule_groups_namespace.create_rule_groups_namespace(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateRuleGroupsNamespace")
    )
    input_: capo_amp.types.create_rule_groups_namespace_request.CreateRuleGroupsNamespaceRequest = {
        "workspace_id": workspace_id,
        "name": name,
        "data": data,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if tags is not None:
        input_["tags"] = tags

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output