OpsItem ¶

class OpsItem(TypedDict, closed=True):
    created_by: NotRequired["capo_ssm.types.string.String"]
    """<p>The ARN of the Amazon Web Services account that created the OpsItem.</p>"""
    ops_item_type: NotRequired["capo_ssm.types.ops_item_type.OpsItemType"]
    """<p>The type of OpsItem. Systems Manager supports the following types of OpsItems:</p> <ul> <li> <p> <code>/aws/issue</code> </p> <p>This type of OpsItem is used for default OpsItems created by OpsCenter. </p> </li> <li> <p> <code>/aws/changerequest</code> </p> <p>This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests. </p> </li> <li> <p> <code>/aws/insight</code> </p> <p>This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems. </p> </li> </ul>"""
    created_time: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The date and time the OpsItem was created.</p>"""
    description: NotRequired["capo_ssm.types.ops_item_description.OpsItemDescription"]
    """<p>The OpsItem description.</p>"""
    last_modified_by: NotRequired["capo_ssm.types.string.String"]
    """<p>The ARN of the Amazon Web Services account that last updated the OpsItem.</p>"""
    last_modified_time: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The date and time the OpsItem was last updated.</p>"""
    notifications: NotRequired[
        "capo_ssm.types.ops_item_notifications.OpsItemNotifications"
    ]
    """<p>The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.</p>"""
    priority: NotRequired["capo_ssm.types.ops_item_priority.OpsItemPriority"]
    """<p>The importance of this OpsItem in relation to other OpsItems in the system.</p>"""
    related_ops_items: NotRequired["capo_ssm.types.related_ops_items.RelatedOpsItems"]
    """<p>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.</p>"""
    status: NotRequired["capo_ssm.types.ops_item_status.OpsItemStatus"]
    """<p>The OpsItem status. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems-editing-details.html">Editing OpsItem details</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>"""
    ops_item_id: NotRequired["capo_ssm.types.ops_item_id.OpsItemId"]
    """<p>The ID of the OpsItem.</p>"""
    version: NotRequired["capo_ssm.types.string.String"]
    """<p>The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.</p>"""
    title: NotRequired["capo_ssm.types.ops_item_title.OpsItemTitle"]
    """<p>A short heading that describes the nature of the OpsItem and the impacted resource.</p>"""
    source: NotRequired["capo_ssm.types.ops_item_source.OpsItemSource"]
    """<p>The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of source.</p>"""
    operational_data: NotRequired[
        "capo_ssm.types.ops_item_operational_data.OpsItemOperationalData"
    ]
    """<p>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.</p> <important> <p>Operational data keys <i>can't</i> begin with the following: <code>amazon</code>, <code>aws</code>, <code>amzn</code>, <code>ssm</code>, <code>/amazon</code>, <code>/aws</code>, <code>/amzn</code>, <code>/ssm</code>.</p> </important> <p>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 <a>DescribeOpsItems</a> 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 <a>GetOpsItem</a> API operation).</p> <p>Use the <code>/aws/resources</code> key in OperationalData to specify a related resource in the request. Use the <code>/aws/automations</code> key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-manually-create-OpsItems.html">Creating OpsItems manually</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>"""
    category: NotRequired["capo_ssm.types.ops_item_category.OpsItemCategory"]
    """<p>An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.</p>"""
    severity: NotRequired["capo_ssm.types.ops_item_severity.OpsItemSeverity"]
    """<p>The severity of the OpsItem. Severity options range from 1 to 4.</p>"""
    actual_start_time: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The time a runbook workflow started. Currently reported only for the OpsItem type <code>/aws/changerequest</code>.</p>"""
    actual_end_time: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The time a runbook workflow ended. Currently reported only for the OpsItem type <code>/aws/changerequest</code>.</p>"""
    planned_start_time: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type <code>/aws/changerequest</code>.</p>"""
    planned_end_time: NotRequired["capo_ssm.types.date_time.DateTime"]
    """<p>The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type <code>/aws/changerequest</code>.</p>"""
    ops_item_arn: NotRequired["capo_ssm.types.ops_item_arn.OpsItemArn"]
    """<p>The OpsItem Amazon Resource Name (ARN).</p>"""