``list``
========
.. contents:: :local:
 :depth: 1
Description
------------
Gets a list of all the maintenance events for the given compartment. 


Usage
-----
.. code-block:: none

  oci compute instance-maintenance-event list [OPTIONS]

Required Parameters
--------------------
.. option:: --compartment-id, -c [text]

The `OCID <https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm>`__ of the compartment.


Optional Parameters
--------------------
.. option:: --all

Fetches all pages of results. If you provide this option, then you cannot provide the ``--limit`` option.

.. option:: --correlation-token [text]

A filter to only return resources that have a matching correlationToken.

.. option:: --from-json [text]

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

The :option:`--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/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

.. option:: --instance-action [text]

A filter to only return resources that match the given instance action.

.. option:: --instance-id [text]

The OCID of the instance.

.. option:: --lifecycle-state [text]

A filter to only return resources that match the given lifecycle state.

Accepted values are:

.. code-block:: py

    CANCELED, FAILED, PROCESSING, SCHEDULED, STARTED, SUCCEEDED

.. option:: --limit [integer]

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see `List Pagination <https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine>`__.


Example:

.. code-block:: python

    50


.. option:: --page [text]

For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see `List Pagination <https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine>`__.

.. option:: --page-size [integer]

When fetching results, the number of results to fetch per call. Only valid when used with ``--all`` or ``--limit``, and ignored otherwise.

.. option:: --sort-by [text]

The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

**Note:** In general, some "List" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

Accepted values are:

.. code-block:: py

    DISPLAYNAME, TIMECREATED

.. option:: --sort-order [text]

The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive.

Accepted values are:

.. code-block:: py

    ASC, DESC

.. option:: --time-window-start-greater-than-or-equal-to [datetime]

Starting range to return the maintenances which are not completed (date-time is in `RFC3339 <https://tools.ietf.org/html/rfc3339>`__ format).

    The following datetime formats are supported:

UTC with microseconds
***********************
.. code::

    Format: YYYY-MM-DDTHH:mm:ss.ssssssTZD
    Example: 2017-09-15T20:30:00.123456Z

    UTC with milliseconds
    ***********************
    .. code::

        Format: YYYY-MM-DDTHH:mm:ss.sssTZD
        Example: 2017-09-15T20:30:00.123Z

    UTC without milliseconds
    **************************
    .. code::

        Format: YYYY-MM-DDTHH:mm:ssTZD
        Example: 2017-09-15T20:30:00Z

    UTC with minute precision
    **************************
    .. code::

        Format: YYYY-MM-DDTHH:mmTZD
        Example: 2017-09-15T20:30Z

Timezone with microseconds
***************************
.. code::

    Format: YYYY-MM-DDTHH:mm:ssTZD
    Example: 2017-09-15T12:30:00.456789-08:00, 2017-09-15T12:30:00.456789-0800

    Timezone with milliseconds
    ***************************
    .. code::

        Format: YYYY-MM-DDTHH:mm:ssTZD
        Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800

    Timezone without milliseconds
    *******************************
    .. code::

        Format: YYYY-MM-DDTHH:mm:ssTZD
        Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800

    Timezone with minute precision
    *******************************
    .. code::

        Format: YYYY-MM-DDTHH:mmTZD
        Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800

    Short date and time
    ********************
    The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes)

    .. code::

        Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
        Example: '2017-09-15 17:25'

    Date Only
    **********
    This date will be taken as midnight UTC of that day

    .. code::

        Format: YYYY-MM-DD
        Example: 2017-09-15

    Epoch seconds
    **************
    .. code::

        Example: 1412195400
    

.. option:: --time-window-start-less-than-or-equal-to [datetime]

Ending range to return the maintenances which are not completed (date-time is in `RFC3339 <https://tools.ietf.org/html/rfc3339>`__ format).

    The following datetime formats are supported:

UTC with microseconds
***********************
.. code::

    Format: YYYY-MM-DDTHH:mm:ss.ssssssTZD
    Example: 2017-09-15T20:30:00.123456Z

    UTC with milliseconds
    ***********************
    .. code::

        Format: YYYY-MM-DDTHH:mm:ss.sssTZD
        Example: 2017-09-15T20:30:00.123Z

    UTC without milliseconds
    **************************
    .. code::

        Format: YYYY-MM-DDTHH:mm:ssTZD
        Example: 2017-09-15T20:30:00Z

    UTC with minute precision
    **************************
    .. code::

        Format: YYYY-MM-DDTHH:mmTZD
        Example: 2017-09-15T20:30Z

Timezone with microseconds
***************************
.. code::

    Format: YYYY-MM-DDTHH:mm:ssTZD
    Example: 2017-09-15T12:30:00.456789-08:00, 2017-09-15T12:30:00.456789-0800

    Timezone with milliseconds
    ***************************
    .. code::

        Format: YYYY-MM-DDTHH:mm:ssTZD
        Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800

    Timezone without milliseconds
    *******************************
    .. code::

        Format: YYYY-MM-DDTHH:mm:ssTZD
        Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800

    Timezone with minute precision
    *******************************
    .. code::

        Format: YYYY-MM-DDTHH:mmTZD
        Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800

    Short date and time
    ********************
    The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes)

    .. code::

        Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
        Example: '2017-09-15 17:25'

    Date Only
    **********
    This date will be taken as midnight UTC of that day

    .. code::

        Format: YYYY-MM-DD
        Example: 2017-09-15

    Epoch seconds
    **************
    .. code::

        Example: 1412195400
    



Global Parameters
------------------
Use ``oci --help`` for help on global parameters.

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



Example using required parameter
------------------

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  <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile>`__ and `appropriate security policies  <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm>`__ before trying the examples.

.. code-block:: none
    :class: copy-code-block

    
	export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/compute/instance-maintenance-event/list.html#cmdoption-compartment-id
	
	oci compute instance-maintenance-event list --compartment-id $compartment_id



