amazonka-ssm-2.0: Amazon Simple Systems Manager (SSM) SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SSM.CreateOpsItem

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

Creating a Request

data CreateOpsItem Source #

See: newCreateOpsItem smart constructor.

Constructors

CreateOpsItem' 

Fields

  • accountId :: Maybe Text

    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 Setting up OpsCenter to work with OpsItems across accounts in the Amazon Web Services Systems Manager User Guide.

  • 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 category to assign to an OpsItem.

  • 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)

    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.

  • opsItemType :: Maybe Text

    The type of OpsItem to create. Systems Manager supports the following types of OpsItems:

    • /aws/issue

      This type of OpsItem is used for default OpsItems created by OpsCenter.

    • /aws/changerequest

      This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.

    • /aws/insights

      This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.

  • 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 severity to assign to an OpsItem.

  • 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.

  • 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
ToJSON CreateOpsItem Source # 
Instance details

Defined in Amazonka.SSM.CreateOpsItem

ToHeaders CreateOpsItem Source # 
Instance details

Defined in Amazonka.SSM.CreateOpsItem

ToPath CreateOpsItem Source # 
Instance details

Defined in Amazonka.SSM.CreateOpsItem

ToQuery CreateOpsItem Source # 
Instance details

Defined in Amazonka.SSM.CreateOpsItem

AWSRequest CreateOpsItem Source # 
Instance details

Defined in Amazonka.SSM.CreateOpsItem

Associated Types

type AWSResponse CreateOpsItem #

Generic CreateOpsItem Source # 
Instance details

Defined in Amazonka.SSM.CreateOpsItem

Associated Types

type Rep CreateOpsItem :: Type -> Type #

Read CreateOpsItem Source # 
Instance details

Defined in Amazonka.SSM.CreateOpsItem

Show CreateOpsItem Source # 
Instance details

Defined in Amazonka.SSM.CreateOpsItem

NFData CreateOpsItem Source # 
Instance details

Defined in Amazonka.SSM.CreateOpsItem

Methods

rnf :: CreateOpsItem -> () #

Eq CreateOpsItem Source # 
Instance details

Defined in Amazonka.SSM.CreateOpsItem

Hashable CreateOpsItem Source # 
Instance details

Defined in Amazonka.SSM.CreateOpsItem

type AWSResponse CreateOpsItem Source # 
Instance details

Defined in Amazonka.SSM.CreateOpsItem

type Rep CreateOpsItem Source # 
Instance details

Defined in Amazonka.SSM.CreateOpsItem

type Rep CreateOpsItem = D1 ('MetaData "CreateOpsItem" "Amazonka.SSM.CreateOpsItem" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "CreateOpsItem'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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 "notifications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OpsItemNotification])) :*: S1 ('MetaSel ('Just "operationalData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text OpsItemDataValue)))) :*: (S1 ('MetaSel ('Just "opsItemType") '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 "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: 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))))))

newCreateOpsItem Source #

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:

CreateOpsItem, createOpsItem_accountId - 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 Setting up OpsCenter to work with OpsItems across accounts in the Amazon Web Services Systems Manager User Guide.

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

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

CreateOpsItem, createOpsItem_category - Specify a category to assign to an OpsItem.

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

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.

CreateOpsItem, createOpsItem_opsItemType - The type of OpsItem to create. Systems Manager supports the following types of OpsItems:

  • /aws/issue

    This type of OpsItem is used for default OpsItems created by OpsCenter.

  • /aws/changerequest

    This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.

  • /aws/insights

    This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.

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.

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.

CreateOpsItem, createOpsItem_priority - The importance of this OpsItem in relation to other OpsItems in the system.

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.

CreateOpsItem, createOpsItem_severity - Specify a severity to assign to an OpsItem.

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.

CreateOpsItem, createOpsItem_description - Information about the OpsItem.

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.

CreateOpsItem, createOpsItem_title - A short heading that describes the nature of the OpsItem and the impacted resource.

Request Lenses

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

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 Setting up OpsCenter to work with OpsItems across accounts in the Amazon Web Services Systems Manager User Guide.

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

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

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

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

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

Specify a category to assign to an OpsItem.

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_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_opsItemType :: Lens' CreateOpsItem (Maybe Text) Source #

The type of OpsItem to create. Systems Manager supports the following types of OpsItems:

  • /aws/issue

    This type of OpsItem is used for default OpsItems created by OpsCenter.

  • /aws/changerequest

    This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.

  • /aws/insights

    This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.

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_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_priority :: Lens' CreateOpsItem (Maybe Natural) Source #

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

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_severity :: Lens' CreateOpsItem (Maybe Text) Source #

Specify a severity to assign to an OpsItem.

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_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

Instances

Instances details
Generic CreateOpsItemResponse Source # 
Instance details

Defined in Amazonka.SSM.CreateOpsItem

Associated Types

type Rep CreateOpsItemResponse :: Type -> Type #

Read CreateOpsItemResponse Source # 
Instance details

Defined in Amazonka.SSM.CreateOpsItem

Show CreateOpsItemResponse Source # 
Instance details

Defined in Amazonka.SSM.CreateOpsItem

NFData CreateOpsItemResponse Source # 
Instance details

Defined in Amazonka.SSM.CreateOpsItem

Methods

rnf :: CreateOpsItemResponse -> () #

Eq CreateOpsItemResponse Source # 
Instance details

Defined in Amazonka.SSM.CreateOpsItem

type Rep CreateOpsItemResponse Source # 
Instance details

Defined in Amazonka.SSM.CreateOpsItem

type Rep CreateOpsItemResponse = D1 ('MetaData "CreateOpsItemResponse" "Amazonka.SSM.CreateOpsItem" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "CreateOpsItemResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "opsItemArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "opsItemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateOpsItemResponse Source #

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:

CreateOpsItemResponse, createOpsItemResponse_opsItemArn - The OpsItem Amazon Resource Name (ARN).

CreateOpsItemResponse, createOpsItemResponse_opsItemId - The ID of the OpsItem.

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

Response Lenses

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

The OpsItem Amazon Resource Name (ARN).