"update-notes"
**************

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Example using required parameter


Description
===========

Add or edit notes to a set of attributes in the APM Domain.  Notes can
be added to either an active or an inactive attribute.  The notes will
be preserved even if the attribute changes state (when an active
attribute is deactivated or when an inactive attribute is activated).


Usage
=====

   oci apm-traces attributes update-notes [OPTIONS]


Required Parameters
===================

--apm-domain-id [text]

The APM Domain ID for the intended request.

--attribute-details [complex type]

Collection of objects containing the details about individual
attribute for which notes are to be updated.

This option is a JSON list with items of type
BulkUpdateAttributeNotesDetail.  For documentation on
BulkUpdateAttributeNotesDetail please see our API reference: https://
docs.cloud.oracle.com/api/#/en/attributes/20200630/datatypes/BulkUpda
teAttributeNotesDetail. [

   {
      “attributeName”: “<Name of the attribute for which notes are to
      be updated>”, “notes” : “<Sample notes>”, “attributeNamespace”:
      “<TRACES|SYNTHETIC>”

   }


]
-

This is a complex type whose value must be valid JSON. The value can
be provided as a string on the command line or passed in as a file
using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.


Optional Parameters
===================

--from-json [text]

Provide input to this command as a JSON document from a file using the
file://path-to/file syntax.

The "--generate-full-command-json-input" option can be used to
generate a sample json file to be used with this command option. The
key names are pre-populated and match the command option names
(converted to camelCase format, e.g. compartment-id –> compartmentId),
while the values of the keys need to be populated by the user before
using the sample file as an input to this command. For any command
option that accepts multiple values, the value of the key can be a
JSON array.

Options can still be provided on the command line. If an option exists
in both the JSON document and the command line then the command line
specified value will be used.

For examples on usage of this option, please see our “using CLI with
advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions


Global Parameters
=================

Use "oci --help" for help on global parameters.

"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
defaults-file", "--endpoint", "--generate-full-command-json-input", "
--generate-param-json-input", "--help", "--latest-version", "--max-
retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
"--output", "--profile", "--proxy", "--query", "--raw-output", "--
read-timeout", "--realm-specific-endpoint", "--region", "--release-
info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"


Example using required parameter
================================

Copy and paste the following example into a JSON file, replacing the
example parameters with your own.

       oci apm-traces attributes update-notes --generate-param-json-input attribute-details > attribute-details.json

Copy the following CLI commands into a file named example.sh. Run the
command by typing “bash example.sh” and replacing the example
parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-
like shell. You need to set up the OCI configuration and appropriate
security policies before trying the examples.

       export apm_domain_id=<substitute-value-of-apm_domain_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/apm-traces/attributes/update-notes.html#cmdoption-apm-domain-id

       oci apm-traces attributes update-notes --apm-domain-id $apm_domain_id --attribute-details file://attribute-details.json
