Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SSM.CreateOpsItem

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new 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 Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.

Synopsis

data CreateOpsItem = CreateOpsItem' {
- actualEndTime :: Maybe POSIX
- priority :: Maybe Natural
- category :: Maybe Text
- severity :: Maybe Text
- opsItemType :: Maybe Text
- relatedOpsItems :: Maybe [RelatedOpsItem]
- operationalData :: Maybe (HashMap Text OpsItemDataValue)
- actualStartTime :: Maybe POSIX
- plannedEndTime :: Maybe POSIX
- notifications :: Maybe [OpsItemNotification]
- tags :: Maybe [Tag]
- plannedStartTime :: Maybe POSIX
- description :: Text
- source :: Text
- title :: Text
}
newCreateOpsItem :: Text -> Text -> Text -> CreateOpsItem
createOpsItem_actualEndTime :: Lens' CreateOpsItem (Maybe UTCTime)
createOpsItem_priority :: Lens' CreateOpsItem (Maybe Natural)
createOpsItem_category :: Lens' CreateOpsItem (Maybe Text)
createOpsItem_severity :: Lens' CreateOpsItem (Maybe Text)
createOpsItem_opsItemType :: Lens' CreateOpsItem (Maybe Text)
createOpsItem_relatedOpsItems :: Lens' CreateOpsItem (Maybe [RelatedOpsItem])
createOpsItem_operationalData :: Lens' CreateOpsItem (Maybe (HashMap Text OpsItemDataValue))
createOpsItem_actualStartTime :: Lens' CreateOpsItem (Maybe UTCTime)
createOpsItem_plannedEndTime :: Lens' CreateOpsItem (Maybe UTCTime)
createOpsItem_notifications :: Lens' CreateOpsItem (Maybe [OpsItemNotification])
createOpsItem_tags :: Lens' CreateOpsItem (Maybe [Tag])
createOpsItem_plannedStartTime :: Lens' CreateOpsItem (Maybe UTCTime)
createOpsItem_description :: Lens' CreateOpsItem Text
createOpsItem_source :: Lens' CreateOpsItem Text
createOpsItem_title :: Lens' CreateOpsItem Text
data CreateOpsItemResponse = CreateOpsItemResponse' {
- opsItemId :: Maybe Text
- httpStatus :: Int
}
newCreateOpsItemResponse :: Int -> CreateOpsItemResponse
createOpsItemResponse_opsItemId :: Lens' CreateOpsItemResponse (Maybe Text)
createOpsItemResponse_httpStatus :: Lens' CreateOpsItemResponse Int

Creating a Request

data CreateOpsItem Source #

See: newCreateOpsItem smart constructor.

Constructors

CreateOpsItem'

Fields

actualEndTime :: Maybe POSIX
The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.
priority :: Maybe Natural
The importance of this OpsItem in relation to other OpsItems in the system.
category :: Maybe Text
Specify a category to assign to an OpsItem.
severity :: Maybe Text
Specify a severity to assign to an OpsItem.
opsItemType :: Maybe Text
The type of OpsItem to create. Currently, the only valid values are /aws/changerequest and /aws/issue.
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.
operationalData :: Maybe (HashMap Text OpsItemDataValue)
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.
actualStartTime :: Maybe POSIX
The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.
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.
notifications :: Maybe [OpsItemNotification]
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
tags :: Maybe [Tag]
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 Amazon Web Services Systems Manager User Guide.
Tags use a key-value pair. For example:
```
Key=Department,Value=Finance
```
To add tags to a new OpsItem, a user must have IAM permissions for both the ssm:CreateOpsItems operation and the ssm:AddTagsToResource operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.
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.
description :: Text
Information about the OpsItem.
source :: Text
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.
title :: Text
A short heading that describes the nature of the OpsItem and the impacted resource.

Instances

Instances details

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

newCreateOpsItem Source #

Arguments

:: Text	`$sel:description:CreateOpsItem'`
-> Text	`$sel:source:CreateOpsItem'`
-> Text	`$sel:title:CreateOpsItem'`
-> CreateOpsItem

Create a value of CreateOpsItem 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:actualEndTime:CreateOpsItem', createOpsItem_actualEndTime - The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.

$sel:priority:CreateOpsItem', createOpsItem_priority - The importance of this OpsItem in relation to other OpsItems in the system.

$sel:category:CreateOpsItem', createOpsItem_category - Specify a category to assign to an OpsItem.

$sel:severity:CreateOpsItem', createOpsItem_severity - Specify a severity to assign to an OpsItem.

$sel:opsItemType:CreateOpsItem', createOpsItem_opsItemType - The type of OpsItem to create. Currently, the only valid values are /aws/changerequest and /aws/issue.

$sel:relatedOpsItems:CreateOpsItem', createOpsItem_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.

$sel:operationalData:CreateOpsItem', createOpsItem_operationalData - 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:actualStartTime:CreateOpsItem', createOpsItem_actualStartTime - The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.

$sel:plannedEndTime:CreateOpsItem', createOpsItem_plannedEndTime - The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.

$sel:notifications:CreateOpsItem', createOpsItem_notifications - The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.

$sel:tags:CreateOpsItem', createOpsItem_tags - 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 Amazon Web Services Systems Manager User Guide.

Tags use a key-value pair. For example:

Key=Department,Value=Finance

To add tags to a new OpsItem, a user must have IAM permissions for both the ssm:CreateOpsItems operation and the ssm:AddTagsToResource operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.

$sel:plannedStartTime:CreateOpsItem', createOpsItem_plannedStartTime - The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.

$sel:description:CreateOpsItem', createOpsItem_description - Information about the OpsItem.

$sel:source:CreateOpsItem', createOpsItem_source - 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.

$sel:title:CreateOpsItem', createOpsItem_title - A short heading that describes the nature of the OpsItem and the impacted resource.

Request Lenses

createOpsItem_actualEndTime :: Lens' CreateOpsItem (Maybe UTCTime) Source #

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

createOpsItem_priority :: Lens' CreateOpsItem (Maybe Natural) Source #

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

createOpsItem_category :: Lens' CreateOpsItem (Maybe Text) Source #

Specify a category to assign to an OpsItem.

createOpsItem_severity :: Lens' CreateOpsItem (Maybe Text) Source #

Specify a severity to assign to an OpsItem.

createOpsItem_opsItemType :: Lens' CreateOpsItem (Maybe Text) Source #

The type of OpsItem to create. Currently, the only valid values are /aws/changerequest and /aws/issue.

createOpsItem_relatedOpsItems :: Lens' CreateOpsItem (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.

createOpsItem_operationalData :: Lens' CreateOpsItem (Maybe (HashMap Text OpsItemDataValue)) Source #

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.

createOpsItem_actualStartTime :: Lens' CreateOpsItem (Maybe UTCTime) Source #

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

createOpsItem_plannedEndTime :: Lens' CreateOpsItem (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.

createOpsItem_notifications :: Lens' CreateOpsItem (Maybe [OpsItemNotification]) Source #

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

createOpsItem_tags :: Lens' CreateOpsItem (Maybe [Tag]) Source #

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

Tags use a key-value pair. For example:

Key=Department,Value=Finance

To add tags to a new OpsItem, a user must have IAM permissions for both the ssm:CreateOpsItems operation and the ssm:AddTagsToResource operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.

createOpsItem_plannedStartTime :: Lens' CreateOpsItem (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.

createOpsItem_description :: Lens' CreateOpsItem Text Source #

Information about the OpsItem.

createOpsItem_source :: Lens' CreateOpsItem Text Source #

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.

createOpsItem_title :: Lens' CreateOpsItem Text Source #

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

Destructuring the Response

data CreateOpsItemResponse Source #

See: newCreateOpsItemResponse smart constructor.

Constructors

CreateOpsItemResponse'
Fields opsItemId :: Maybe Text The ID of the OpsItem. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateOpsItemResponse Source #

Arguments

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

Create a value of CreateOpsItemResponse 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:opsItemId:CreateOpsItemResponse', createOpsItemResponse_opsItemId - The ID of the OpsItem.

$sel:httpStatus:CreateOpsItemResponse', createOpsItemResponse_httpStatus - The response's http status code.

Response Lenses

createOpsItemResponse_opsItemId :: Lens' CreateOpsItemResponse (Maybe Text) Source #

The ID of the OpsItem.

createOpsItemResponse_httpStatus :: Lens' CreateOpsItemResponse Int Source #

The response's http status code.