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

Inherits:

Struct

Object
Struct
Aws::SSM::Types::CreateOpsItemRequest

show all

Defined in:: gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#account_id ⇒ String
The target Amazon Web Services account where you want to create an OpsItem.
#actual_end_time ⇒ Time
The time a runbook workflow ended.
#actual_start_time ⇒ Time
The time a runbook workflow started.
#category ⇒ String
Specify a category to assign to an OpsItem.
#description ⇒ String
User-defined text that contains information about the OpsItem, in Markdown format.
#notifications ⇒ Array<Types::OpsItemNotification>
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
#operational_data ⇒ Hash<String,Types::OpsItemDataValue>
Operational data is custom data that provides useful reference details about the OpsItem.
#ops_item_type ⇒ String
The type of OpsItem to create.
#planned_end_time ⇒ Time
The time specified in a change request for a runbook workflow to end.
#planned_start_time ⇒ Time
The time specified in a change request for a runbook workflow to start.
#priority ⇒ Integer
The importance of this OpsItem in relation to other OpsItems in the system.
#related_ops_items ⇒ Array<Types::RelatedOpsItem>
One or more OpsItems that share something in common with the current OpsItems.
#severity ⇒ String
Specify a severity to assign to an OpsItem.
#source ⇒ String
The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
#tags ⇒ Array<Types::Tag>
Optional metadata that you assign to a resource.
#title ⇒ String
A short heading that describes the nature of the OpsItem and the impacted resource.

Instance Attribute Details

#account_id ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3854

class CreateOpsItemRequest < Struct.new(
  :description,
  :ops_item_type,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :account_id)
  SENSITIVE = []
  include Aws::Structure
end

#actual_end_time ⇒ `Time`

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

Returns:

(Time)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3854

class CreateOpsItemRequest < Struct.new(
  :description,
  :ops_item_type,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :account_id)
  SENSITIVE = []
  include Aws::Structure
end

#actual_start_time ⇒ `Time`

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

Returns:

(Time)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3854

class CreateOpsItemRequest < Struct.new(
  :description,
  :ops_item_type,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :account_id)
  SENSITIVE = []
  include Aws::Structure
end

#category ⇒ `String`

Specify a category to assign to an OpsItem.

Returns:

(String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3854

class CreateOpsItemRequest < Struct.new(
  :description,
  :ops_item_type,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :account_id)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

User-defined text that contains information about the OpsItem, in Markdown format.

Provide enough information so that users viewing this OpsItem for the first time understand the issue.

Returns:

(String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3854

class CreateOpsItemRequest < Struct.new(
  :description,
  :ops_item_type,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :account_id)
  SENSITIVE = []
  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:

(Array<Types::OpsItemNotification>)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3854

class CreateOpsItemRequest < Struct.new(
  :description,
  :ops_item_type,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :account_id)
  SENSITIVE = []
  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 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 Create OpsItems manually in the Amazon Web Services Systems Manager User Guide.

Returns:

(Hash<String,Types::OpsItemDataValue>)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3854

class CreateOpsItemRequest < Struct.new(
  :description,
  :ops_item_type,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :account_id)
  SENSITIVE = []
  include Aws::Structure
end

#ops_item_type ⇒ `String`

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/insight

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

Returns:

(String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3854

class CreateOpsItemRequest < Struct.new(
  :description,
  :ops_item_type,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :account_id)
  SENSITIVE = []
  include Aws::Structure
end

#planned_end_time ⇒ `Time`

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

Returns:

(Time)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3854

class CreateOpsItemRequest < Struct.new(
  :description,
  :ops_item_type,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :account_id)
  SENSITIVE = []
  include Aws::Structure
end

#planned_start_time ⇒ `Time`

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

Returns:

(Time)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3854

class CreateOpsItemRequest < Struct.new(
  :description,
  :ops_item_type,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :account_id)
  SENSITIVE = []
  include Aws::Structure
end

#priority ⇒ `Integer`

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

Returns:

(Integer)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3854

class CreateOpsItemRequest < Struct.new(
  :description,
  :ops_item_type,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :account_id)
  SENSITIVE = []
  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:

(Array<Types::RelatedOpsItem>)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3854

class CreateOpsItemRequest < Struct.new(
  :description,
  :ops_item_type,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :account_id)
  SENSITIVE = []
  include Aws::Structure
end

#severity ⇒ `String`

Specify a severity to assign to an OpsItem.

Returns:

(String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3854

class CreateOpsItemRequest < Struct.new(
  :description,
  :ops_item_type,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :account_id)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3854

class CreateOpsItemRequest < Struct.new(
  :description,
  :ops_item_type,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :account_id)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

Optional metadata that you assign to a resource.

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.

Returns:

(Array<Types::Tag>)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3854

class CreateOpsItemRequest < Struct.new(
  :description,
  :ops_item_type,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :account_id)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3854

class CreateOpsItemRequest < Struct.new(
  :description,
  :ops_item_type,
  :operational_data,
  :notifications,
  :priority,
  :related_ops_items,
  :source,
  :title,
  :tags,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :account_id)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#account_id ⇒ String

#actual_end_time ⇒ Time

#actual_start_time ⇒ Time

#category ⇒ String

#description ⇒ String

#notifications ⇒ Array<Types::OpsItemNotification>

#operational_data ⇒ Hash<String,Types::OpsItemDataValue>

#ops_item_type ⇒ String

#planned_end_time ⇒ Time

#planned_start_time ⇒ Time

#priority ⇒ Integer

#related_ops_items ⇒ Array<Types::RelatedOpsItem>

#severity ⇒ String

#source ⇒ String

#tags ⇒ Array<Types::Tag>

#title ⇒ String

#account_id ⇒ `String`

#actual_end_time ⇒ `Time`

#actual_start_time ⇒ `Time`

#category ⇒ `String`

#description ⇒ `String`

#notifications ⇒ `Array<Types::OpsItemNotification>`

#operational_data ⇒ `Hash<String,Types::OpsItemDataValue>`

#ops_item_type ⇒ `String`

#planned_end_time ⇒ `Time`

#planned_start_time ⇒ `Time`

#priority ⇒ `Integer`

#related_ops_items ⇒ `Array<Types::RelatedOpsItem>`

#severity ⇒ `String`

#source ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#title ⇒ `String`