AWS CLI Command Reference

[ aws . ssm ]

update-ops-item

Description

Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide .

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide .

See also: AWS API Documentation

Synopsis

  update-ops-item
[--description <value>]
[--operational-data <value>]
[--operational-data-to-delete <value>]
[--notifications <value>]
[--priority <value>]
[--related-ops-items <value>]
[--status <value>]
--ops-item-id <value>
[--title <value>]
[--category <value>]
[--severity <value>]
[--actual-start-time <value>]
[--actual-end-time <value>]
[--planned-start-time <value>]
[--planned-end-time <value>]
[--ops-item-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--description (string)

Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.

--operational-data (map)

Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.

Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

Warning

Operational data keys can’t begin with the following: amazon , aws , amzn , ssm , /amazon , /aws , /amzn , /ssm .

You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view and search on the specified data. Operational data that isn’t searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide .

key -> (string)

value -> (structure)

An object that defines the value of the key and its type in the OperationalData map.

Value -> (string)

The value of the OperationalData key.

Type -> (string)

The type of key-value pair. Valid types include SearchableString and String .

Shorthand Syntax:

KeyName1=Value=string,Type=string,KeyName2=Value=string,Type=string

JSON Syntax:

{"string": {
      "Value": "string",
      "Type": "SearchableString"|"String"
    }
  ...}

--operational-data-to-delete (list)

Keys that you want to remove from the OperationalData map.

(string)

Syntax:

"string" "string" ...

--notifications (list)

The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.

(structure)

A notification about the OpsItem.

Arn -> (string)

The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.

Shorthand Syntax:

Arn=string ...

JSON Syntax:

[
  {
    "Arn": "string"
  }
  ...
]

--priority (integer)

The importance of this OpsItem in relation to other OpsItems in the system.

--related-ops-items (list)

One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

(structure)

An OpsItems that shares something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

OpsItemId -> (string)

The ID of an OpsItem related to the current OpsItem.

Shorthand Syntax:

OpsItemId=string ...

JSON Syntax:

[
  {
    "OpsItemId": "string"
  }
  ...
]

--status (string)

The OpsItem status. Status can be Open , In Progress , or Resolved . For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide .

Possible values:

  • Open

  • InProgress

  • Resolved

  • Pending

  • TimedOut

  • Cancelling

  • Cancelled

  • Failed

  • CompletedWithSuccess

  • CompletedWithFailure

  • Scheduled

  • RunbookInProgress

  • PendingChangeCalendarOverride

  • ChangeCalendarOverrideApproved

  • ChangeCalendarOverrideRejected

  • PendingApproval

  • Approved

  • Rejected

  • Closed

--ops-item-id (string)

The ID of the OpsItem.

--title (string)

A short heading that describes the nature of the OpsItem and the impacted resource.

--category (string)

Specify a new category for an OpsItem.

--severity (string)

Specify a new severity for an OpsItem.

--actual-start-time (timestamp)

The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest .

--actual-end-time (timestamp)

The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest .

--planned-start-time (timestamp)

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest .

--planned-end-time (timestamp)

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest .

--ops-item-arn (string)

The OpsItem Amazon Resource Name (ARN).

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json

  • text

  • table

  • yaml

  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on

  • off

  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64

  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To update an OpsItem

The following update-ops-item example updates the description, priority, and category for an OpsItem. In addition, the command specifies an SNS topic where the notifications are sent when this OpsItem is edited or changed.

aws ssm update-ops-item \
    --ops-item-id "oi-287b5EXAMPLE" \
    --description "Primary OpsItem for failover event 2020-01-01-fh398yf" \
    --priority 2 \
    --category "Security" \
    --notifications "Arn=arn:aws:sns:us-east-2:111222333444:my-us-east-2-topic"

Output:

This command produces no output.

For more information, see Working with OpsItems in the AWS Systems Manager User Guide.

Output

None

© Copyright 2018, Amazon Web Services. Created using Sphinx.