CreateOpsItemRequest

public struct CreateOpsItemRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • Specify a category to assign to an OpsItem.

    Declaration

    Swift

    public let category: String?

  • Information about the OpsItem.

    Declaration

    Swift

    public let description: String

  • 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 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 OpsItems. 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]?

  • Specify a severity to assign to an OpsItem.

    Declaration

    Swift

    public let severity: String?

  • The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The source name can’t contain the following strings: aws, amazon, and amzn.

    Declaration

    Swift

    public let source: String

  • 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 AWS Systems Manager User Guide. Tags use a key-value pair. For example: Key=Department,Value=Finance To add tags to an existing OpsItem, use the AddTagsToResource action.

    Declaration

    Swift

    public let tags: [Tag]?

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

    Declaration

    Swift

    public let title: String

  • Undocumented

    Declaration

    Swift

    public init(category: String? = nil, description: String, notifications: [OpsItemNotification]? = nil, operationalData: [String : OpsItemDataValue]? = nil, priority: Int? = nil, relatedOpsItems: [RelatedOpsItem]? = nil, severity: String? = nil, source: String, tags: [Tag]? = nil, title: String)

  • Declaration

    Swift

    public func validate(name: String) throws