Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ssm ]

create-ops-item¶

Description¶

Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Set up 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 Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide .

Synopsis¶

  create-ops-item
--description <value>
[--ops-item-type <value>]
[--operational-data <value>]
[--notifications <value>]
[--priority <value>]
[--related-ops-items <value>]
--source <value>
--title <value>
[--tags <value>]
[--category <value>]
[--severity <value>]
[--actual-start-time <value>]
[--actual-end-time <value>]
[--planned-start-time <value>]
[--planned-end-time <value>]
[--account-id <value>]
[--cli-input-json <value>]
[--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>]

Options¶

--description (string)

User-defined text that contains information about the OpsItem, in Markdown format.

Note
Provide enough information so that users viewing this OpsItem for the first time understand the issue.

--ops-item-type (string)

The type of OpsItem to create. Systems Manager supports the following types of OpsItems:

/aws/issue This type of OpsItem is used for default OpsItems created by OpsCenter.

/aws/changerequest This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.

/aws/insight This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.

--operational-data (map)

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 Create 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"
    }
  ...}

--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"
  }
  ...
]

--source (string)

The origin of the OpsItem, such as Amazon EC2 or Systems Manager.

Note
The source name can't contain the following strings: aws , amazon , and amzn .

--title (string)

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

--tags (list)

Optional metadata that you assign to a resource.

Tags use a key-value pair. For example:

Key=Department,Value=Finance

Warning
To add tags to a new OpsItem, a user must have IAM permissions for both the ssm:CreateOpsItems operation and the ssm:AddTagsToResource operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.

(structure)

Metadata that you assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Amazon Web Services Systems Manager, you can apply tags to Systems Manager documents (SSM documents), managed nodes, maintenance windows, parameters, patch baselines, OpsItems, and OpsMetadata.

Key -> (string)

The name of the tag.

Value -> (string)

The value of the tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--category (string)

Specify a category to assign to an OpsItem.

--severity (string)

Specify a severity to assign to 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 .

--account-id (string)

The target Amazon Web Services account where you want to create an OpsItem. To make this call, your account must be configured to work with OpsItems across accounts. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

--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.

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 create an OpsItems

The following create-ops-item example uses the /aws/resources key in OperationalData to create an OpsItem with an Amazon DynamoDB related resource.

aws ssm create-ops-item \
    --title "EC2 instance disk full" \
    --description "Log clean up may have failed which caused the disk to be full" \
    --priority 2 \
    --source ec2 \
    --operational-data '{"/aws/resources":{"Value":"[{\"arn\": \"arn:aws:dynamodb:us-west-2:12345678:table/OpsItems\"}]","Type":"SearchableString"}}' \
    --notifications Arn="arn:aws:sns:us-west-2:12345678:TestUser"

Output:

{
    "OpsItemId": "oi-1a2b3c4d5e6f"
}

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

Output¶

OpsItemId -> (string)

The ID of the OpsItem.

OpsItemArn -> (string)

The OpsItem Amazon Resource Name (ARN).

Table Of Contents

Feedback

User Guide

Note:

create-ops-item¶

Description¶

Synopsis¶

Options¶

Note

Warning

Note

Warning

Global Options¶

Examples¶

Note

Output¶