OpsItemSummary - AWS Systems Manager
ContentsSee Also

OpsItemSummary

A count of OpsItems.

Contents

ActualEndTime

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

Type: Timestamp

Required: No

ActualStartTime

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

Type: Timestamp

Required: No

Category

A list of OpsItems by category.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^(?!\s*$).+

Required: No

CreatedBy

The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.

Type: String

Required: No

CreatedTime

The date and time the OpsItem was created.

Type: Timestamp

Required: No

LastModifiedBy

The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.

Type: String

Required: No

LastModifiedTime

The date and time the OpsItem was last updated.

Type: Timestamp

Required: No

OperationalData

Operational data is custom data that provides useful reference details about the OpsItem.

Type: String to OpsItemDataValue object map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!\s*$).+

Required: No

OpsItemId

The ID of the OpsItem.

Type: String

Pattern: ^(oi)-[0-9a-f]{12}$

Required: No

OpsItemType

The type of OpsItem. 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.

Type: String

Required: No

PlannedEndTime

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

Type: Timestamp

Required: No

PlannedStartTime

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

Type: Timestamp

Required: No

Priority

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 5.

Required: No

Severity

A list of OpsItems by severity.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^(?!\s*$).+

Required: No

Source

The impacted AWS resource.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^(?!\s*$).+

Required: No

Status

The OpsItem status.

Type: String

Valid Values: Open | InProgress | Resolved | Pending | TimedOut | Cancelling | Cancelled | Failed | CompletedWithSuccess | CompletedWithFailure | Scheduled | RunbookInProgress | PendingChangeCalendarOverride | ChangeCalendarOverrideApproved | ChangeCalendarOverrideRejected | PendingApproval | Approved | Rejected | Closed

Required: No

Title

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^(?!\s*$).+

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: