OpsItem

public struct OpsItem : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.

    Declaration

    Swift

    public let category: String?

  • The ARN of the AWS account that created the OpsItem.

    Declaration

    Swift

    public let createdBy: String?

  • The date and time the OpsItem was created.

    Declaration

    Swift

    public let createdTime: TimeStamp?

  • The OpsItem description.

    Declaration

    Swift

    public let description: String?

  • The ARN of the AWS account that last updated the OpsItem.

    Declaration

    Swift

    public let lastModifiedBy: String?

  • The date and time the OpsItem was last updated.

    Declaration

    Swift

    public let lastModifiedTime: TimeStamp?

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

    Declaration

    Swift

    public let notifications: [OpsItemNotification]?

  • 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. 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 action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action). 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 AWS CLI example commands that use these keys, see Creating OpsItems manually in the AWS Systems Manager User Guide.

    Declaration

    Swift

    public let operationalData: [String : OpsItemDataValue]?

  • The ID of the OpsItem.

    Declaration

    Swift

    public let opsItemId: String?

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

    Declaration

    Swift

    public let priority: Int?

  • One or more OpsItems that share 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.

    Declaration

    Swift

    public let relatedOpsItems: [RelatedOpsItem]?

  • The severity of the OpsItem. Severity options range from 1 to 4.

    Declaration

    Swift

    public let severity: String?

  • The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of source.

    Declaration

    Swift

    public let source: String?

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

    Declaration

    Swift

    public let status: OpsItemStatus?

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

    Declaration

    Swift

    public let title: String?

  • The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.

    Declaration

    Swift

    public let version: String?

  • Undocumented

    Declaration

    Swift

    public init(category: String? = nil, createdBy: String? = nil, createdTime: TimeStamp? = nil, description: String? = nil, lastModifiedBy: String? = nil, lastModifiedTime: TimeStamp? = nil, notifications: [OpsItemNotification]? = nil, operationalData: [String : OpsItemDataValue]? = nil, opsItemId: String? = nil, priority: Int? = nil, relatedOpsItems: [RelatedOpsItem]? = nil, severity: String? = nil, source: String? = nil, status: OpsItemStatus? = nil, title: String? = nil, version: String? = nil)