CreateOpsItemRequest

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

interface CreateOpsItemRequest {

ActualEndTime?: Date | number | null;

ActualStartTime?: Date | number | null;

Category?: string | null;

Description: string;

Notifications?: OpsItemNotification[] | null;

OperationalData?: {

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

} | null;

OpsItemType?: string | null;

PlannedEndTime?: Date | number | null;

PlannedStartTime?: Date | number | null;

Priority?: number | null;

RelatedOpsItems?: RelatedOpsItem[] | null;

Severity?: string | null;

Source: string;

Tags?: Tag[] | null;

Title: string;

}

§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 category to assign to an OpsItem.

Description: string

[src]

Information about the OpsItem.

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]

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.

OpsItemType?: string | null

[src]

The type of OpsItem to create. Currently, the only valid values are /aws/changerequest and /aws/issue.

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 severity to assign to an OpsItem.

Source: string

[src]

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.

Tags?: Tag[] | null

[src]

Optional metadata that you assign to a resource. You can restrict access to OpsItems by using an inline IAM policy that specifies tags. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide.

Tags use a key-value pair. For example:

Key=Department,Value=Finance

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

Title: string

[src]

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