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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

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

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-OpsCenter-multiple-accounts.html

Returns:

  • (String)


3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
# File 'lib/aws-sdk-ssm/types.rb', line 3663

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_timeTime

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

Returns:

  • (Time)


3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
# File 'lib/aws-sdk-ssm/types.rb', line 3663

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_timeTime

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

Returns:

  • (Time)


3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
# File 'lib/aws-sdk-ssm/types.rb', line 3663

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

#categoryString

Specify a category to assign to an OpsItem.

Returns:

  • (String)


3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
# File 'lib/aws-sdk-ssm/types.rb', line 3663

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

#descriptionString

Information about the OpsItem.

Returns:

  • (String)


3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
# File 'lib/aws-sdk-ssm/types.rb', line 3663

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

#notificationsArray<Types::OpsItemNotification>

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

Returns:



3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
# File 'lib/aws-sdk-ssm/types.rb', line 3663

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_dataHash<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 [Creating OpsItems manually] in the *Amazon Web Services Systems Manager User Guide*.

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

Returns:



3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
# File 'lib/aws-sdk-ssm/types.rb', line 3663

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_typeString

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.

Returns:

  • (String)


3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
# File 'lib/aws-sdk-ssm/types.rb', line 3663

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_timeTime

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

Returns:

  • (Time)


3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
# File 'lib/aws-sdk-ssm/types.rb', line 3663

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_timeTime

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

Returns:

  • (Time)


3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
# File 'lib/aws-sdk-ssm/types.rb', line 3663

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

#priorityInteger

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

Returns:

  • (Integer)


3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
# File 'lib/aws-sdk-ssm/types.rb', line 3663

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

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:



3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
# File 'lib/aws-sdk-ssm/types.rb', line 3663

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

#severityString

Specify a severity to assign to an OpsItem.

Returns:

  • (String)


3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
# File 'lib/aws-sdk-ssm/types.rb', line 3663

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

#sourceString

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

<note markdown=“1”> The source name can’t contain the following strings: ‘aws`, `amazon`, and `amzn`.

</note>

Returns:

  • (String)


3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
# File 'lib/aws-sdk-ssm/types.rb', line 3663

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

#tagsArray<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 *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.

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

Returns:



3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
# File 'lib/aws-sdk-ssm/types.rb', line 3663

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

#titleString

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

Returns:

  • (String)


3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
# File 'lib/aws-sdk-ssm/types.rb', line 3663

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