UpdateOpsItemRequest

import type { UpdateOpsItemRequest } from "https://aws-api.deno.dev/v0.3/services/ssm.ts?docs=full";

interface UpdateOpsItemRequest {

ActualEndTime?: Date | number | null;

ActualStartTime?: Date | number | null;

Category?: string | null;

Description?: string | null;

Notifications?: OpsItemNotification[] | null;

OperationalData?: {

[key: string]: OpsItemDataValue | null | undefined;

} | null;

OperationalDataToDelete?: string[] | null;

OpsItemId: string;

PlannedEndTime?: Date | number | null;

PlannedStartTime?: Date | number | null;

Priority?: number | null;

RelatedOpsItems?: RelatedOpsItem[] | null;

Severity?: string | null;

Status?: OpsItemStatus | null;

Title?: string | null;

}

§Properties

ActualEndTime?: Date | number | null

[src]

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

ActualStartTime?: Date | number | null

[src]

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

Category?: string | null

[src]

Specify a new category for an OpsItem.

Description?: string | null

[src]

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

Notifications?: OpsItemNotification[] | null

[src]

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

OperationalData?: {

[key: string]: OpsItemDataValue | null | undefined;

} | null

[src]

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.

! IMPORTANT: ! 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.

OperationalDataToDelete?: string[] | null

[src]

Keys that you want to remove from the OperationalData map.

OpsItemId: string

[src]

The ID of the OpsItem.

PlannedEndTime?: Date | number | null

[src]

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

PlannedStartTime?: Date | number | null

[src]

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

Priority?: number | null

[src]

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

RelatedOpsItems?: RelatedOpsItem[] | null

[src]

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.

Severity?: string | null

[src]

Specify a new severity for an OpsItem.

Status?: OpsItemStatus | null

[src]

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.

Title?: string | null

[src]

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