Class: Aws::SSM::Types::CreateOpsItemRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass CreateOpsItemRequest data as a hash:

{
  description: "OpsItemDescription", # required
  operational_data: {
    "OpsItemDataKey" => {
      value: "OpsItemDataValueString",
      type: "SearchableString", # accepts SearchableString, String
    },
  },
  notifications: [
    {
      arn: "String",
    },
  ],
  priority: 1,
  related_ops_items: [
    {
      ops_item_id: "String", # required
    },
  ],
  source: "OpsItemSource", # required
  title: "OpsItemTitle", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  category: "OpsItemCategory",
  severity: "OpsItemSeverity",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#category ⇒ String

Specify a category to assign to an OpsItem.

Returns:

  • (String) 


3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
 
# File 'lib/aws-sdk-ssm/types.rb', line 3011

class CreateOpsItemRequest < Struct.new(
  :description,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity)
  include Aws::Structure
end

#description ⇒ String

Information about the OpsItem.

Returns:

  • (String) 


3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
 
# File 'lib/aws-sdk-ssm/types.rb', line 3011

class CreateOpsItemRequest < Struct.new(
  :description,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity)
  include Aws::Structure
end

#notifications ⇒ Array<Types::OpsItemNotification>

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

Returns:



3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
 
# File 'lib/aws-sdk-ssm/types.rb', line 3011

class CreateOpsItemRequest < Struct.new(
  :description,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity)
  include Aws::Structure
end

#operational_data ⇒ Hash<String,Types::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 action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action).

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 AWS CLI example commands that use these keys, see [Creating OpsItems Manually] in the *AWS Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems

Returns:



3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
 
# File 'lib/aws-sdk-ssm/types.rb', line 3011

class CreateOpsItemRequest < Struct.new(
  :description,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity)
  include Aws::Structure
end

#priority ⇒ Integer

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

Returns:

  • (Integer) 


3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
 
# File 'lib/aws-sdk-ssm/types.rb', line 3011

class CreateOpsItemRequest < Struct.new(
  :description,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity)
  include Aws::Structure
end

#related_ops_items ⇒ Array<Types::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.

Returns:



3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
 
# File 'lib/aws-sdk-ssm/types.rb', line 3011

class CreateOpsItemRequest < Struct.new(
  :description,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity)
  include Aws::Structure
end

#severity ⇒ String

Specify a severity to assign to an OpsItem.

Returns:

  • (String) 


3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
 
# File 'lib/aws-sdk-ssm/types.rb', line 3011

class CreateOpsItemRequest < Struct.new(
  :description,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity)
  include Aws::Structure
end

#source ⇒ String

The origin of the OpsItem, such as Amazon EC2 or AWS Systems Manager.

Returns:

  • (String) 


3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
 
# File 'lib/aws-sdk-ssm/types.rb', line 3011

class CreateOpsItemRequest < Struct.new(
  :description,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity)
  include Aws::Structure
end

#tags ⇒ Array<Types::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 *AWS Systems Manager User Guide*.

Tags use a key-value pair. For example:

‘Key=Department,Value=Finance`

<note markdown=“1”> To add tags to an existing OpsItem, use the AddTagsToResource action.

</note>

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html#OpsCenter-getting-started-user-permissions

Returns:



3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
 
# File 'lib/aws-sdk-ssm/types.rb', line 3011

class CreateOpsItemRequest < Struct.new(
  :description,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity)
  include Aws::Structure
end

#title ⇒ String

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

Returns:

  • (String) 


3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
 
# File 'lib/aws-sdk-ssm/types.rb', line 3011

class CreateOpsItemRequest < Struct.new(
  :description,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity)
  include Aws::Structure
end