update_ops_item async ¶

async def update_ops_item(
    self,
    ops_item_id: "capo_ssm.types.ops_item_id.OpsItemId",
    *,
    config_overrides: Optional[AsyncSSMClientConfig] = None,
    description: Optional[
        "capo_ssm.types.ops_item_description.OpsItemDescription"
    ] = None,
    operational_data: Optional[
        "capo_ssm.types.ops_item_operational_data.OpsItemOperationalData"
    ] = None,
    operational_data_to_delete: Optional[
        "capo_ssm.types.ops_item_ops_data_keys_list.OpsItemOpsDataKeysList"
    ] = 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,
    status: Optional["capo_ssm.types.ops_item_status.OpsItemStatus"] = None,
    title: Optional["capo_ssm.types.ops_item_title.OpsItemTitle"] = 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,
    ops_item_arn: Optional["capo_ssm.types.ops_item_arn.OpsItemArn"] = None,
) -> "capo_ssm.types.update_ops_item_response.UpdateOpsItemResponse":
    """<p>Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an 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>
        operational_data: <p>Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.</p> <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>
        operational_data_to_delete: <p>Keys that you want to remove from the OperationalData map.</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>
        status: <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: <p>The ID of the OpsItem.</p>
        title: <p>A short heading that describes the nature of the OpsItem and the impacted resource.</p>
        category: <p>Specify a new category for an OpsItem.</p>
        severity: <p>Specify a new severity for 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>
        ops_item_arn: <p>The OpsItem Amazon Resource Name (ARN).</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_conflict_exception.OpsItemConflictException: <p>The specified OpsItem is in the process of being deleted.</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.ops_item_not_found_exception.OpsItemNotFoundException: <p>The specified OpsItem ID doesn't exist. Verify the ID and try again.</p>
        capo_ssm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ssm.types.update_ops_item_request.UpdateOpsItemRequest]",
    ) -> AsyncOperationResponse[
        "capo_ssm.types.update_ops_item_response.UpdateOpsItemResponse"
    ]:
        import capo_ssm._operations.amazon_ssm.update_ops_item

        (
            output,
            http_response,
        ) = await capo_ssm._operations.amazon_ssm.update_ops_item.async_update_ops_item(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateOpsItem")
    )
    input_: capo_ssm.types.update_ops_item_request.UpdateOpsItemRequest = {
        "ops_item_id": ops_item_id
    }
    if description is not None:
        input_["description"] = description
    if operational_data is not None:
        input_["operational_data"] = operational_data
    if operational_data_to_delete is not None:
        input_["operational_data_to_delete"] = operational_data_to_delete
    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 status is not None:
        input_["status"] = status
    if title is not None:
        input_["title"] = title
    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 ops_item_arn is not None:
        input_["ops_item_arn"] = ops_item_arn

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output