Struct aws_sdk_ssm::operation::create_ops_item::CreateOpsItemInput

#[non_exhaustive]
pub struct CreateOpsItemInput {

    pub description: Option<String>,
    pub ops_item_type: Option<String>,
    pub operational_data: Option<HashMap<String, OpsItemDataValue>>,
    pub notifications: Option<Vec<OpsItemNotification>>,
    pub priority: Option<i32>,
    pub related_ops_items: Option<Vec<RelatedOpsItem>>,
    pub source: Option<String>,
    pub title: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub category: Option<String>,
    pub severity: Option<String>,
    pub actual_start_time: Option<DateTime>,
    pub actual_end_time: Option<DateTime>,
    pub planned_start_time: Option<DateTime>,
    pub planned_end_time: Option<DateTime>,
    pub account_id: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

description: Option<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.

ops_item_type: Option<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.

operational_data: Option<HashMap<String, 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.

notifications: Option<Vec<OpsItemNotification>>

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

priority: Option<i32>

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

related_ops_items: Option<Vec<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.

source: Option<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.

title: Option<String>

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

tags: Option<Vec<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.

category: Option<String>

Specify a category to assign to an OpsItem.

severity: Option<String>

Specify a severity to assign to an OpsItem.

actual_start_time: Option<DateTime>

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

actual_end_time: Option<DateTime>

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

planned_start_time: Option<DateTime>

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

planned_end_time: Option<DateTime>

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

account_id: Option<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.

Implementations

impl CreateOpsItemInput

pub fn description(&self) -> Option<&str>

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.

pub fn ops_item_type(&self) -> Option<&str>

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.

pub fn operational_data(&self) -> Option<&HashMap<String, 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.

pub fn notifications(&self) -> &[OpsItemNotification]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .notifications.is_none().

pub fn priority(&self) -> Option<i32>

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

pub fn related_ops_items(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .related_ops_items.is_none().

pub fn source(&self) -> Option<&str>

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.

pub fn title(&self) -> Option<&str>

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

pub fn tags(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn category(&self) -> Option<&str>

Specify a category to assign to an OpsItem.

pub fn severity(&self) -> Option<&str>

Specify a severity to assign to an OpsItem.

pub fn actual_start_time(&self) -> Option<&DateTime>

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

pub fn actual_end_time(&self) -> Option<&DateTime>

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

pub fn planned_start_time(&self) -> Option<&DateTime>

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

pub fn planned_end_time(&self) -> Option<&DateTime>

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

pub fn account_id(&self) -> Option<&str>

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.

impl CreateOpsItemInput

pub fn builder() -> CreateOpsItemInputBuilder

Creates a new builder-style object to manufacture CreateOpsItemInput.

Trait Implementations

impl Clone for CreateOpsItemInput

fn clone(&self) -> CreateOpsItemInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateOpsItemInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateOpsItemInput

fn eq(&self, other: &CreateOpsItemInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateOpsItemInput