Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SSM.UpdateOpsItem

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide.

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 OpsCenter in the Amazon Web Services Systems Manager User Guide.

Synopsis

data UpdateOpsItem = UpdateOpsItem' {
- actualEndTime :: Maybe POSIX
- actualStartTime :: Maybe POSIX
- category :: Maybe Text
- description :: Maybe Text
- notifications :: Maybe [OpsItemNotification]
- operationalData :: Maybe (HashMap Text OpsItemDataValue)
- operationalDataToDelete :: Maybe [Text]
- opsItemArn :: Maybe Text
- plannedEndTime :: Maybe POSIX
- plannedStartTime :: Maybe POSIX
- priority :: Maybe Natural
- relatedOpsItems :: Maybe [RelatedOpsItem]
- severity :: Maybe Text
- status :: Maybe OpsItemStatus
- title :: Maybe Text
- opsItemId :: Text
}
newUpdateOpsItem :: Text -> UpdateOpsItem
updateOpsItem_actualEndTime :: Lens' UpdateOpsItem (Maybe UTCTime)
updateOpsItem_actualStartTime :: Lens' UpdateOpsItem (Maybe UTCTime)
updateOpsItem_category :: Lens' UpdateOpsItem (Maybe Text)
updateOpsItem_description :: Lens' UpdateOpsItem (Maybe Text)
updateOpsItem_notifications :: Lens' UpdateOpsItem (Maybe [OpsItemNotification])
updateOpsItem_operationalData :: Lens' UpdateOpsItem (Maybe (HashMap Text OpsItemDataValue))
updateOpsItem_operationalDataToDelete :: Lens' UpdateOpsItem (Maybe [Text])
updateOpsItem_opsItemArn :: Lens' UpdateOpsItem (Maybe Text)
updateOpsItem_plannedEndTime :: Lens' UpdateOpsItem (Maybe UTCTime)
updateOpsItem_plannedStartTime :: Lens' UpdateOpsItem (Maybe UTCTime)
updateOpsItem_priority :: Lens' UpdateOpsItem (Maybe Natural)
updateOpsItem_relatedOpsItems :: Lens' UpdateOpsItem (Maybe [RelatedOpsItem])
updateOpsItem_severity :: Lens' UpdateOpsItem (Maybe Text)
updateOpsItem_status :: Lens' UpdateOpsItem (Maybe OpsItemStatus)
updateOpsItem_title :: Lens' UpdateOpsItem (Maybe Text)
updateOpsItem_opsItemId :: Lens' UpdateOpsItem Text
data UpdateOpsItemResponse = UpdateOpsItemResponse' {
- httpStatus :: Int
}
newUpdateOpsItemResponse :: Int -> UpdateOpsItemResponse
updateOpsItemResponse_httpStatus :: Lens' UpdateOpsItemResponse Int

Creating a Request

data UpdateOpsItem Source #

See: newUpdateOpsItem smart constructor.

Constructors

UpdateOpsItem'

Fields

actualEndTime :: Maybe POSIX
The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.
actualStartTime :: Maybe POSIX
The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.
category :: Maybe Text
Specify a new category for an OpsItem.
description :: Maybe Text
Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.
notifications :: Maybe [OpsItemNotification]
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
operationalData :: Maybe (HashMap Text OpsItemDataValue)
Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.
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 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 GetOpsItem API operation).
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 Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.
operationalDataToDelete :: Maybe [Text]
Keys that you want to remove from the OperationalData map.
opsItemArn :: Maybe Text
The OpsItem Amazon Resource Name (ARN).
plannedEndTime :: Maybe POSIX
The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.
plannedStartTime :: Maybe POSIX
The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.
priority :: Maybe Natural
The importance of this OpsItem in relation to other OpsItems in the system.
relatedOpsItems :: Maybe [RelatedOpsItem]
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.
severity :: Maybe Text
Specify a new severity for an OpsItem.
status :: Maybe OpsItemStatus
The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.
title :: Maybe Text
A short heading that describes the nature of the OpsItem and the impacted resource.
opsItemId :: Text
The ID of the OpsItem.

Instances

Instances details

ToJSON UpdateOpsItem Source #
Instance details Defined in Amazonka.SSM.UpdateOpsItem Methods toJSON :: UpdateOpsItem -> Value # toEncoding :: UpdateOpsItem -> Encoding # toJSONList :: [UpdateOpsItem] -> Value # toEncodingList :: [UpdateOpsItem] -> Encoding #
ToHeaders UpdateOpsItem Source #
Instance details Defined in Amazonka.SSM.UpdateOpsItem Methods toHeaders :: UpdateOpsItem -> [Header] #
ToPath UpdateOpsItem Source #
Instance details Defined in Amazonka.SSM.UpdateOpsItem Methods toPath :: UpdateOpsItem -> ByteString #
ToQuery UpdateOpsItem Source #
Instance details Defined in Amazonka.SSM.UpdateOpsItem Methods toQuery :: UpdateOpsItem -> QueryString #
AWSRequest UpdateOpsItem Source #
Instance details Defined in Amazonka.SSM.UpdateOpsItem Associated Types type AWSResponse UpdateOpsItem # Methods request :: (Service -> Service) -> UpdateOpsItem -> Request UpdateOpsItem # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateOpsItem -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateOpsItem))) #
Generic UpdateOpsItem Source #
Instance details Defined in Amazonka.SSM.UpdateOpsItem Associated Types type Rep UpdateOpsItem :: Type -> Type # Methods from :: UpdateOpsItem -> Rep UpdateOpsItem x # to :: Rep UpdateOpsItem x -> UpdateOpsItem #
Read UpdateOpsItem Source #
Instance details Defined in Amazonka.SSM.UpdateOpsItem Methods readsPrec :: Int -> ReadS UpdateOpsItem # readList :: ReadS [UpdateOpsItem] # readPrec :: ReadPrec UpdateOpsItem # readListPrec :: ReadPrec [UpdateOpsItem] #
Show UpdateOpsItem Source #
Instance details Defined in Amazonka.SSM.UpdateOpsItem Methods showsPrec :: Int -> UpdateOpsItem -> ShowS # show :: UpdateOpsItem -> String # showList :: [UpdateOpsItem] -> ShowS #
NFData UpdateOpsItem Source #
Instance details Defined in Amazonka.SSM.UpdateOpsItem Methods rnf :: UpdateOpsItem -> () #
Eq UpdateOpsItem Source #
Instance details Defined in Amazonka.SSM.UpdateOpsItem Methods (==) :: UpdateOpsItem -> UpdateOpsItem -> Bool # (/=) :: UpdateOpsItem -> UpdateOpsItem -> Bool #
Hashable UpdateOpsItem Source #
Instance details Defined in Amazonka.SSM.UpdateOpsItem Methods hashWithSalt :: Int -> UpdateOpsItem -> Int # hash :: UpdateOpsItem -> Int #
type AWSResponse UpdateOpsItem Source #
Instance details Defined in Amazonka.SSM.UpdateOpsItem type AWSResponse UpdateOpsItem = UpdateOpsItemResponse
type Rep UpdateOpsItem Source #
Instance details Defined in Amazonka.SSM.UpdateOpsItem type Rep UpdateOpsItem = D1 ('MetaData "UpdateOpsItem" "Amazonka.SSM.UpdateOpsItem" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "UpdateOpsItem'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "actualEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "actualStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "category") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "notifications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OpsItemNotification])) :: S1 ('MetaSel ('Just "operationalData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text OpsItemDataValue)))) :: (S1 ('MetaSel ('Just "operationalDataToDelete") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "opsItemArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "plannedEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "plannedStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "relatedOpsItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RelatedOpsItem])))) :: ((S1 ('MetaSel ('Just "severity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OpsItemStatus))) :: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "opsItemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateOpsItem Source #

Arguments

:: Text	`UpdateOpsItem`
-> UpdateOpsItem

Create a value of UpdateOpsItem with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateOpsItem, updateOpsItem_actualEndTime - The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.

UpdateOpsItem, updateOpsItem_actualStartTime - The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.

UpdateOpsItem, updateOpsItem_category - Specify a new category for an OpsItem.

UpdateOpsItem, updateOpsItem_description - Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.

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

UpdateOpsItem, updateOpsItem_operationalData - Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.

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 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 GetOpsItem API operation).

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 Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

$sel:operationalDataToDelete:UpdateOpsItem', updateOpsItem_operationalDataToDelete - Keys that you want to remove from the OperationalData map.

UpdateOpsItem, updateOpsItem_opsItemArn - The OpsItem Amazon Resource Name (ARN).

UpdateOpsItem, updateOpsItem_plannedEndTime - The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.

UpdateOpsItem, updateOpsItem_plannedStartTime - The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.

UpdateOpsItem, updateOpsItem_priority - The importance of this OpsItem in relation to other OpsItems in the system.

UpdateOpsItem, updateOpsItem_relatedOpsItems - 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.

UpdateOpsItem, updateOpsItem_severity - Specify a new severity for an OpsItem.

UpdateOpsItem, updateOpsItem_status - The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.

UpdateOpsItem, updateOpsItem_title - A short heading that describes the nature of the OpsItem and the impacted resource.

UpdateOpsItem, updateOpsItem_opsItemId - The ID of the OpsItem.

Request Lenses

updateOpsItem_actualEndTime :: Lens' UpdateOpsItem (Maybe UTCTime) Source #

The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.

updateOpsItem_actualStartTime :: Lens' UpdateOpsItem (Maybe UTCTime) Source #

The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.

updateOpsItem_category :: Lens' UpdateOpsItem (Maybe Text) Source #

Specify a new category for an OpsItem.

updateOpsItem_description :: Lens' UpdateOpsItem (Maybe Text) Source #

Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.

updateOpsItem_notifications :: Lens' UpdateOpsItem (Maybe [OpsItemNotification]) Source #

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

updateOpsItem_operationalData :: Lens' UpdateOpsItem (Maybe (HashMap Text OpsItemDataValue)) Source #

Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.

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 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 GetOpsItem API operation).

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 Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

updateOpsItem_operationalDataToDelete :: Lens' UpdateOpsItem (Maybe [Text]) Source #

Keys that you want to remove from the OperationalData map.

updateOpsItem_opsItemArn :: Lens' UpdateOpsItem (Maybe Text) Source #

The OpsItem Amazon Resource Name (ARN).

updateOpsItem_plannedEndTime :: Lens' UpdateOpsItem (Maybe UTCTime) Source #

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.

updateOpsItem_plannedStartTime :: Lens' UpdateOpsItem (Maybe UTCTime) Source #

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.

updateOpsItem_priority :: Lens' UpdateOpsItem (Maybe Natural) Source #

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

updateOpsItem_relatedOpsItems :: Lens' UpdateOpsItem (Maybe [RelatedOpsItem]) Source #

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.

updateOpsItem_severity :: Lens' UpdateOpsItem (Maybe Text) Source #

Specify a new severity for an OpsItem.

updateOpsItem_status :: Lens' UpdateOpsItem (Maybe OpsItemStatus) Source #

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

updateOpsItem_title :: Lens' UpdateOpsItem (Maybe Text) Source #

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

updateOpsItem_opsItemId :: Lens' UpdateOpsItem Text Source #

The ID of the OpsItem.

Destructuring the Response

data UpdateOpsItemResponse Source #

See: newUpdateOpsItemResponse smart constructor.

Constructors

UpdateOpsItemResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateOpsItemResponse Source #
Instance details Defined in Amazonka.SSM.UpdateOpsItem Associated Types type Rep UpdateOpsItemResponse :: Type -> Type # Methods from :: UpdateOpsItemResponse -> Rep UpdateOpsItemResponse x # to :: Rep UpdateOpsItemResponse x -> UpdateOpsItemResponse #
Read UpdateOpsItemResponse Source #
Instance details Defined in Amazonka.SSM.UpdateOpsItem Methods readsPrec :: Int -> ReadS UpdateOpsItemResponse # readList :: ReadS [UpdateOpsItemResponse] # readPrec :: ReadPrec UpdateOpsItemResponse # readListPrec :: ReadPrec [UpdateOpsItemResponse] #
Show UpdateOpsItemResponse Source #
Instance details Defined in Amazonka.SSM.UpdateOpsItem Methods showsPrec :: Int -> UpdateOpsItemResponse -> ShowS # show :: UpdateOpsItemResponse -> String # showList :: [UpdateOpsItemResponse] -> ShowS #
NFData UpdateOpsItemResponse Source #
Instance details Defined in Amazonka.SSM.UpdateOpsItem Methods rnf :: UpdateOpsItemResponse -> () #
Eq UpdateOpsItemResponse Source #
Instance details Defined in Amazonka.SSM.UpdateOpsItem Methods (==) :: UpdateOpsItemResponse -> UpdateOpsItemResponse -> Bool # (/=) :: UpdateOpsItemResponse -> UpdateOpsItemResponse -> Bool #
type Rep UpdateOpsItemResponse Source #
Instance details Defined in Amazonka.SSM.UpdateOpsItem type Rep UpdateOpsItemResponse = D1 ('MetaData "UpdateOpsItemResponse" "Amazonka.SSM.UpdateOpsItem" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "UpdateOpsItemResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateOpsItemResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateOpsItemResponse'`
-> UpdateOpsItemResponse

Create a value of UpdateOpsItemResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateOpsItemResponse', updateOpsItemResponse_httpStatus - The response's http status code.

Response Lenses

updateOpsItemResponse_httpStatus :: Lens' UpdateOpsItemResponse Int Source #

The response's http status code.