Struct aws_sdk_ssm::input::CreateOpsItemInput

source · [−]

#[non_exhaustive]
pub struct CreateOpsItemInput { /* private fields */ }

Implementations

source

impl CreateOpsItemInput

source

pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateOpsItem, AwsResponseRetryClassifier>, BuildError>

Consumes the builder and constructs an Operation<CreateOpsItem>

source

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateOpsItemInput.

source

impl CreateOpsItemInput

source

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

Information about the OpsItem.

source

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

The type of OpsItem to create. Currently, the only valid values are /aws/changerequest and /aws/issue.

source

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

source

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

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

source

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

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

source

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

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.

source

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

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

source

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

source