create_ops_item ¶

def create_ops_item(
    self,
    description: "capo_ssm.types.ops_item_description.OpsItemDescription",
    source: "capo_ssm.types.ops_item_source.OpsItemSource",
    title: "capo_ssm.types.ops_item_title.OpsItemTitle",
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    ops_item_type: Optional["capo_ssm.types.ops_item_type.OpsItemType"] = None,
    operational_data: Optional[
        "capo_ssm.types.ops_item_operational_data.OpsItemOperationalData"
    ] = None,
    notifications: Optional[
        "capo_ssm.types.ops_item_notifications.OpsItemNotifications"
    ] = None,
    priority: Optional["capo_ssm.types.ops_item_priority.OpsItemPriority"] = None,
    related_ops_items: Optional[
        "capo_ssm.types.related_ops_items.RelatedOpsItems"
    ] = None,
    tags: Optional["capo_ssm.types.tag_list.TagList"] = None,
    category: Optional["capo_ssm.types.ops_item_category.OpsItemCategory"] = None,
    severity: Optional["capo_ssm.types.ops_item_severity.OpsItemSeverity"] = None,
    actual_start_time: Optional["capo_ssm.types.date_time.DateTime"] = None,
    actual_end_time: Optional["capo_ssm.types.date_time.DateTime"] = None,
    planned_start_time: Optional["capo_ssm.types.date_time.DateTime"] = None,
    planned_end_time: Optional["capo_ssm.types.date_time.DateTime"] = None,
    account_id: Optional[
        "capo_ssm.types.ops_item_account_id.OpsItemAccountId"
    ] = None,
) -> "capo_ssm.types.create_ops_item_response.CreateOpsItemResponse":
    """<p>Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html">Set up OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> <p>Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html">Amazon Web Services Systems Manager OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>

    Args:
        description: <p>User-defined text that contains information about the OpsItem, in Markdown format. </p> <note> <p>Provide enough information so that users viewing this OpsItem for the first time understand the issue. </p> </note>
        ops_item_type: <p>The type of OpsItem to create. 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/insight</code> </p> <p>This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems. </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> <important> <p>Amazon Web Services Systems Manager Change Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/change-manager-availability-change.html">Amazon Web Services Systems Manager Change Manager availability change</a>.</p> </important> </li> </ul>
        operational_data: <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">Create OpsItems manually</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
        notifications: <p>The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.</p>
        priority: <p>The importance of this OpsItem in relation to other OpsItems in the system.</p>
        related_ops_items: <p>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.</p>
        source: <p>The origin of the OpsItem, such as Amazon EC2 or Systems Manager.</p> <note> <p>The source name can't contain the following strings: <code>aws</code>, <code>amazon</code>, and <code>amzn</code>. </p> </note>
        title: <p>A short heading that describes the nature of the OpsItem and the impacted resource.</p>
        tags: <p>Optional metadata that you assign to a resource.</p> <p>Tags use a key-value pair. For example:</p> <p> <code>Key=Department,Value=Finance</code> </p> <important> <p>To add tags to a new OpsItem, a user must have IAM permissions for both the <code>ssm:CreateOpsItems</code> operation and the <code>ssm:AddTagsToResource</code> operation. To add tags to an existing OpsItem, use the <a>AddTagsToResource</a> operation.</p> </important>
        category: <p>Specify a category to assign to an OpsItem. </p>
        severity: <p>Specify a severity to assign to an OpsItem.</p>
        actual_start_time: <p>The time a runbook workflow started. Currently reported only for the OpsItem type <code>/aws/changerequest</code>.</p>
        actual_end_time: <p>The time a runbook workflow ended. Currently reported only for the OpsItem type <code>/aws/changerequest</code>.</p>
        planned_start_time: <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: <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>
        account_id: <p>The target Amazon Web Services account where you want to create an OpsItem. To make this call, your account must be configured to work with OpsItems across accounts. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html">Set up OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>

    Raises:
        capo_ssm.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</p>
        capo_ssm.errors.ops_item_access_denied_exception.OpsItemAccessDeniedException: <p>You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the Organizations management account.</p>
        capo_ssm.errors.ops_item_already_exists_exception.OpsItemAlreadyExistsException: <p>The OpsItem already exists.</p>
        capo_ssm.errors.ops_item_invalid_parameter_exception.OpsItemInvalidParameterException: <p>A specified parameter argument isn't valid. Verify the available arguments and try again.</p>
        capo_ssm.errors.ops_item_limit_exceeded_exception.OpsItemLimitExceededException: <p>The request caused OpsItems to exceed one or more quotas.</p>
        capo_ssm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm.types.create_ops_item_request.CreateOpsItemRequest]",
    ) -> OperationResponse[
        "capo_ssm.types.create_ops_item_response.CreateOpsItemResponse"
    ]:
        import capo_ssm._operations.amazon_ssm.create_ops_item

        output, http_response = (
            capo_ssm._operations.amazon_ssm.create_ops_item.create_ops_item(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateOpsItem")
    )
    input_: capo_ssm.types.create_ops_item_request.CreateOpsItemRequest = {
        "description": description,
        "source": source,
        "title": title,
    }
    if ops_item_type is not None:
        input_["ops_item_type"] = ops_item_type
    if operational_data is not None:
        input_["operational_data"] = operational_data
    if notifications is not None:
        input_["notifications"] = notifications
    if priority is not None:
        input_["priority"] = priority
    if related_ops_items is not None:
        input_["related_ops_items"] = related_ops_items
    if tags is not None:
        input_["tags"] = tags
    if category is not None:
        input_["category"] = category
    if severity is not None:
        input_["severity"] = severity
    if actual_start_time is not None:
        input_["actual_start_time"] = actual_start_time
    if actual_end_time is not None:
        input_["actual_end_time"] = actual_end_time
    if planned_start_time is not None:
        input_["planned_start_time"] = planned_start_time
    if planned_end_time is not None:
        input_["planned_end_time"] = planned_end_time
    if account_id is not None:
        input_["account_id"] = account_id

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output