Struct aws_sdk_ssm::operation::create_ops_item::builders::CreateOpsItemInputBuilder

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

A builder for CreateOpsItemInput.

Implementations

impl CreateOpsItemInputBuilder

pub fn description(self, input: impl Into<String>) -> Self

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.

This field is required.

pub fn set_description(self, input: Option<String>) -> Self

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 get_description(&self) -> &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.

pub fn ops_item_type(self, input: impl Into<String>) -> Self

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 set_ops_item_type(self, input: Option<String>) -> Self

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 get_ops_item_type(&self) -> &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.

pub fn operational_data(self, k: impl Into<String>, v: OpsItemDataValue) -> Self

Adds a key-value pair to operational_data.

To override the contents of this collection use set_operational_data.

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 set_operational_data( self, input: Option<HashMap<String, OpsItemDataValue>> ) -> Self

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 get_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, input: OpsItemNotification) -> Self

Appends an item to notifications.

To override the contents of this collection use set_notifications.

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

pub fn set_notifications(self, input: Option<Vec<OpsItemNotification>>) -> Self

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

pub fn get_notifications(&self) -> &Option<Vec<OpsItemNotification>>

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

pub fn priority(self, input: i32) -> Self

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

pub fn set_priority(self, input: Option<i32>) -> Self

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

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

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

pub fn related_ops_items(self, input: RelatedOpsItem) -> Self

Appends an item to related_ops_items.

To override the contents of this collection use set_related_ops_items.

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.

pub fn set_related_ops_items(self, input: Option<Vec<RelatedOpsItem>>) -> Self

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.

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

pub fn source(self, input: impl Into<String>) -> Self

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.

This field is required.

pub fn set_source(self, input: Option<String>) -> Self

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 get_source(&self) -> &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.

pub fn title(self, input: impl Into<String>) -> Self

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

This field is required.

pub fn set_title(self, input: Option<String>) -> Self

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

pub fn get_title(&self) -> &Option<String>

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

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

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.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

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.

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

pub fn category(self, input: impl Into<String>) -> Self

Specify a category to assign to an OpsItem.

pub fn set_category(self, input: Option<String>) -> Self

Specify a category to assign to an OpsItem.

pub fn get_category(&self) -> &Option<String>

Specify a category to assign to an OpsItem.

pub fn severity(self, input: impl Into<String>) -> Self

Specify a severity to assign to an OpsItem.

pub fn set_severity(self, input: Option<String>) -> Self

Specify a severity to assign to an OpsItem.

pub fn get_severity(&self) -> &Option<String>

Specify a severity to assign to an OpsItem.

pub fn actual_start_time(self, input: DateTime) -> Self

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

pub fn set_actual_start_time(self, input: Option<DateTime>) -> Self

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

pub fn get_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, input: DateTime) -> Self

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

pub fn set_actual_end_time(self, input: Option<DateTime>) -> Self

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

pub fn get_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, input: DateTime) -> Self

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

pub fn set_planned_start_time(self, input: Option<DateTime>) -> Self

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

pub fn get_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, input: DateTime) -> Self

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

pub fn set_planned_end_time(self, input: Option<DateTime>) -> Self

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

pub fn get_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, input: impl Into<String>) -> Self

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.

pub fn set_account_id(self, input: Option<String>) -> Self

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.

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

pub fn build(self) -> Result<CreateOpsItemInput, BuildError>

Consumes the builder and constructs a CreateOpsItemInput.

impl CreateOpsItemInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<CreateOpsItemOutput, SdkError<CreateOpsItemError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for CreateOpsItemInputBuilder

fn clone(&self) -> CreateOpsItemInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateOpsItemInputBuilder

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

Formats the value using the given formatter.

impl Default for CreateOpsItemInputBuilder

fn default() -> CreateOpsItemInputBuilder

Returns the “default value” for a type.

impl PartialEq for CreateOpsItemInputBuilder

fn eq(&self, other: &CreateOpsItemInputBuilder) -> 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 CreateOpsItemInputBuilder