Skip to content

update_graph

update_graph(
    graph_identifier: GraphIdentifier,
    *,
    config_overrides: Optional[NeptuneGraphClientConfig] = None,
    public_connectivity: Optional[bool] = None,
    provisioned_memory: Optional[ProvisionedMemory] = None,
    deletion_protection: Optional[bool] = None,
) -> UpdateGraphOutput

Updates the configuration of a specified Neptune Analytics graph

Parameters:

  • graph_identifier (GraphIdentifier) –

    The unique identifier of the Neptune Analytics graph.

  • public_connectivity (Optional[bool], default: None ) –

    Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (true to enable, or false to disable.

  • provisioned_memory (Optional[ProvisionedMemory], default: None ) –

    The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

    Min = 16

  • deletion_protection (Optional[bool], default: None ) –

    A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.

Raises:

Source code in docs_src/capo_neptune_graph/_services/neptune_graph.py
def update_graph(
    self,
    graph_identifier: "capo_neptune_graph.types.graph_identifier.GraphIdentifier",
    *,
    config_overrides: Optional[NeptuneGraphClientConfig] = None,
    public_connectivity: Optional[bool] = None,
    provisioned_memory: Optional[
        "capo_neptune_graph.types.provisioned_memory.ProvisionedMemory"
    ] = None,
    deletion_protection: Optional[bool] = None,
) -> "capo_neptune_graph.types.update_graph_output.UpdateGraphOutput":
    """<p>Updates the configuration of a specified Neptune Analytics graph</p>

    Args:
        graph_identifier: <p>The unique identifier of the Neptune Analytics graph.</p>
        public_connectivity: <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (<code>true</code> to enable, or <code>false</code> to disable.</p>
        provisioned_memory: <p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.</p> <p>Min = 16</p>
        deletion_protection: <p>A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.</p>

    Raises:
        capo_neptune_graph.errors.conflict_exception.ConflictException: <p>Raised when a conflict is encountered.</p>
        capo_neptune_graph.errors.internal_server_exception.InternalServerException: <p>A failure occurred on the server.</p>
        capo_neptune_graph.errors.resource_not_found_exception.ResourceNotFoundException: <p>A specified resource could not be located.</p>
        capo_neptune_graph.errors.throttling_exception.ThrottlingException: <p>The exception was interrupted by throttling.</p>
        capo_neptune_graph.errors.validation_exception.ValidationException: <p>A resource could not be validated.</p>
        capo_neptune_graph.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_neptune_graph.types.update_graph_input.UpdateGraphInput]",
    ) -> OperationResponse[
        "capo_neptune_graph.types.update_graph_output.UpdateGraphOutput"
    ]:
        import capo_neptune_graph._operations.amazon_neptune_graph.update_graph

        output, http_response = (
            capo_neptune_graph._operations.amazon_neptune_graph.update_graph.update_graph(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateGraph")
    )
    input_: capo_neptune_graph.types.update_graph_input.UpdateGraphInput = {
        "graph_identifier": graph_identifier
    }
    if public_connectivity is not None:
        input_["public_connectivity"] = public_connectivity
    if provisioned_memory is not None:
        input_["provisioned_memory"] = provisioned_memory
    if deletion_protection is not None:
        input_["deletion_protection"] = deletion_protection

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